// 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.
| 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. |
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.
git diff). If git diff is unavailable or empty, use files explicitly provided for review; otherwise, treat all documentation files under docs/ as changed.Follow this three-stage process to verify documentation accuracy:
Objective: Identify documentation claims and form initial hypotheses.
git diff to list changed documentation files.For detailed categorization and hypothesis formation procedures, see references/verification_procedures.md → Discovery Scan.
Objective: Verify every hypothesis with code evidence. Code is the source of truth.
CRITICAL: Complete verification before reporting any claims.
For comprehensive verification checklists and classification rules, see references/verification_procedures.md → Verification Pass.
Objective: Present verified findings with evidence and conservative recommendations.
For report formatting template and change suggestion guidelines, see references/report_format.md.
Only verified findings with evidence make it to the final report. Do not include intermediate hypotheses or reasoning.
Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Use when checking documentation style or validating MyST/reST syntax. Cites specific style guide violations.
Validates documentation builds successfully. Use when checking Sphinx/RTD build integrity or diagnosing build failures. Reports errors, warnings, and build configuration issues.
Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation). Use when reviewing documentation structure or classifying content type. Identifies misalignments between declared category and actual content.
Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance. Use when reviewing documentation changes or auditing documentation quality.
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.