skills.rest
mbriggsy
mbriggsyCOMMUNITY
Explore all skills by this author →
GitHub

doc-audit

Audit markdown files with five parallel agents and produce a risk-scored report.

Updated Feb 22, 2026
Search Tags:#documentation#markdown#consistency#audit#quality#duplication#link-check
One-click install
npx skills add https://github.com/mbriggsy/ai-learning-journey --skill doc-audit-mbriggsy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-audit
Source: https://github.com/mbriggsy/ai-learning-journey/tree/main/projects/skills/doc-audit
Command: npx skills add https://github.com/mbriggsy/ai-learning-journey --skill doc-audit-mbriggsy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the quality assurance of Markdown documentation by auditing projects for broken links, stale content, misplaced sections, duplication, and presentation inconsistencies, delivering a consolidated report and actionable fixes.

Core Features & Use Cases

  • Multi-agent audit: runs five specialized sub-agents in parallel to analyze documentation across a project.
  • Comprehensive checks: detects broken links, outdated references, content gaps, duplicate information, and conflicts in style or presentation.
  • Actionable reporting: emits a merged Doc Audit Report highlighting severity, grouped by file, with recommended fixes for reviewers.
  • Reviewer workflow: supports approval-before-change workflow to prevent unintended edits.
  • Use cases: maintain healthy docs in large repos, onboard new contributors with reliable documentation, and enforce documentation standards.

Quick Start

Synthesize a doc audit by running the skill on a project to generate a unified report and proposed edits.

Frequently Asked Questions about doc-audit

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

FAQPage Schema
How do I audit markdown documentation for broken links and stale content?▼

To check markdown documentation for duplication and presentation inconsistencies, a multi-agent audit scans project files in parallel to detect style conflicts, duplicate information, and misplaced sections, generating a consolidated report with recommended fixes for reviewer approval.

What is the best way to enforce documentation consistency across a large repository?▼

Documentation quality auditing works by deploying five specialized sub-agents in parallel to analyze markdown files across a project, checking for broken links, outdated references, and misplaced sections, then merging the findings into a risk-scored report for reviewers.

Can I review proposed documentation fixes before they are applied to my project?▼

Yes, you can use this documentation audit for onboarding new contributors because it maintains healthy docs in large repos by detecting content gaps and outdated references, ensuring reliable documentation standards are enforced before contributors rely on them.

What types of documentation issues can an automated markdown audit detect?▼

Documentation quality auditing works by deploying five specialized sub-agents in parallel to analyze markdown files across a project, checking for broken links, outdated references, and misplaced sections, then merging the findings into a risk-scored report for reviewers.

Related Skills

Explore More Content & Communication Skills→
mol4mol4
1

bmad-document-project

Document brownfield repositories into structured markdown project knowledge.

Community
Advanced
harshitsinghbhandariharshitsinghbhandari
2

architecture-audit

Analyze architecture Markdown files to generate an audit report and prioritized improvements roadmap.

Community
Advanced
lailtonjuniorlailtonjunior

Pr Review

Automate pull request reviews to enforce team standards and best practices across Git workflows.

Community
Intermediate
zhizhunbaozhizhunbao

dev-markdown_check

Validate and correct Markdown formatting, syntax, and structure with Python scripts and linters.

Community
Intermediate