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.

Person drinking a hat drink at the computer

7 Git tips for technical writers

Follow along with this demo of how I use Git to write documentation for Foreman.

Write documentation like you develop code

Don't want documentation to be an afterthought? Try a new approach.

A look inside an EPUB file

EPUB files are a great way to publish content using an open format.

Try AsciiDoc instead of Markdown

Next time you write, use AsciiDoc and Asciidoctor as alternatives to Markdown.

How ODT files are structured

Because OpenDocument Format (ODF) are based on open standards, you can use other tools to examine them and even extract data from them. You just need to know where to start.

Level up your HTML document with CSS

Use CSS to bring style to your HTML project documentation.

Subscribe to Documentation