repo-docs-audit

Audit repository documentation against code and active plans to surface drift.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/mjamore/repo-docs-skill --skill repo-docs-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-docs-audit
Source: https://github.com/mjamore/repo-docs-skill/tree/main/repo-docs-audit
Command: npx skills add https://github.com/mjamore/repo-docs-skill --skill repo-docs-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit repository documentation against code and active plans to surface drift and misalignment between docs, plans, and implementation. This helps ensure that the documentation remains the single source of truth and aligns with the actual code changes.

Core Features & Use Cases

  • Detect drift between /docs, /docs/plans, and the codebase.
  • Verify progressive disclosure and archiving readiness by ensuring plan/spec links stay current.
  • Identify broken links, stale references, or missing documentation that blocks accurate audits.

Quick Start

Run a lightweight audit on the current workspace to surface concrete repo-docs and code inconsistencies.

Frequently Asked Questions about repo-docs-audit

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

FAQPage Schema
How do I detect documentation drift between my codebase and active plan specs?

To detect documentation drift, audit repository docs against code and active plans to surface misalignment. This verifies that progress documentation and specs reflect the current implementation by reporting outdated items and conflicting states.

What is the best way to verify progressive disclosure and archiving readiness for repo docs?

The best way to verify archiving readiness is auditing docs to ensure plan and spec links stay current. This surfaces missing links and stale references, confirming active plans align with recent source file changes before archiving.

How do I audit WORK_IN_PROGRESS.md against recent source file changes?

You audit WORK_IN_PROGRESS.md by comparing it alongside linked plan and spec docs against recent code changes. This enforces that progress documentation reflects current implementation and reports any missing or outdated items.

Why does my repository documentation show conflicting states with my specs?

Repository documentation shows conflicting states when active plans and specs are not updated alongside implementation. Auditing docs against code surfaces these misalignments, broken links, and stale references to restore alignment.

Can I use a docs audit to find broken links and missing documentation in my repository?

Yes, you can use a docs audit to find broken links and missing documentation. It compares linked plan and spec docs against source files to identify stale references and missing items that block accurate repository reviews.