documenting-with-audit

Audit CLAUDE.md coverage and freshness across repositories.

1|Updated Oct 21, 2025
One-click install
npx skills add https://github.com/bryonjacob/aug --skill documenting-with-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenting-with-audit
Source: https://github.com/bryonjacob/aug/tree/main/aug-dev/skills/documenting-with-audit
Command: npx skills add https://github.com/bryonjacob/aug --skill documenting-with-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Documentation Auditing Skill helps maintain CLAUDE.md coverage across a codebase, prevent documentation drift, and guide structural improvements for clearer AI context.

Core Features & Use Cases

  • CLAUDE.md Coverage Tracking: monitors key docs and flags gaps to improve the fidelity of AI context.
  • Freshness & Scope Management: tracks last updates and applies a scope system to determine what each doc describes.
  • Template-Driven CLAUDE.md Generation: provides templates and guidelines to generate informative CLAUDE.md files when needed.

Quick Start

Run a documentation audit across the repository to generate a report and identify stale or missing CLAUDE.md files.

Frequently Asked Questions about documenting-with-audit

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

FAQPage Schema
How do I audit CLAUDE.md coverage across my codebase?

To audit CLAUDE.md coverage, run a documentation audit across your repository to generate a report identifying stale or missing CLAUDE.md files. The audit monitors key docs and flags gaps to improve the fidelity of AI context.

What is documentation drift and how do I prevent it in my repository?

Documentation drift occurs when project docs become outdated relative to code. Prevent it by using a documentation auditing skill that tracks the freshness of CLAUDE.md files, monitoring their last updates and flagging stale content across modules.

How do I generate CLAUDE.md files for missing documentation?

Generate CLAUDE.md files using template-driven generation guidelines provided by the audit tool. When the audit identifies missing coverage, it supplies templates to help you create informative CLAUDE.md files for clearer AI context.

Do I need a specific configuration file to track documentation scope and freshness?

Yes, you need a .docsaudit.yaml state file to track documentation scope and freshness. The scope system determines what each document describes, while the state file monitors last updates to maintain coverage accuracy across repositories.

Can I apply documentation auditing across multiple modules and repositories?

Yes, documentation auditing applies across repositories and modules to audit CLAUDE.md coverage. It reads the project directory to produce audit outputs, allowing you to monitor documentation health and propose structural improvements throughout your codebase.

What are the limitations of using template-driven documentation auditing?

A limitation of template-driven documentation auditing is that it requires a YAML frontmatter in SKILL.md with name and description fields. Without this configuration, the audit cannot properly execute its coverage tracking and structural improvement proposals.