
Docs for Developers
An Engineerâs Field Guide to Technical Writing
- English
- ePUB (mobile friendly)
- Available on iOS & Android
Docs for Developers
An Engineerâs Field Guide to Technical Writing
About this book
Learn to integrate programming with good documentation. This book teaches you 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.
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.
What You'll Learn
- 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
Who This Book Is For
Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
Frequently asked questions
- Essential is ideal for learners and professionals who enjoy exploring a wide range of subjects. Access the Essential Library with 800,000+ trusted titles and best-sellers across business, personal growth, and the humanities. Includes unlimited reading time and Standard Read Aloud voice.
- Complete: Perfect for advanced learners and researchers needing full, unrestricted access. Unlock 1.4M+ books across hundreds of subjects, including academic and specialized titles. The Complete Plan also includes advanced features like Premium Read Aloud and Research Assistant.
Please note we cannot support devices running on iOS 13 and Android 7 or earlier. Learn more about using the app.
Information
Table of contents
- Cover
- Front Matter
- 1. Understanding your audience
- 2. Planning your documentation
- 3. Drafting documentation
- 4. Editing documentation
- 5. Integrating code samples
- 6. Adding visual content
- 7. Publishing documentation
- 8. Gathering and integrating feedback
- 9. Measuring documentation quality
- 10. Organizing documentation
- 11. Maintaining and deprecating documentation
- Back Matter