Documentation Quality Checklist
Use this checklist when updating docs:
-
Every operator page states what the feature is for, how to use it, and what result to expect.
-
Technical claims reference repository files (paths) or an explicit owner answer — not assumptions.
-
Facts that cannot be verified from this repository are flagged as such (a
// TODOor a "verify with the release/DevOps owner" note), never asserted as certain. -
Architecture diagrams are embedded PlantUML blocks (no pre-rendered SVG-only diagrams).
-
No duplication between the User Guide and the Technical Documentation — shared content lives in a partial (
partial$…) and is included in both. -
User Guide pages stay task-oriented and free of build/deployment detail; deployment detail lives in the Technical Documentation.