Skip to the rows

agentsclimarketplace

Documentation audit

Skill bg-szy/TOP-SKILLS/skills/marketplace/documentation-audit

全球最大的 Claude Code 技能聚合库 · 收录 3900+ 来自 12+ 来源的技能，提供在线搜索与趋势分析看板 / The world's largest Claude Code skill aggregation hub — 3900+ skills from 12+ sources with online search and trend dashboard

Install

npx -y skills add bg-szy/TOP-SKILLS --skill documentation-audit

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

This skill should be used when verifying documentation claims against codebase reality. Triggers on "audit docs", "verify documentation", "check docs", "docs accurate", "documentation drift", "before release", "after refactor", "docs don't match". Uses two-pass extraction with pattern expansion for comprehensive detection.

SKILL.md

3.5 KB, 801 tokens by cl100k_base, as published. Nobody here has run it

Documentation Audit

Systematically verify claims in documentation against the actual codebase using a two-pass approach.

Overview

Core principle: Low recall is worse than false positives—missed claims stay invisible.

Two-pass process:

Pass 1: Extract and verify claims directly from docs
Pass 2A: Expand patterns from false claims to find similar issues
Pass 2B: Compare codebase inventory vs documented items (gap detection)

Quick Start

Identify target docs (user-facing only, skip plans/, audits/)
Note current git commit for report header
Run Pass 1 extraction using parallel agents (one per doc)
Analyze false claims for patterns
Run Pass 2 expansion searches
Generate docs/audits/AUDIT_REPORT_YYYY-MM-DD.md

Claim Types

Type	Example	Verification
`file_ref`	`scripts/foo.py`	File exists?
`config_default`	"defaults to 'AI Radio'"	Check schema/code
`env_var`	`STATION_NAME`	In .env.example + code?
`cli_command`	`--normalize` flag	Script supports it?
`behavior`	"runs every 2 minutes"	Check timers/code

Verification confidence:

Tier 1 (auto): file_ref, config_default, env_var, cli_command
Tier 2 (semi-auto): symbol_ref, version_req
Tier 3 (human review): behavior, constraint

Pass 2 Pattern Expansion

After Pass 1, analyze false claims and search for similar patterns:

Dead script found: diagnose_track_selection.py
  → Search: all script references → Found 8 more dead scripts

Wrong interval: "every 10 seconds"
  → Search: "every \d+ (seconds?|minutes?)" → Found 3 more

Wrong service name: ai-radio-break-gen.service
  → Search: service/timer names → Found naming inconsistencies

Common patterns to always check:

Dead scripts: scripts/*.py references
Timer intervals: every \d+ (seconds?|minutes?)
Service names: ai-radio-*.service, *.timer
Config vars: RADIO_* environment variables
CLI flags: --flag patterns in bash blocks

Output Format

Generate docs/audits/AUDIT_REPORT_YYYY-MM-DD.md:

# Documentation Audit Report
Generated: YYYY-MM-DD | Commit: abc123

## Executive Summary
| Metric | Count |
|--------|-------|
| Documents scanned | 12 |
| Claims verified | ~180 |
| Verified TRUE | ~145 (81%) |
| **Verified FALSE** | **31 (17%)** |

## False Claims Requiring Fixes
### CONFIGURATION.md
| Line | Claim | Reality | Fix |
|------|-------|---------|-----|
| 135 | `claude-sonnet-4-5` | Actual: `claude-3-5-sonnet-latest` | Update |

## Pattern Summary
| Pattern | Count | Root Cause |
|---------|-------|------------|
| Dead scripts | 9 | Scripts deleted, docs not updated |

## Human Review Queue
- [ ] Line 436: behavior claim needs verification

Detailed References

For execution checklist and anti-patterns: checklist.md For claim extraction patterns: extraction-patterns.md

What ships with it: 3 files

38.1 KB alongside SKILL.md

Keep looking

Skills are one crate of 326,984. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.