// Use when reviewing documentation for accuracy, completeness, and alignment with source code. Catches doc-code drift before it confuses readers.
Use when evaluating whether a proposed change fits the existing architecture. Prevents layer violations, dependency cycles, and accidental coupling.
Use when the user wants a code review instead of implementation. Prioritizes correctness bugs, behavioral regressions, missing tests, and risky assumptions.
Use when making changes that should be committed. Enforces atomic commits, meaningful messages, and clean history.
Use when investigating slow execution, high memory usage, or excessive token consumption. Systematic measurement before optimization.
Use when improving code structure without changing behavior. Ensures each refactoring step preserves all existing tests.
Use when reviewing code for security vulnerabilities. Covers prompt injection, path traversal, command injection, and agent-specific attack vectors.
| name | documentation-review |
| description | Use when reviewing documentation for accuracy, completeness, and alignment with source code. Catches doc-code drift before it confuses readers. |
| version | 1.0.0 |
| author | Aixlarity |
| license | Apache-2.0 |
| metadata | {"aixlarity":{"tags":["documentation","review","quality","accuracy"],"related_skills":["code-review","writing-plans"]}} |
Documentation that disagrees with the source code is worse than no documentation. It actively misleads.
For every documentation page, verify:
code block that references a file path, function name, or CLI command must correspond to something that actually exists in the repo.Key areas prone to doc-code drift:
docs/chapters/home.html — stats (tool count, test count)docs/chapters/u1.html — install instructions, git clone URLREADME.md — feature list, architecture diagramdocs/chapters/comp.html — comparison claims