This meta-template is primarily for maintainers and contributors who want to create new documentation templates. Before contributing, please open an issue to discuss your proposed template.
What is the Meta-Template?
The meta-template is an outline that guides the creation of new documentation templates. It ensures consistency across all templates in this collection and helps template creators think through the essential elements that make documentation effective.Why Use This Framework?
When creating a new template, you need to consider:- Purpose and audience - Who will use this template and why?
- Critical content - What information must be included?
- User journey - What knowledge and tasks are prerequisite, and what comes next?
- Quality standards - How do we ensure this template produces effective documentation?
Template Structure
Define the Template Summary
Start by clearly articulating the template’s purpose:
- Purpose of the document - What is this documentation meant to achieve?
- Who it is for - Who is the primary audience?
- When and why is it needed? - What justifies this as a critical document in the minimum viable doc set?
Structure the Contents
Prerequisites
Every template should address these questions:- What knowledge do readers need before they begin?
- What tasks must be completed? (installation, environment configuration, etc.)
- What will this document help the reader accomplish?
- Where can readers get necessary resources? (tokens, API keys, credentials, etc.)
Template Body
The body structure depends on the document type:- Reference docs - Exhaustive listings with consistent formatting
- Quickstarts - Step-by-step workflows
- Overviews - Conceptual explanations and high-level architecture
- Setup guides - Installation and configuration procedures
Postrequisites
Help readers understand what comes next:- What can they do now that they’ve completed this document?
- What should they read next?
- What are the logical next steps in their journey?
Provide Supporting Resources
More Information
Include:- Links to good examples - Show real-world implementations
- Further reading - Additional resources, bibliographic citations, and supporting documentation
Creating Your Template
Start with the Summary
Before writing any content, complete the template summary section. This clarifies your thinking and ensures the template serves a real need.
Think About the User Journey
Consider what the user knows before they arrive, what they’ll learn, and where they’ll go next. Documentation doesn’t exist in isolation.
Be Specific About Prerequisites
Don’t leave users guessing. Explicitly state required knowledge, tools, and preparation steps.
Include Examples
Show, don’t just tell. Good examples make templates immediately useful and reduce ambiguity.
Related Projects
This meta-template was the predecessor to one under construction at The Good Docs Project. Their template will be slightly longer and includes additional details.
- Website: thegooddocsproject.dev
- GitHub: github.com/thegooddocsproject
Next Steps
Review Existing Templates
See how existing templates apply this framework
Contribute
Learn how to propose and submit new templates