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 have to be considered while crafting developer documentation, such as hitting the right target audience, designing a seamless onboarding experience, 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 challenging for those working on developer documentation to grasp the entire process, including all essential ingredients, tools, and resources.
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 developmentUtilize design thinking, community-driven documentation, and Docs as CodeUnderstand 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 implementation
Who This Book Is For
Documentation maintainers and managers, technical writers, developer relations practitioners and advocates, technical community managers, developer marketers, software developers and designers, and start-up founders, CTOs, and CEOs