國立虎尾科技大學 |

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

Record Type:	Language materials, printed : Monograph/item
Title/Author:	Crafting docs for success/ by Diana Lakatos.
Reminder of title:	an end-to-end approach to developer documentation /
Author:	Lakatos, Diana.
Published:	Berkeley, CA :Apress : : 2023.,
Description:	xvii, 211 p. :ill., digital ; : 24 cm.;
Contained By:	Springer Nature eBook
Subject:	Application software - Development -
Online resource:	https://doi.org/10.1007/978-1-4842-9594-6
ISBN:	9781484295946

Crafting docs for success = an end-to-end approach to developer documentation /
Lakatos, Diana.

Crafting docs for successan end-to-end approach to developer documentation /[electronic resource] :by Diana Lakatos. - Berkeley, CA :Apress :2023. - xvii, 211 p. :ill., digital ;24 cm. - Design thinking,2945-7807. - Design thinking..

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

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

ISBN: 9781484295946

Standard No.: 10.1007/978-1-4842-9594-6doiSubjects--Topical Terms:

1430847
Application software
--Development

LC Class. No.: QA76.6

Dewey Class. No.: 006.76

Crafting docs for success = an end-to-end approach to developer documentation /
LDR:02998nam a2200337 a 4500 001 1117197
003 DE-He213
005 20230928220034.0
006 m d
007 cr nn 008maaau
008 240124s2023 cau s 0 eng d
020 $a 9781484295946 $q (electronic bk.)
020 $a 9781484295939 $q (paper)
024 7 $a 10.1007/978-1-4842-9594-6 $2 doi
035 $a 978-1-4842-9594-6
040 $a GP $c GP
041 0 $a eng
050 4 $a QA76.6
072 7 $a UMW $2 bicssc
072 7 $a COM060160 $2 bisacsh
072 7 $a UMW $2 thema
082 0 4 $a 006.76 $2 23
090 $a QA76.6 $b .L192 2023
100 1 $a Lakatos, Diana. $3 1430846
245 1 0 $a Crafting docs for success $h [electronic resource] : $b an end-to-end approach to developer documentation / $c by Diana Lakatos.
260 $a Berkeley, CA : $b Apress : $b Imprint: Apress, $c 2023.
300 $a xvii, 211 p. : $b ill., digital ; $c 24 cm.
490 1 $a Design thinking, $x 2945-7807
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.
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 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. 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.
650 0 $a Application software $x Development $x Miscellanea. $3 1430847
650 0 $a Technical writing. $3 528234
650 1 4 $a Web Development. $3 1114136
650 2 4 $a Open Source. $3 1113081
710 2 $a SpringerLink (Online service) $3 593884
773 0 $t Springer Nature eBook
830 0 $a Design thinking. $3 1417985
856 4 0 $u https://doi.org/10.1007/978-1-4842-9594-6
950 $a Professional and Applied Computing (SpringerNature-12059)