“Best practice templates and writing instructions for documenting open source software.”
Every project deserves a minimum level of Good Docs that help users understand and solve problems with your product. But it can be really hard to know where to start or what to write. How do you structure docs? What does a docs website look like? How do I keep docs consistently formatted? The list of questions far outweigh the answers.
That’s where The Good Docs Project fits in. Our open-source Minimum Viable Docset (MVD) will help you create a baseline set of Good Docs using a suite of templates.
Your Good Docs can then be extended into Better Docs with greater depth, quality and maturity.
Providing writing templates:
- Amplifies the writing effectiveness of developers, power users writers, and more.
- Improves doc quality and consistency across the board.
- Facilitates the democratisation of knowledge.
- Leads to self-empowerment and the betterment of humankind.
Who are we?
We are a bunch of technical writers, educators, product developers and power users who also write. Some of us have big titles in large organisations; others don’t. We are committed to helping others write great documentation through this project.