Crafting Docs for Success : An End-To-End Approach to Developer Documentation
Crafting Docs for Success : An End-To-End Approach to Developer Documentation
Click to enlarge
Author(s): Lakatos, Diana
ISBN No.: 9781484295939
Pages: xvii, 211
Year: 202309
Format: Trade Paper
Price: $ 70.27
Dispatch delay: Dispatched between 7 to 15 days
Status: Available

Developer documentation is an essential resource that provides developers with comprehensive information, guidance, and examples for effectively using APIs, frameworks, libraries, or software platforms. It's also a powerful tool in developer relations because it provides all the necessary information during the onboarding process, keeps your users informed on changes and plans, helps you maintain relationships with your users, helps build a community, and encourages collaboration. Using a design thinking approach , this book aims to provide an easy-to-follow blueprint for building successful developer documentation drawing from the valuable insights gained while building the award-winning platformOS developer portal. You'll work with practical usable templates, workflows, and tools all 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 examine these very large and complex mix of topics, each with their own considerations and concerns, and gain insight as to 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 Will 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 Documentation maintainers and managers, software developers and designers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, start-up founders, CTOs, and CEOs.



To be able to view the table of contents for this publication then please subscribe by clicking the button below...
To be able to view the full description for this publication then please subscribe by clicking the button below...