doc-maintenance

Featured

Audit README 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.

AI & Automation 114,742 stars 19046 forks Updated today MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 / PRODUCT accuracy ## Target Documents | Document | Path | What matters | |----------|------|-------------| | README | `README.md` | Features table, roadmap, quickstart, "what is" accuracy, "works with" table | | 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: ```bash # Read the last-reviewed commit SHA CURSOR_FILE=".doc-review-cursor" if [ -f "$CURSOR_FILE" ]; then LAST_SHA=$(cat "$CURSOR_FILE" | head -1) else # First run: look back 60 days LAST_SHA=$(git log --format="%H" --after="60 days ago" --reverse | head -1) fi ``` Then gather commits since the cursor: ```bash git log "$LAST_SHA"..HEAD --oneline --no-merges ``` ### 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 adapt...

Details

Author
paperclipai
Repository
paperclipai/paperclip
Created
8 months ago
Last Updated
today
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category