Docs for Developers
eBook - ePub

Docs for Developers

An Engineer’s Field Guide to Technical Writing

  1. English
  2. ePUB (mobile friendly)
  3. Available on iOS & Android
eBook - ePub

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

Yes, you can cancel anytime from the Subscription tab in your account settings on the Perlego website. Your subscription will stay active until the end of your current billing period. Learn how to cancel your subscription.
At the moment all of our mobile-responsive ePub books are available to download via the app. Most of our PDFs are also available to download and we're working on making the final remaining ones downloadable now. Learn more here.
Perlego offers two plans: Essential and Complete
  • 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.
Both plans are available with monthly, semester, or annual billing cycles.
We are an online textbook subscription service, where you can get access to an entire online library for less than the price of a single book per month. With over 1 million books across 1000+ topics, we’ve got you covered! Learn more here.
Look out for the read-aloud symbol on your next book to see if you can listen to it. The read-aloud tool reads text aloud for you, highlighting the text as it is being read. You can pause it, speed it up and slow it down. Learn more here.
Yes! You can use the Perlego app on both iOS or Android devices to read anytime, anywhere — even offline. Perfect for commutes or when you’re on the go.
Please note we cannot support devices running on iOS 13 and Android 7 or earlier. Learn more about using the app.
Yes, you can access Docs for Developers by Jared Bhatti,Sarah Corleissen,Jen Lambourne,David Nunez,Heidi Waterhouse in PDF and/or ePUB format, as well as other popular books in Computer Science & Open Source Programming. We have over one million books available in our catalogue for you to explore.

Information

Table of contents

  1. Cover
  2. Front Matter
  3. 1. Understanding your audience
  4. 2. Planning your documentation
  5. 3. Drafting documentation
  6. 4. Editing documentation
  7. 5. Integrating code samples
  8. 6. Adding visual content
  9. 7. Publishing documentation
  10. 8. Gathering and integrating feedback
  11. 9. Measuring documentation quality
  12. 10. Organizing documentation
  13. 11. Maintaining and deprecating documentation
  14. Back Matter