Documentation Documentation feed

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.

A person writing.

Using some of the basic principles of effective communication can help you create well-written, informative project documents that align with your brand.
Files in a folder

Documentation is as important as code, so make sure you treat it that way. Here's how.
Digital creative of a browser on the internet

Use Docsify to create documentation web pages to publish on GitHub Pages.
Abstract connections between dots

Learn about the importance of architecture and specifically about the importance of diagrams.
Typewriter with hands

Mixing experienced tech writers with open source communities reveals new approaches for creating better docs.
A pink typewriter

Documentation quality can make the difference in people trying your project or passing it by.
Files in a folder

A simple way to automate generating source code documentation, creating HTML and PDF versions of user documentation, compiling a technical (research) document to PDF, generating the bibliography, and provisioning virtual machines.
Python in a coffee cup.

Documentation is best as part of the development process. Sphinx, along with Tox, makes it easy to write and beautiful to look at.