audit-docs

Scan documentation and code to report load-bearing discrepancies with citations.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/jluckyiv/rivcomocktrial --skill audit-docs-jluckyiv
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/jluckyiv/rivcomocktrial/tree/main/.claude/skills/audit-docs
Command: npx skills add https://github.com/jluckyiv/rivcomocktrial --skill audit-docs-jluckyiv

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit and verify that load-bearing claims in CLAUDE.md, README.md, docs/decisions.md (ADRs), and other docs/*.md accurately reflect the current codebase, preventing drift.

Core Features & Use Cases

  • Cross-checks claims in documentation against the repository to surface mismatches.
  • Identifies stale ADRs, broken links, and outdated references, including port numbers and file paths.
  • Produces a structured report suitable for on-demand and quarterly audits, enabling fast remediation.

Quick Start

Run the docs-claims.sh script to generate a comprehensive mismatch report.

Frequently Asked Questions about audit-docs

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

FAQPage Schema
How do I check if my documentation has drifted from the actual codebase?▼

You can audit documentation drift by running the docs-claims.sh script, which scans CLAUDE.md, README.md, and ADRs against the repository to produce a structured mismatch report with citations for discrepancies like stale ports or outdated file paths.

What is the best way to audit ADRs and find outdated references in markdown docs?▼

Auditing ADRs involves cross-checking load-bearing claims in docs/decisions.md against the repository to identify stale decisions and outdated references, producing a structured report for fast remediation.

Do I need ripgrep installed to verify documentation claims against my code?▼

Yes, ripgrep (rg) is required to verify documentation claims against your code, along with access to your docs, ADRs, and configuration files to scan and report load-bearing discrepancies.

Can I limit the documentation audit scope to avoid false positives in my workspace?▼

Yes, you can limit the audit scope to avoid false positives by operating within known workspace paths like ~/Code/github or ~/Code/playground, restricting checks to the documented scope.

What types of documentation discrepancies does a code reality audit report?▼

A code reality audit reports load-bearing discrepancies such as stale ADRs, broken links, outdated file paths, and incorrect port numbers, producing findings with citations for each mismatch found in CLAUDE.md, README.md, and docs/*.md.

When should I run a documentation drift audit on my repository?▼

You should run a documentation drift audit on-demand or quarterly to ensure load-bearing claims in CLAUDE.md, README.md, and ADRs accurately reflect the current codebase, enabling fast remediation of mismatches.