skills.rest
rnwolfe
rnwolfeCOMMUNITY
Explore all skills by this author →
Website𝕏@somewolfeGitHub

docs-audit

Audit README.md and STATUS.md against shipped code for documentation drift.

Updated Apr 7, 2026
Search Tags:#documentation#audit#readme#commands#status#drift
One-click install
npx skills add https://github.com/rnwolfe/engram --skill docs-audit-rnwolfe
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/rnwolfe/engram/tree/main/.claude/skills/docs-audit
Command: npx skills add https://github.com/rnwolfe/engram --skill docs-audit-rnwolfe

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit README and STATUS against shipped code — surface documentation drift, then apply targeted edits on approval

Core Features & Use Cases

  • Surface drift across README and docs/internal/STATUS.md by comparing them to shipped code, including missing CLI commands, stale version headers, and mis-labeled plugin statuses.
  • Propose surgical edits that align docs with current shipped features, awaiting human approval.
  • Respect scope boundaries: do not touch CHANGELOG.md, docs/internal/VISION.md, docs/internal/DECISIONS.md, or specs.

Quick Start

Run the docs-audit audit to scan README.md and docs/internal/STATUS.md for drift and propose approved edits.

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 between my README and shipped code?▼

Detecting documentation drift involves scanning README.md and docs/internal/STATUS.md against shipped code to flag missing CLI commands, stale version headers, and mis-labeled plugin statuses. The audit proposes surgical edits for human approval.

What is the best way to keep my README command table aligned with new CLI releases?▼

Keeping README command tables aligned requires auditing them against shipped code to identify missing commands. The audit reads project configuration, tracks the SINCE anchor, and outputs targeted, reviewable edits to align the documentation.

Can I automatically update plugin statuses in STATUS.md from Planned to Shipped?▼

You cannot automatically apply changes, but the audit flags plugins marked as Planned that have shipped. It proposes surgical edits to align STATUS.md with current features, awaiting human approval before any modifications are applied.

Does the documentation audit modify CHANGELOG, VISION, or DECISIONS files?▼

The documentation audit does not modify CHANGELOG.md, VISION.md, DECISIONS.md, or specs. It respects scope boundaries by strictly limiting proposed edits to README.md and docs/internal/STATUS.md files only.

When should I run a documentation audit on my project?▼

You should run a documentation audit when maintaining user-facing docs alongside shipped code. It is ideal for projects needing to surface drift like missing commands, stale version headers, or mis-labeled plugin statuses.

Related Skills

Explore More Content & Communication Skills→
carson-sweetcarson-sweet
6

SweetClaude Init

Initialize SweetClaude project management infrastructure with state directories and traceability maps.

Community
Intermediate
dogeareddogeared

document-release

Align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped code changes.

Community
Intermediate
MJ-AgentLabMJ-AgentLab

doc

Generate README.md and CHANGELOG.md documentation from n8n workflow.json files.

Official
Advanced
dividedbydividedby
1

doc-it

Scan local files to patch stale READMEs, API docs, and CHANGELOGs.

Community
Advanced