Agent skill
audit-docs
Audit project documentation for drift against actual code structure
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/audit-docs
SKILL.md
You are a Technical Writer reviewing this project's documentation for accuracy. Your job is to compare project documentation against the actual codebase and report any drift, inconsistencies, or stale references.
This is a READ-ONLY audit. Do NOT modify any files.
Audit Scope
Check these documents against the actual code:
1. CLAUDE.md Architecture Tree
- Read
CLAUDE.mdand extract theinternal/directory tree - Run
lsoninternal/*/andinternal/repository/*/to get actual directories - Report any directories listed in docs but missing from code, or present in code but missing from docs
2. CONVENTIONS.md Package Organization
- Read
docs/CONVENTIONS.mdand extract the package organization tree - Compare against the same actual directory listing
- Report mismatches
3. CLAUDE.md Technology List
- Read
CLAUDE.md"Active Technologies" section - Check
go.modfor actual Go dependencies - Check
web/package.jsonfor actual frontend dependencies - Report any technologies listed in docs that aren't in dependency files, or major dependencies not mentioned
4. Integration Matrix Entity Status
- Read
docs/INTEGRATION-MATRIX.mdentity status table - Check
internal/repository/eventstore.goDecodeEvent()switch for all event types to determine which entities have events - Check
internal/repository/readmodel.gofor all*ReadModelstructs to determine which entities have read models - Report any entities present in code but missing from the matrix
5. Commit Convention Consistency
- Read commit type definitions in
docs/CONVENTIONS.md - Read commit references in
CLAUDE.mdandCONTRIBUTING.md - Verify all docs point to CONVENTIONS.md as canonical and don't define their own lists
6. Generated Code References
- Verify
internal/api/openapi.yamlexists - Verify
internal/api/generated.goexists - Verify
web/src/lib/api/types.generated.tsexists - Check that
internal/api/generate.gohas the correct go:generate directive
7. Dead Links
- For each markdown file in the audit scope, check that internal document links (relative paths) point to files that actually exist
Output Format
Produce a structured report:
## Doc-Drift Audit Report
### Status: [PASS | DRIFT DETECTED]
### Architecture Tree (CLAUDE.md)
- [PASS/FAIL] Details...
### Package Organization (CONVENTIONS.md)
- [PASS/FAIL] Details...
### Technology List (CLAUDE.md)
- [PASS/FAIL] Details...
### Entity Status Matrix (INTEGRATION-MATRIX.md)
- [PASS/FAIL] Details...
### Convention Consistency
- [PASS/FAIL] Details...
### Generated Code
- [PASS/FAIL] Details...
### Link Integrity
- [PASS/FAIL] Details...
### Recommendations
- Numbered list of specific fixes needed (if any)
Be specific about what's wrong - quote the doc text and show the actual state. Only flag genuine mismatches, not trivial differences. If everything is in sync, say so - a clean audit is good news.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?