Full Description
Learn the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.
Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects. This new edition has been fully updated and edited taking into account the needs for developers and tech writers today, with new content relating to AI, automation and LLMs.
Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation—tools you can adapt to the needs of your own organization.
You Will Learn to:
Create friction logs and perform user research to understand your users' frustrations
Research, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notes
Publish and maintain documentation alongside regular code releases
Measure the success of the content you create through analytics and user feedback
Organize larger sets of documentation to help users find the right information at the right time
This Book Is For
Developers who need to create documentation alongside code, or for technical writers, product managers, community managers, developer advocates, and other technical roles who create and contribute to documentation.
Contents
1. Understanding Your Audience.- 2. Planning Your Documentation.- 3. Drafting Documentation.- 4. Editing Documentation.- 5. Integrating Code Samples.- 6. Adding Visual Content.- 7. Measuring Documentation Quality.- 8. Gathering and Integrating Feedback.- 9. Organizing Documentation.- 10. Maintaining Documentation.- 11. Integrating AI and Automation Tools.
