doc-audit

Audit markdown documentation for frontmatter, link, count, and version issues.

Updated Nov 24, 2025
One-click install
npx skills add https://github.com/ByronWilliamsCPA/.claude --skill doc-audit-byronwilliamscpa
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-audit
Source: https://github.com/ByronWilliamsCPA/.claude/tree/main/.claude/skills/doc-audit
Command: npx skills add https://github.com/ByronWilliamsCPA/.claude --skill doc-audit-byronwilliamscpa

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Manual documentation checks are time-consuming and often miss critical issues like frontmatter schema violations, broken internal links, count claim drift, and stale version references that leave users with outdated or broken content.

Core Features & Use Cases

  • Four-category health scan: Automatically audits markdown documentation for frontmatter errors, broken internal links, mismatched count claims, and outdated version references.
  • Actionable audit reports: Generates a persistent, severity-categorized markdown report with line-specific issue details for fast remediation.
  • Use case: Development teams can run this audit before a documentation release to catch broken links and stale version numbers that would otherwise confuse contributors and end users.

Quick Start

Use the doc-audit skill to run a full health check on all markdown documentation in your project's docs/ directory and receive a clear summary of all issues that need attention.

Frequently Asked Questions about doc-audit

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

FAQPage Schema
How do I scan markdown documentation for broken links and frontmatter errors?

To scan markdown documentation for broken links and frontmatter errors, run an automated health check that detects schema violations, mismatched count claims, and stale version references to generate a severity-categorized audit report.

How do I detect stale version references in technical docs?

You can detect stale version references in technical docs by running an automated documentation audit that flags outdated version numbers and mismatched count claims, ensuring project content remains accurate and accessible for end users.

Can I automate documentation checks before a release?

Yes, you can automate documentation checks before a release by running a full health scan on your docs directory to catch broken internal links, frontmatter violations, and outdated version references that would otherwise confuse contributors.

What is the best way to find broken internal links in project markdown files?

The best way to find broken internal links in project markdown files is using an automated documentation audit tool that generates line-specific issue details within a persistent markdown report for fast remediation.

Does the doc-audit skill flag broken documentation builds on the main branch?

Yes, the doc-audit skill flags broken documentation builds on the main branch by automating the detection of frontmatter violations, broken internal links, count claim drift, and stale version references during pre-release validation.