| 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
