Crafting Docs for Success (eBook)
XVII, 211 Seiten
Apress (Verlag)
978-1-4842-9594-6 (ISBN)
Developer documentation is a powerful tool in developer relations because it provides all the necessary information during the onboarding process and keeps your users informed on changes such as release notes, status reports and new and updated topics. Using a design thinking approach, this book aims to provide an easy to follow blueprint for building successful developer documentation by using the award winning platformOS developer portal as inspiration.
You'll work with practical usable templates, workflows, and tools validated and peer-reviewed by international experts in the fields of documentation, technical writing, developer relations, and UX design. This book reveals the many factors that must be considered while crafting developer documentation, such as hitting the right target audience, designing a seamless onboarding experience, and selecting the right workflows and data analysis methods. You'll delve into this complex mix of topics, each with its unique considerations, and understand why it's difficult for those working on developer documentation to understand the process, as well as all the necessary ingredients, tools, and resources to overcome that challenge.
Crafting Docs for Success is your one-stop resource for empowering your team and community to contribute and help maintain your documentation, as well as further improve diversity and inclusion.
Examine how user research facilitates documentation development
Utilize design thinking, community-driven documentation, and Docs as Code
Understand editorial workflows and what happens at each step
Write a style guide from scratch and use it for content production
Review how methods and strategies fall into place during technical implementation
Software developers and designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs
Diana Lakatos is an experienced Technical Writer specialized in developer documentation. She developed the documentation processes for the multiple award-winning platformOS Developer Portal and manages all phases of the editorial workflow, creates templates, incorporates best practices, and writes, edits, and reviews content. She spoke about various aspects of building world-class developer docs at conferences like Write The Docs, tcworld, DevRelCon, and API The Docs.
Developer documentation is a powerful tool in developer relations because it provides all the necessary information during the onboarding process and keeps your users informed on changes such as release notes, status reports and new and updated topics. Using a design thinking approach, this book aims to provide an easy to follow blueprint for building successful developer documentation by using the award winning platformOS developer portal as inspiration.You'll work with practical usable templates, workflows, and tools validated and peer-reviewed by international experts in the fields of documentation, technical writing, developer relations, and UX design. This book reveals the many factors that must be considered while crafting developer documentation, such as hitting the right target audience, designing a seamless onboarding experience, and selecting the right workflows and data analysis methods. You'll delve into this complex mix of topics, each with its unique considerations, and understand why it's difficult for those working on developer documentation to understand the process, as well as all the necessary ingredients, tools, and resources to overcome that challenge. Crafting Docs for Success is your one-stop resource for empowering your team and community to contribute and help maintain your documentation, as well as further improve diversity and inclusion. What You'll LearnExamine how user research facilitates documentation developmentUtilize design thinking, community-driven documentation, and Docs as Code Understand editorial workflows and what happens at each stepWrite a style guide from scratch and use it for content productionReview how methods and strategies fall into place during technical implementationWho This Book Is ForSoftware developers and designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs
| Erscheint lt. Verlag | 28.9.2023 |
|---|---|
| Reihe/Serie | Design Thinking | Design Thinking |
| Zusatzinfo | XVII, 211 p. 40 illus., 39 illus. in color. |
| Sprache | englisch |
| Themenwelt | Mathematik / Informatik ► Informatik ► Programmiersprachen / -werkzeuge |
| Mathematik / Informatik ► Informatik ► Web / Internet | |
| Schlagworte | community driven documentation • content first • contributor experience • design thinking • Developer documentation • docs as code • User Research |
| ISBN-10 | 1-4842-9594-3 / 1484295943 |
| ISBN-13 | 978-1-4842-9594-6 / 9781484295946 |
| Haben Sie eine Frage zum Produkt? |
PDF (Ohne DRM)Digital Rights Management: ohne DRM
Dieses eBook enthält kein DRM oder Kopierschutz. Eine Weitergabe an Dritte ist jedoch rechtlich nicht zulässig, weil Sie beim Kauf nur die Rechte an der persönlichen Nutzung erwerben.
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
