Crafting docs for success an end-to-end approach to developer documentation

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 aim...

Full description

Bibliographic Details
Main Author: Lakatos, Diana
Format: eBook
Language:English
Published: [United States] Apress 2023
Series:Design Thinking Series
Subjects:
Online Access:
Collection: O'Reilly - Collection details see MPG.ReNa
LEADER 03300nmm a2200397 u 4500
001 EB002189724
003 EBX01000000000000001327189
005 00000000000000.0
007 cr|||||||||||||||||||||
008 240103 ||| eng
020 |a 9781484295946 
050 4 |a QA76.6 
100 1 |a Lakatos, Diana 
245 0 0 |a Crafting docs for success  |b an end-to-end approach to developer documentation  |c Diana Lakatos 
260 |a [United States]  |b Apress  |c 2023 
300 |a 140 pages  |b illustrations (black and white, and color) 
505 0 |a 1: Approaches -- 2: Foundations -- 3: Editorial Workflow -- 4: Content Production -- 5: Implementation -- 6: Community -- 7: Accessibility -- 8: Sustainability -- 9: Team -- 10. Measures of Success 
653 |a Logiciels d'application / Développement / Miscellanées 
653 |a Application software / Development / fast 
653 |a Application software / Development / Miscellanea 
653 |a technical writing / aat 
653 |a Technical writing / fast 
653 |a Technical writing / http://id.loc.gov/authorities/subjects/sh85133137 
653 |a Rédaction technique 
041 0 7 |a eng  |2 ISO 639-2 
989 |b OREILLY  |a O'Reilly 
490 0 |a Design Thinking Series 
500 |a Includes index 
028 5 0 |a 10.1007/978-1-4842-9594-6 
776 |z 1484295935 
776 |z 9781484295939 
776 |z 9781484295946 
776 |z 1484295943 
856 4 0 |u https://learning.oreilly.com/library/view/~/9781484295946/?ar  |x Verlag  |3 Volltext 
082 0 |a 006.76 
520 |a 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 its 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. You will: 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