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.

3 reasons to host a docathon for your open source project

A marathon for documentation is a great way to produce or improve the docs for your open source project.

Write documentation that actually works for your community

Establishing good documentation can be difficult, but it's critical to effective communication. Follow this framework for writing and sharing documentation with the right…

4 open source technologies to make writing easier

If you are getting started in technical writing, you might be interested in this list of open technologies that make technical writing easier.

Document with BookStack, an open source Confluence alternative

BookStack is an open source, web-based documentation system, that allows you to create a structured knowledge store for personal, team, or company use.

Improve your documentation with JavaScript

Make your open source project documentation dynamic so it appeals to users of all experience levels.

Our favorite markup languages for documentation

Documentation is critical to open source software projects. We asked our contributors what their favorite markup language is for documentation.

Subscribe to Documentation