The Good Docs Project

Templates to make good docs.

Home | Licences Community | Download | Press |

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

Why?

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

How?

We are creating processes, templates, and guides covering the numerous aspects of writing good documentation. We describe our reasoning, referencing research where available, to help writers decide when they should deviate from suggestions.

What?

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

Who?

Our key target audiences are:

Download

2020 Initiatives

The following initiatives are being worked on in 2020:

And possibly: