Docs for Developers: An Engineer’s Field Guide to Technical Writing
- Length: 246 pages
- Edition: 1
- Language: English
- Publisher: Apress
- Publication Date: 2021-11-29
- ISBN-10: 1484272161
- ISBN-13: 9781484272169
- Sales Rank: #94552 (See Top 100 Books)
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.
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
Donate to keep this site alive
How to download source code?
1. Go to: https://github.com/Apress
2. In the Find a repository… box, search the book title: Docs for Developers: An Engineer’s Field Guide to Technical Writing, sometime you may not get the results, please search the main title.
3. Click the book title in the search results.
3. Click Code to download.
1. Disable the AdBlock plugin. Otherwise, you may not get any links.
2. Solve the CAPTCHA.
3. Click download link.
4. Lead to download server to download.
