What problem does it solve?
Enforces documentation quality, completeness, and mutual consistency across architecture files, ADRs, runbooks, READMEs, and code-level documentation so that your repository reflects the current system design and operating procedures.
Core Features & Use Cases
- Cross-file Consistency Enforcement: Checks relationships, definitions, rules, and configurations across architecture and constraint artifacts to prevent contradictions and outdated claims.
- Documentation Coverage Verification: Verifies required artifacts exist and are current, including ADR presence for significant decisions, runbooks for on-call alerts, and README currency for setup and architecture diagrams.
- Code and Operational Documentation Sanity: Confirms non-obvious code blocks include explanatory "why" comments, avoids overconfident existence-only checks, and ensures subdirectory AGENTS.md context aligns with global invariants.
Quick Start
Ask the docs-review skill to review the repository’s documentation consistency across .md/.mmd/*.mzn files and report any inconsistencies it finds.