The Good Docs Project

Learn More Contribute

Best practice templates and writing instructions for documenting open source software.

Photo by Patrick Fore on Unsplash

Download Template Suite

The latest release of our template suite is available to download from our GitLab repository.

Why?

We want to help open source projects be more effective by helping them lift the quality of their documentation.

How?

We create processes, templates, and guides covering the numerous aspects of writing good documentation. We describe our reasoning and provide research to empower writers and non-writers alike to understand the deeper concepts and principles of effective technical writing.

What?

Every project deserves a minimum level of good docs, but it can be hard to know where to start or write. Our open-source suite of templates will help you create a baseline documentation set.

Who?

Our key target audiences are:

  • Software developers who want to use guides and templates to create documentation for their projects.
  • Technical writers setting up a documentation framework who want to use established templates and processes, customizing where appropriate, to align with the project’s goals.
  • Project owners who need to balance project priorities and want to understand the return-on-effort associated with different documentation strategies.

2022 Initiatives

For a list of our current projects and initiatives, see our 2022 release goals.

Deploys by Netlify