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.

Adopting minimalism in your docs

The best technical documentation is in sync with the reader’s needs. How can you make that happen?
Your step-by-step guide to more effective documentation

Want to write better project documentation? This guide helps you level up.
Why auditing your documentation is a must

If you ask a group of people about the qualities of good documentation, you'll probably get many...
Modular documentation: How to make both writers and users happy

Learn about a new approach to modular documentation based on user stories, and how it can make life...
An introduction to DocBook, a flexible markup language worth learning

DocBook is easy to learn, easy to write, and does things other text markup languages can't do.
How to write better error messages

Try this simple technique to write messages that help users understand the reason for errors.
How to write an effective checklist for documentation

Don't take a chance you'll miss something, big or small, when you release documentation. Here's how...
Why you should always do documentation before development

Learn how documentation before development focuses your code toward a specific blueprint of how an...