Agent skill · writing content · paperclipai
doc-maintenance
Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits. Use when asked to review docs for accuracy, after major feature merges, or on a schedule.
Why this skill is useful
Adds a structured workflow for auditing and updating documentation that the AI wouldn't reliably generate on its own.
What it needs
About 4k tokens when loaded. Last updated 2026-08-07. 75,771 stars on the source repository.
What this skill does
Doc Maintenance Skill Detect documentation drift and fix it via PR — no rewrites, no churn. When to Use Periodic doc review (e.g. weekly or after releases) After major feature merges When asked "are our docs up to date?" When asked to audit README / SPEC / PRODUCT accuracy Target Documents Document Path What matters ---------- ------ ------------- README README.md Features table, roadmap, quickstart, "what is" accuracy, "works with" table SPEC doc/SPEC.md No false "not supported" claims, major model/schema accuracy PRODUCT doc/PRODUCT.md Core concepts, feature list, principles accuracy Out of scope: DEVELOPING.md, DATABASE.md, CLI.md, doc/plans/, skill files, release notes. These are dev-facing or ephemeral — lower risk of user-facing confusion. Workflow Step 1 — Detect what changed Find the last review cursor: Then gather commits since the cursor: Step 2 — Classify changes Scan commit messages and changed files. Categorize into: Feature — new capabilities (keywords: feat, add, implement, support) Breaking — removed/renamed things (keywords: remove, breaking, drop, rename) Structural — new directories, config changes, new adapters, new CLI commands Ignore: refactors, test-only changes, CI config, dependency bumps, doc-only changes, style/formatting commits. These don't affect doc accuracy. For borderline cases, check the actual diff — a commit titled "refactor: X" that adds a new public API is a feature. Step 3 — Build a change summary Produce a concise list like: If there are no notable changes, skip to Step 7 (update cursor and exit). Step 4 — Audit each target doc For each target document, read it fully and cross-reference against the change summary. Check for: 1. False negatives — major shipped features not mentioned at all 2. False positives — features listed as "coming soon" / "roadmap" / "planned" / "not supported" / "TBD" that already shipped 3. Quickstart accuracy — install commands, prereqs, and startup instructions still correct (README only) 4. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills paperclipai/doc-maintenance