doc-audit

Detect and report documentation drift in repository docs as structured markdown reports.

3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/marcoguillermaz/claude-dev-kit --skill doc-audit-marcoguillermaz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-audit
Source: https://github.com/marcoguillermaz/claude-dev-kit/tree/main/packages/cli/templates/tier-m/.claude/skills/doc-audit
Command: npx skills add https://github.com/marcoguillermaz/claude-dev-kit --skill doc-audit-marcoguillermaz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift and quality decay across project docs, including broken links, code-block issues, misaligned ADRs, and outdated stack guidance.

Core Features & Use Cases

  • Static analysis of docs for relative-link resolution, code-block validity, and ADR freshness.
  • D7 stack-specific hints for node-ts, python, and swift, plus cross-checks against README and documentation.
  • Generates a structured markdown report to guide documentation improvements and governance.

Quick Start

Run the doc-audit skill against your docs directory to generate a drift report.

Frequently Asked Questions about doc-audit

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

FAQPage Schema
How do I detect documentation drift across my repository?

Detect documentation drift by running a static audit that parses markdown and frontmatter to identify broken relative links, code-block syntax issues, and outdated ADRs. It produces a structured report without executing external requests.

How do I check markdown files for broken links and code-block syntax issues?

Check markdown files by executing a static documentation audit that uses pattern matching for relative-link resolution and code-block validity. The process yields a structured report detailing these errors without live network requests.

Can I audit architecture decision records for freshness in a static docs directory?

Yes, you can audit architecture decision records (ADRs) for freshness within a static docs directory. The analysis cross-checks ADR files against the README and project documentation to highlight misaligned or outdated decisions.

Does the documentation audit support stack-specific hints for node-ts, python, and swift?

Yes, the documentation audit supports stack-specific hints for node-ts, python, and swift. It cross-checks your repository documentation against technical stack guidance to ensure accuracy across these environments.

What is the best way to find outdated placeholders and doc hints without executing external requests?

The best way to find outdated placeholders and doc hints is using a static analysis audit. It evaluates repository documentation through markdown parsing and pattern matching, ensuring no external requests are executed during the review.

What are the limitations of using static analysis for repository documentation governance?

A limitation of static documentation analysis is that it operates exclusively on static docs within code repositories and does not execute external requests. It relies entirely on markdown parsing and pattern matching to identify drift.