| name | common-doc-audit-k |
| type | knowledge |
| description | ALWAYS USE if you are the verifier or gardener. Use after any build cycle to audit documentation accuracy — check diagram drift, living doc freshness, ARCHITECTURE.md currency, cross-link integrity, and plan status. Gardener uses broadly across the full doc tree; verifier uses post-build to confirm the builder did its doc duty.
|
| user-invocable | false |
Knowledge skill — Doc health: what to check, how to prioritize, verifier vs gardener scope.
Documentation Health
Stale docs actively mislead. From an agent's perspective, anything not in the repo doesn't exist — and anything in the repo that's wrong is worse than nothing.
Two Scopes
Verifier — runs post-build as part of the main loop. Checks: did the builder do its doc duty? Do living docs match what was just built? Are diagrams current? Is ARCHITECTURE.md updated?
Gardener — runs anytime, broader scope. Checks: does the entire design-docs/ tree accurately represent the system? Have things drifted since last audit? Are there orphans, broken links, stale plans?
Same checklist, different aperture.
What to Check
Check │ What "wrong" looks like
─────────────────────────────┼──────────────────────────────────────
Diagram accuracy │ Class diagram missing new fields/methods
│ Data flow doesn't match actual flow
│ Component diagram has removed modules
─────────────────────────────┼──────────────────────────────────────
ARCHITECTURE.md │ Doesn't cover new components
│ Module names don't match code
│ Dependency directions wrong
─────────────────────────────┼──────────────────────────────────────
Living doc freshness │ Describes old behavior
│ References files that don't exist
│ Examples don't work
─────────────────────────────┼──────────────────────────────────────
Plan status │ Completed plans still marked active
│ Progress sections not updated
│ Missing decision logs
─────────────────────────────┼──────────────────────────────────────
Cross-links │ Plans don't link to architecture
│ Living docs not in ARCHITECTURE.md
│ Plans missing from index
─────────────────────────────┼──────────────────────────────────────
Coverage │ Components built without living docs
│ Major modules undocumented
│ New APIs without integration docs
Priority
- Actively misleading — docs that will cause the next agent to make wrong decisions
- Drifted — docs that are stale enough to confuse but not dangerously wrong
- Missing — gaps where docs should exist but don't
- Cosmetic — formatting, naming, minor cross-link fixes
