Build your toolkit
Reference
Ready-to-adapt templates, checklists, and worked examples for technical documentation — copy them and start from a working baseline instead of a blank page.
Templates, checklists, and examples you can copy directly into your own project. Each item is clearly labeled as either a template (a starting point you adapt) or a worked example (a finished illustration you study).
The templates below build on information types: Concepts, Tasks, and References.
Templates
Section titled “Templates”Concept article templateDefinition, why it matters, key principles, examples, trade-offs.
Task article templateObjective, prerequisites, steps, expected result, troubleshooting.
Reference article templateOverview, syntax, parameters, examples, limitations.
Documentation project planGoal, audience, scope, format, success criteria, timeline.
Documentation review requestScope a review so it actually gets done.
Checklists
Section titled “Checklists”Documentation qualityRun before merging any documentation change.
Technical reviewWhat a subject-matter-expert reviewer should and shouldn't check.
Release readinessA gate for shipping docs alongside a product release.
Documentation migrationMoving between formats or platforms without losing content or URLs.
Docs-as-code adoptionFormat, version control, CI/CD, and team readiness.
Documentation auditFind orphaned pages, duplicates, and stale content.
Worked examples
Section titled “Worked examples”A well-structured Markdown pageAn annotated concept article, explaining each structural choice.
A documentation repository structureLocale-first content, separated from tooling and assets.
A basic docs-as-code workflowOne change, branch to production, annotated step by step.
A documentation review workflowSplitting technical review from editorial review, and why.
A practical CI/CD pipelineBuild, test, link-check, preview, deploy — annotated stage by stage.
API documentation
Section titled “API documentation”API documentation templateOne endpoint per page: method, parameters, request/response, error codes.