The Good Docs Project

Templates to make good docs.

Home | About | Licences | Contribute |

TheGoodDocsProject provides best practice templates and writing instructions that empowers people to document Open Source Software, which incidentally will be directly applicable to other domains too.

Doc Types

Multiple doc types are required to achieve a project’s Minimum Viable Docset. Each serves a different purpose and has differing requirements.

Plotting doc types within a maturity model

For each doc type we expect to build:

We are focusing on content, not doc formats or tool chains, at least not yet.

Governance

To address quality and capture collaborative wisdom:

Quality

Document quality requirements differs between doc types and project maturity. We plan to describe doc and process characteristics and processes which lead to maturity, to facilitate discussion around quality.