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.

Documentation is a journey: 3 lessons learned from documenting Scribus

I'd like to use my own personal journey with open source documentation to illustrate how it's possible to begin with little to nothing and create—and then build on—your work…

5 reasons to use a rendered language for documentation

In a previous post, I gave 5 reasons wikis rock for documentation. It was a great deceit. In truth, I'm not a big fan of wikis in most cases. So today I present 5 reasons to…

5 reasons wikis rock for documentation

You may not have noticed, but people often become attached to their favorite technology. This could be a mobile phone, a programming language, or a text editor. When you work…

No swimming sign with alligator biting it

RTFM? How to write a manual worth reading

Definition: RTFM ( Read The F'ing Manual). Occasionally it is ironically rendered as Read The Fine Manual, a phrase uttered at people who have asked a question that we, the…

Git and GitHub for open source documentation

We use git extensively for documentation in OpenStack so that we can "treat the docs like the code"—and I’m seeing this trend many places especially in the Write the Docs…

Asciidoctor coder writes less documentation

I've been working as the documentation manager for the Koha project for six and a half years, so when I saw that Sarah White would be talking about documentation at OSCON this…

Subscribe to Documentation