Zum Hauptinhalt springen
Dekorationsartikel gehören nicht zum Leistungsumfang.
Crafting Docs for Success
An End-to-End Approach to Developer Documentation
Taschenbuch von Diana Lakatos
Sprache: Englisch

48,14 €*

inkl. MwSt.

Versandkostenfrei per Post / DHL

Aktuell nicht verfügbar

Kategorien:
Beschreibung
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 Learn

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

Who This Book Is For

Software developersand designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs
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 Learn

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

Who This Book Is For

Software developersand designers, documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, and start-up founders, CTOs, and CEOs
Über den Autor

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.

Inhaltsverzeichnis

1: Approaches.- 2: Foundations.- 3: Editorial Workflow.- 4: Content Production.- 5: Implementation.- 6: Community.- 7: Accessibility.- 8: Sustainability.- 9: Team.- 10. Measures of Success

Details
Erscheinungsjahr: 2023
Genre: Informatik
Rubrik: Naturwissenschaften & Technik
Medium: Taschenbuch
Reihe: Design Thinking
Inhalt: xvii
211 S.
1 s/w Illustr.
39 farbige Illustr.
211 p. 40 illus.
39 illus. in color.
ISBN-13: 9781484295939
ISBN-10: 1484295935
Sprache: Englisch
Ausstattung / Beilage: Paperback
Einband: Kartoniert / Broschiert
Autor: Lakatos, Diana
Auflage: 1st ed.
Hersteller: Apress
Apress L.P.
Design Thinking
Maße: 235 x 155 x 13 mm
Von/Mit: Diana Lakatos
Erscheinungsdatum: 29.09.2023
Gewicht: 0,359 kg
Artikel-ID: 126937594
Über den Autor

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.

Inhaltsverzeichnis

1: Approaches.- 2: Foundations.- 3: Editorial Workflow.- 4: Content Production.- 5: Implementation.- 6: Community.- 7: Accessibility.- 8: Sustainability.- 9: Team.- 10. Measures of Success

Details
Erscheinungsjahr: 2023
Genre: Informatik
Rubrik: Naturwissenschaften & Technik
Medium: Taschenbuch
Reihe: Design Thinking
Inhalt: xvii
211 S.
1 s/w Illustr.
39 farbige Illustr.
211 p. 40 illus.
39 illus. in color.
ISBN-13: 9781484295939
ISBN-10: 1484295935
Sprache: Englisch
Ausstattung / Beilage: Paperback
Einband: Kartoniert / Broschiert
Autor: Lakatos, Diana
Auflage: 1st ed.
Hersteller: Apress
Apress L.P.
Design Thinking
Maße: 235 x 155 x 13 mm
Von/Mit: Diana Lakatos
Erscheinungsdatum: 29.09.2023
Gewicht: 0,359 kg
Artikel-ID: 126937594
Warnhinweis

Ähnliche Produkte

Ähnliche Produkte