Documentation

Good documentation—including installation guides, user guides, white papers, FAQs, and more—provides users a roadmap to using software and hardware. Our articles focus on giving open source project creators ways to improve the quality and usefulness of their documentation.

Tips and top presentations from Write the Docs Portland 2017

Three tips for writing better documentation and four recommended talks from the conference.

3 cool machine learning projects using TensorFlow and the Raspberry Pi

Fixing docs one README at a time

GitHub's recent survey reveals 93% say poor documentation is a problem. Learn how the new project Feedmereadmes can help.

Documentation based on user stories

Documentation can either focus on describing product features and the way they can be used, or it can start with identifying user needs and then explaining how to achieve…

5 steps to excellent documentation

A stepwise approach to documentation that hooks people, gets them up and running, and turns them into confident users.

Command-line document conversion tools for writers

Find out how Markdown with Pandoc and Org-mode make writing documents a lot easier.

How to make release notes count

Congratulations! You're ready to ship the latest release of your software package. Now you need to make sure your release notes are in order. Sure, you could just slap "bug…

Subscribe to Documentation