Documentation Quality Standards

Status: Canonical · Owner: Documentation Guild

---

Quality bar

Enterprise documentation must meet all criteria before publication:

Criterion	Requirement
Accuracy	Matches frozen baseline or explicit draft status
Authority	Single owner named; no orphan pages
Discoverability	Listed in INDEX.md and section README
Cross-links	Related pages, contracts, modules linked
Diagrams	Architecture/lifecycle pages include ≥1 Mermaid diagram
Terminology	Uses terminology.md vocabulary
No duplication	Cite-only for company/product constitutions
Review	Peer review for ADR and governance changes

---

Page metadata block

Every page must begin with:

**Status:** Draft | Review | Canonical | Deprecated
**Owner:** Team or role
**Last updated:** YYYY-MM-DD

---

Required footer sections

Every substantive page includes:

## Related
- [Link to parent index]
- [Link to contracts / modules / platforms]

## Breadcrumbs
Home → Section → Page

---

Review checklist

• [ ] Listed in section README and INDEX.md
• [ ] Cross-links resolve (no broken relative paths)
• [ ] Mermaid renders in GitHub / IDE preview
• [ ] No embedded secrets or environment values
• [ ] Frozen platform claims verified against baseline tag
• [ ] ADR number unique and indexed

---

Anti-patterns

Anti-pattern	Fix
README as only doc	Create structured section
Copy-paste from chat	Rewrite as canonical prose
Duplicate ADR in product repo	Cite platform ADR; product ADR only for product-specific decisions
"TBD" without owner/date	Open gap in COVERAGE_REPORT

---

Related

• templates/
• GOVERNANCE/COVERAGE_REPORT.md