docs-review

Cross-reference architecture diagrams, ADRs, runbooks, READMEs, and code documentation for inconsistencies.

3|1|Updated Apr 12, 2026
One-click install
npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill docs-review-cogni-ai-ou
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/Cogni-AI-OU/cogni-ai-agent-skills/tree/main/docs-review
Command: npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill docs-review-cogni-ai-ou

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about docs-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check documentation consistency across architecture diagrams, ADRs, and runbooks?

Documentation consistency is enforced by cross-referencing definitions, relationships, and update currency across ADRs, runbooks, READMEs, and architecture diagrams to detect and resolve contradictions. This ensures repository artifacts accurately reflect the current system design and operating procedures.

What is the best way to verify ADR and README coverage after architectural changes?

The best way to verify ADR and README coverage is to check that required artifacts exist and remain current, ensuring ADRs document significant decisions and READMEs reflect updated setup and architecture diagrams. This prevents outdated claims and missing operational context.

How do I audit markdown files and runbooks for outdated information during repository maintenance?

To audit markdown files and runbooks for outdated information during maintenance, cross-reference definitions and configurations across architecture and constraint artifacts. This verifies mutual consistency and applies conditional edits only when actual contradictions or outdated information are found.

Can I validate AGENTS.md context alignment without overwriting correct documentation?

Yes, validating AGENTS.md context alignment checks that subdirectory context aligns with global invariants without overwriting correct documentation. Conditional edits are applied exclusively when actual contradictions or outdated information are discovered, preserving accurate existing files.

When do I need a repository-wide documentation audit?

A repository-wide documentation audit is needed after architectural decisions, during maintenance, or when encountering complex code requiring verification of documentation accuracy. It enforces mutual consistency and verifies ADR, runbook, README, and AGENTS.md coverage across the repository.