docs-audit

Audit markdown documentation for broken links, duplication, and verbosity.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/lucasmiachon-blip/aula.cirrose --skill docs-audit-lucasmiachon-blip
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/lucasmiachon-blip/aula.cirrose/tree/main/.claude/skills/docs-audit
Command: npx skills add https://github.com/lucasmiachon-blip/aula.cirrose --skill docs-audit-lucasmiachon-blip

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audits markdown documentation and skill references for links, redundancy, verbosity, and token economy to improve clarity and consistency across documentation.

Core Features & Use Cases

  • Link validation: checks for valid relative paths and cross-refs.
  • Redundancy detection: identifies duplicated content and conflicting statements across docs.
  • Verbosity control: flags overly long sections and suggests concise wording.
  • Token economy guidance: flags time-sensitive data and recommends indexing or references for efficiency.

Quick Start

Run an audit on docs/.md and references/.md to produce a structured report with actionable recommendations.

Frequently Asked Questions about docs-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 redundancy across multiple repos?

Markdown documentation auditing detects broken links, content duplication, verbosity, and inefficient token usage across large documentation sets. It validates relative paths and cross-refs, flags overly long sections, and identifies time-sensitive data to recommend indexing for better token economy.

How do I check token economy and verbosity in my docs before a long review session?

You can audit markdown docs across large documentation sets including knowledge bases and references/ directories. The process supports batch processing with Grep and Read tools, making it suitable for checking extensive file collections before reviews or long sessions.

What is the best way to validate relative paths and cross-refs in markdown files?

Markdown auditing distinguishes itself by combining link validation, redundancy detection, verbosity control, and token economy guidance in a single pass. Unlike basic link checkers, it identifies duplicated content and conflicting statements across docs while recommending indexing for time-sensitive data.

Can I batch process large documentation sets to detect conflicting statements and duplication?

Markdown auditing is limited to text-based analysis of documentation files and cannot execute or validate code snippets dynamically. It focuses on detecting broken links, verbosity, redundancy, and token economy issues, producing recommendations rather than automatically rewriting or fixing the content.