Docs for Developers (eBook)
225 Seiten
Apress (Verlag)
978-1-4842-7217-6 (ISBN)
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation.
Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects.
Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization.
What You'll Learn
- Create friction logs and perform user research to understand your users’ frustrations
- Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes
- Publish and maintain documentation alongside regular code releases
- Measure the success of the content you create through analytics and user feedback
- Organize larger sets of documentation to help users find the right information at the right time
Who This Book Is For
Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation-tools you can adapt to the needs of your own organization.What You'll Learn Create friction logs and perform user research to understand your users frustrationsResearch, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notesPublish and maintain documentation alongside regular code releasesMeasure the success of the content you create through analytics and user feedbackOrganize larger sets of documentation to help users find the right information at the right time Who This Book Is For Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
| Erscheint lt. Verlag | 30.9.2021 |
|---|---|
| Zusatzinfo | XXV, 225 p. 31 illus. |
| Sprache | englisch |
| Themenwelt | Geisteswissenschaften ► Sprach- / Literaturwissenschaft ► Literaturwissenschaft |
| Geisteswissenschaften ► Sprach- / Literaturwissenschaft ► Sprachwissenschaft | |
| Mathematik / Informatik ► Informatik ► Programmiersprachen / -werkzeuge | |
| Mathematik / Informatik ► Informatik ► Web / Internet | |
| Schlagworte | code contributions • Code of conduct • content licenses • design docs • Developer documentation • documentation metrics • document contributors • Findability • friction logs • Open Source • open source contributions • open source documentation • searchability • software documentation • style guides • technical documentation • technical writing |
| ISBN-10 | 1-4842-7217-X / 148427217X |
| ISBN-13 | 978-1-4842-7217-6 / 9781484272176 |
| Informationen gemäß Produktsicherheitsverordnung (GPSR) | |
| Haben Sie eine Frage zum Produkt? |
PDF (Wasserzeichen)Größe: 4,7 MB
DRM: Digitales Wasserzeichen
Dieses eBook enthält ein digitales Wasserzeichen und ist damit für Sie personalisiert. Bei einer missbräuchlichen Weitergabe des eBooks an Dritte ist eine Rückverfolgung an die Quelle möglich.
Dateiformat: PDF (Portable Document Format)
Mit einem festen Seitenlayout eignet sich die PDF besonders für Fachbücher mit Spalten, Tabellen und Abbildungen. Eine PDF kann auf fast allen Geräten angezeigt werden, ist aber für kleine Displays (Smartphone, eReader) nur eingeschränkt geeignet.
Systemvoraussetzungen:
PC/Mac: Mit einem PC oder Mac können Sie dieses eBook lesen. Sie benötigen dafür einen PDF-Viewer - z.B. den Adobe Reader oder Adobe Digital Editions.
eReader: Dieses eBook kann mit (fast) allen eBook-Readern gelesen werden. Mit dem amazon-Kindle ist es aber nicht kompatibel.
Smartphone/Tablet: Egal ob Apple oder Android, dieses eBook können Sie lesen. Sie benötigen dafür einen PDF-Viewer - z.B. die kostenlose Adobe Digital Editions-App.
Buying eBooks from abroad
For tax law reasons we can sell eBooks just within Germany and Switzerland. Regrettably we cannot fulfill eBook-orders from other countries.
aus dem Bereich
