audit-documentation

Audit Markdown documentation for static accuracy and cross-document consistency.

9|1|Updated Jan 8, 2026
One-click install
npx skills add https://github.com/conn-castle/agent-layer --skill audit-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: audit-documentation
Source: https://github.com/conn-castle/agent-layer/tree/main/internal/templates/skills/audit-documentation
Command: npx skills add https://github.com/conn-castle/agent-layer --skill audit-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Identify and fix inconsistencies and inaccuracies in Markdown documentation across the repository to ensure factual alignment and up-to-date references.

Core Features & Use Cases

  • Inventory tracked Markdown files and surface inconsistencies.
  • Validate claims against repository evidence and report issues.
  • Automatically generate a structured audit report and suggested fixes.

Quick Start

Run the audit-documentation skill to scan tracked Markdown files and generate a report at .agent-layer/tmp/audit-documentation.<run-id>.report.md.

Frequently Asked Questions about audit-documentation

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

FAQPage Schema
How do I audit markdown documentation for consistency across a repository?▼

You can audit markdown documentation for consistency by scanning all tracked files to validate static accuracy, verify claim references, and generate a structured report with actionable fixes.

What is cross-document consistency checking for markdown files?▼

Cross-document consistency checking validates claims and references across tracked markdown files to ensure factual alignment and confirm that file existence and external references remain up to date.

How do I validate documentation claims against repository evidence?▼

Validating documentation claims against repository evidence involves scanning tracked markdown files to check static accuracy and verify that referenced files and cross-document claims match actual repository contents.

Can I generate a structured audit report for markdown static analysis?▼

Yes, running a static analysis audit on tracked markdown files produces a structured report with actionable fixes, written to a temporary run-specific markdown file in the agent layer directory.

What's the best way to find broken references and inaccuracies in markdown docs?▼

The best way to find broken references and inaccuracies is to inventory tracked markdown files and apply static validation to surface inconsistencies, generating a report with suggested fixes.

Does the documentation audit apply to all markdown files or only configured scopes?▼

The audit applies to all tracked markdown files and configured scopes, ensuring that static validation and cross-document consistency checks cover the relevant repository documentation.