Ttechnical writer / documentation lead¶
This hub is for people responsible for documentation quality, consistency, and release hygiene.
Your first 10 minutes¶
- Read the non-negotiable style rules.
- Skim the Diátaxis structure and persona hubs.
- Learn how docs changes are reviewed and enforced.
What you likely care about¶
- A stable information architecture (no duplication drift)
- Clear templates and a repeatable doc-writing process
- Quality gates that prevent regressions
- Versioning and redirect hygiene
Start here¶
- Quality gates: Documentation quality gates
- Style guide (canonical): Docs style guide
- Templates: Docs templates
- Canonical content map: Canonical content map
Common tasks¶
- Add a new page: follow Docs templates and enforce Documentation quality gates.
- Fix mixed pages: split into one of {tutorial, how-to, reference, explanation} and update nav + redirects.
- Run a docs consistency check: see
scripts/docs_lint.py.
Read next¶
- Contributing: Contributing
- Docs per release policy: Docs per release policy
- Docs versioning: Docs versioning