doc-consistency

Detect and quantify documentation drift across core authored docs.

1|Updated May 28, 2026
One-click install
npx skills add https://github.com/amoutiers/maxi-superpowers --skill doc-consistency-amoutiers
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-consistency
Source: https://github.com/amoutiers/maxi-superpowers/tree/main/.claude/skills/doc-consistency
Command: npx skills add https://github.com/amoutiers/maxi-superpowers --skill doc-consistency-amoutiers

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

maxi-superpowers documents a "Mandatory Sync" rule in CLAUDE.md, but nothing enforces it. Docs drift: skill counts go stale, test lists fall behind, the four sync-locked files disagree. This skill makes the review systematic and reproducible — an unguided pass catches some drift by luck and misses table-level mismatches.

Core Features & Use Cases

Core split: mechanical facts have one ground truth (compute it, compare). Semantic findings need judgment (verify before asserting; never auto-fix).

Run from repo root.

When to Use

  • Before committing any change to the pipeline, a skill, the test suite, or the FSM
  • After editing CLAUDE.md, README.md, docs/architecture.md, or any Mandatory-Sync-4 file
  • When asked to check docs are consistent / in sync / not contradictory

Scope (authored docs only): CLAUDE.md, AGENTS.md, README.md, VENDORED.md, docs/architecture.md, docs/pipeline-flow.md, docs/delegation-map.md, skills/using-maxi/SKILL.md. Exclude docs/maxi/specs/** and docs/maxi/adr/** — those are point-in-time artifacts that intentionally drift.

Quick Start

Run this audit from the repository root to detect and report doc-consistency issues across CLAUDE.md, README.md, architecture.md, and related docs.

Frequently Asked Questions about doc-consistency

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

FAQPage Schema
How do I detect documentation drift across CLAUDE.md and README.md before committing?

Detect documentation drift by running an audit from the repository root that enforces mechanical checks for single ground-truth facts and semantic consistency across the mandatory-sync four-file policy. It compares authored docs like CLAUDE.md, README.md, and architecture.md to quantify mismatches.

What is documentation drift and how do I audit markdown files for consistency?

Documentation drift occurs when sync-locked files disagree, skill counts go stale, or test lists fall behind. Audit markdown files by running a systematic review that mechanically computes ground-truth facts and reports coherence across authored documents, replacing unguided manual passes.

When should I run a docs consistency audit on my repository?

Run a docs consistency audit before committing changes to the pipeline, a skill, the test suite, or the FSM. Also run it after editing CLAUDE.md, README.md, docs/architecture.md, or any file governed by the mandatory-sync four-file policy to catch drift.

Can I automatically fix documentation consistency issues found during a review?

You cannot automatically fix documentation consistency issues. Mechanical findings are computed and compared directly, but semantic findings require human judgment to verify before asserting, meaning the audit reports drift and coherence without auto-fixing contradictions.

Are there limitations on which files are included in a markdown consistency audit?

The audit scope is limited to authored docs like CLAUDE.md, AGENTS.md, README.md, and docs/architecture.md. It explicitly excludes docs/maxi/specs/ and docs/maxi/adr/ directories because those are point-in-time artifacts that intentionally drift.

What's the best way to keep CLAUDE.md and architecture.md in sync without missing table mismatches?

The best way to keep CLAUDE.md and architecture.md in sync is using a systematic audit that mechanically checks ground-truth facts and reports coherence. An unguided pass catches some drift by luck but misses table-level mismatches that a reproducible review catches.