repo-doc-audit

Audits repository documentation for contradictions, drift, and governance gaps across 18 sections.

1|Updated Jun 2, 2026
One-click install
npx skills add https://github.com/SevWren/Daily-Motivation-Brain-Helper --skill repo-doc-audit-sevwren
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: repo-doc-audit
Source: https://github.com/SevWren/Daily-Motivation-Brain-Helper/tree/main/CLAUDE/skills/repo-doc-audit
Command: npx skills add https://github.com/SevWren/Daily-Motivation-Brain-Helper --skill repo-doc-audit-sevwren

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve? Repository documentation drifts out of sync with code over time — READMEs contradict changelogs, setup guides reference removed features, and no one knows which file is authoritative. This Skill performs a systematic 18-section audit that surfaces contradictions, dead knowledge, traceability failures, and governance gaps before they mislead developers or AI agents. ## Core Features & Use Cases - Automated Repository Enumeration: A bundled Python script classifies files into priority buckets, detects version string conflicts, verifies internal markdown links, and maps governance artifact presence in one pass. - Ten Finding Categories: Detects Direct Contradictions (DC), Semantic Contradictions (SC), Terminology Drift (GD), Traceability Failures (TF), Documentation Drift (DD), Process Drift (PD), Dead Knowledge (DK), Orphan Knowledge (OK), Coverage Gaps (CG), and Governance Improvements (RGI) with stable, severity-rated IDs. - Five Structured Outputs: Produces a full 18-section audit report plus four standalone findings documents (Direct-Contradictions.md, Semantic-Contradictions.md, Traceability-Failures.md, Proposed-Repository-Governance-Improvements.md) that developers can act on independently. - Use Case: Point the Skill at a codebase whose CLAUDE.md, README, and config files have diverged over months of development; receive a prioritized remediation roadmap with root-cause analysis and measurable done-criteria. ## Quick Start Ask the AI to run a documentation audit on your repository by providing the repo root path or a GitHub URL to clone.

Frequently Asked Questions about repo-doc-audit

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

FAQPage Schema
How do I audit repository documentation for inconsistencies?▼

Provide the repository root path or a GitHub URL, and the audit runs in four phases: automated enumeration, prioritized file reading, 18-section analysis, and report generation. You receive a full audit report plus standalone findings documents for contradictions and traceability failures.

What does a documentation governance audit check for?▼

It checks ten finding categories including direct contradictions between files, semantic contradictions between docs and code, terminology drift, traceability failures, dead knowledge like broken links, orphan documents, and coverage gaps in governance artifacts such as CLAUDE.md or CONTRIBUTING files.

Can the audit handle very large repositories?▼

Yes. Repositories over 500 files trigger triage mode where source code is sampled rather than read fully, and repos over 1000 files prompt a user notification before starting. Thresholds are configurable in audit-config.yaml.

How do I customize which files the repo audit examines?▼

Create a .audit-config.yaml file in the target repository root. The enumeration script deep-merges it over the bundled defaults, letting you override file patterns, exclusion paths, version sources, thresholds, and which finding types are enabled.

What output files does the documentation audit generate?▼

It writes exactly five Markdown files: a full 18-section Repository-Audit-Report.md plus Direct-Contradictions.md, Semantic-Contradictions.md, Traceability-Failures.md, and Proposed-Repository-Governance-Improvements.md, each containing complete finding detail.