| name | documentation-verify |
| description | Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code. Use when validating documentation correctness or checking code-docs consistency. Flags unsupported or outdated claims. |
Documentation Accuracy Verification
Scope
Accuracy verification only: cross-reference documentation claims, commands, API names, and configuration keys against source code in the same repository. Flag anything that cannot be verified.
Inputs
- Changed documentation files (from
git diff). If git diff is unavailable or empty, use files explicitly provided for review; otherwise, treat all documentation files under docs/ as changed.
- Full codebase.
- Test files, configuration schemas.
- Documentation structure.
Workflow
Follow this three-stage process to verify documentation accuracy:
Stage 1: Discovery Scan
Objective: Identify documentation claims and form initial hypotheses.
- Run
git diff to list changed documentation files.
- Categorize changes into claim types (behaviour, CLI, API, config, examples, error messages, etc.).
- Form initial hypotheses: Supported, Unsupported, Speculative, Ambiguous, or Outdated.
For detailed categorization and hypothesis formation procedures, see references/verification_procedures.md → Discovery Scan.
Stage 2: Verification Pass
Objective: Verify every hypothesis with code evidence. Code is the source of truth.
CRITICAL: Complete verification before reporting any claims.
- Use at least two search strategies per claim (direct search, entrypoint tracing, test evidence, schema/validation search).
