docs-audit

Audit repository documentation for drift, stale claims, and missing changelog entries.

Updated Apr 14, 2026
One-click install
npx skills add https://github.com/jrmatherly/spacebot --skill docs-audit-jrmatherly
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/jrmatherly/spacebot/tree/main/.claude/skills/docs-audit
Command: npx skills add https://github.com/jrmatherly/spacebot --skill docs-audit-jrmatherly

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many repository documentation files become stale, inconsistent, or incomplete as code, releases, and processes evolve. This Skill provides a systematic, evidence-first audit to uncover incorrect claims, missing changelog entries, broken links, and status drift across user-facing and operational docs so maintainers can prioritize precise fixes.

Core Features & Use Cases

  • Evidence-backed findings: For each issue produce a claim (verbatim quote with file:line), evidence (git output, file listing, or code grep), and a specific remediation recommendation.
  • Scoped auditing: Targets repo-root docs, spaceui docs, package CHANGELOGs, nested CLAUDE.md files, .claude/rules, openspec specs, and other Tier 1/2 files while honoring explicit out-of-scope directories like vendored spacedrive.
  • Release and lifecycle checks: Verify CHANGELOG completeness vs commits and queued changesets, validate version/date claims against manifests, and flag links to gitignored/transient paths.
  • Use case: Run after a merge wave or before a release to produce a prioritized report of incorrect, stale, and missing documentation items.

Quick Start

Run an evidence-backed documentation audit across the repository and produce a prioritized findings report with file and git citations.

Frequently Asked Questions about docs-audit

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

FAQPage Schema
How do I detect documentation drift in a git repository after merges?

Documentation drift is detected by auditing project files against git history and code to find stale claims, missing changelog entries, and unresolved TODOs. The audit produces evidence-backed findings with file:line citations and specific remediation recommendations.

What is the best way to verify changelog completeness before a release?

Changelog completeness is verified by comparing CHANGELOG entries against git commits and queued changesets. The audit validates version and date claims against manifests and flags missing entries to ensure release documentation is accurate and complete.

Can I audit nested CLAUDE.md files and .claude/rules for stale claims?

Nested CLAUDE.md files and .claude/rules are included in the scoped audit. The audit targets repo-root docs, package CHANGELOGs, openspec specs, and other operational docs while honoring explicit out-of-scope directories like vendored spacedrive.

How does an audit report prioritize documentation fixes?

An audit report prioritizes fixes by providing evidence-backed findings with git output, file listings, or code grep evidence for each issue. It produces a prioritized report of incorrect, stale, and missing documentation items with precise remediation recommendations.

Does documentation auditing automatically edit README and changelog files?

Documentation auditing does not automatically edit files. The audit produces evidence-backed findings with verbatim claims, git or filesystem evidence, and specific remediation recommendations without making edits unless explicitly approved by the maintainer.

What should I check to find broken links to gitignored or transient paths in docs?

Broken links to gitignored or transient paths are found during the release and lifecycle checks phase of a documentation audit. The audit validates links within README, spaceui docs, and openspec specs to flag references to non-existent or transient filesystem locations.