Agent skill
doc-review
Review documentation for accuracy, drift, and duplication. No code changes.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/doc-review
SKILL.md
Doc Review
Review documentation for correctness, alignment with code and GitHub state, and minimal duplication. No fixes — findings only.
Inputs
Which docs (or PR) to review. Audience focus (dev workflow vs player-facing).
Review-aware
Before starting: check if <slug>.findings.md exists for these docs. If it does, build on prior findings.
Workflow
-
Load docs — Read the target doc(s). Load
docs/DOCUMENTATION_POLICY.mdto know what format and accuracy standards apply. -
Cross-check — Validate each claim against:
- Code (grep for referenced function names, file paths, constants)
- GitHub state (
gh issue list,gh pr list) for workflow accuracy - Design pillars (
design/) for design claim accuracy - Other docs for duplication (flag the single best source of truth)
-
Report — Group findings by severity (Critical/Major/Minor) with
path:lineand suggested fix. Note any sections that are outdated, missing, or contradicted by code. -
Use
/findings— Write findings to<slug>.findings.mdso the author can respond without copy-paste.
Reference
- Documentation policy:
docs/DOCUMENTATION_POLICY.md
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?