Agent skill

Doc Maintenance

by paperclipai in paperclipai/paperclip

Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits.

MITAuto-check passedDevelopment

Install Doc Maintenance

skills CLI
$ npx skills add paperclipai/paperclip --skill doc-maintenance -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install paperclipai/paperclip doc-maintenance --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/paperclipai/paperclip.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/doc-maintenance .claude/skills/doc-maintenance && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
doc-maintenance
GitHub stars
99k
Token cost
~1.6k tokens
SKILL.md length
662 words
Files
3 (incl. references)
Skills in repo
60
Repo updated
First seen
Licence
MIT

At a glance

Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits.

  • Works in 7 steps: Detect what changed → Classify changes → Build a change summary → …
  • Asked to review docs for accuracy
  • SKILL.md covers When to Use, Target Documents, Workflow and Change Classification Rules, plus 2 more sections
  • Calls git and gh

What it does

Doc Maintenance is an agent skill from paperclipai/paperclip. 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.

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/audit-checklist.md` and `references/section-map.md`).

It sits in Development, covering Git workflow and Technical documentation. The repository describes itself as: The open-source app everyone uses to manage agents at work. The licence is MIT.

When your agent uses it

  • Asked to review docs for accuracy
  • After major feature merges

Example prompts

  • “/doc-maintenance”

Workflow steps

7 steps, taken from the step headings in SKILL.md.

  1. Detect what changed
  2. Classify changes
  3. Build a change summary
  4. Audit each target doc
  5. Create branch and apply minimal edits
  6. Open a PR
  7. Update the cursor

What it can do on your machine

Read from SKILL.md and the folder at commit 3ec7309. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • gh

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git and gh, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Doc Maintenance loads about 1.6k tokens when it runs, and up to ~2.7k if it reads all its reference files. Until then it costs about 53 tokens; SKILL.md has 662 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~53
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from paperclipai/paperclip at commit 3ec7309, republished under its MIT licence (© paperclipai). 662 words, ~1,648 tokens.

Download SKILL.mdSave it as .claude/skills/doc-maintenance/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
doc-maintenance
description
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.

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

DocumentPathWhat matters
READMEREADME.mdFeatures table, roadmap, quickstart, "what is" accuracy, "works with" table
SPECdoc/SPEC.mdNo false "not supported" claims, major model/schema accuracy
PRODUCTdoc/PRODUCT.mdCore 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 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:

Since last review (<sha>, <date>):
- FEATURE: Plugin system merged (runtime, SDK, CLI, slots, event bridge)
- FEATURE: Project archiving added
- BREAKING: Removed legacy webhook adapter
- STRUCTURAL: New .agents/skills/ directory convention

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. Feature table accuracy — does the features section reflect current capabilities? (README only)
  5. Works-with accuracy — are supported adapters/integrations listed correctly?

Use references/audit-checklist.md as the structured checklist. Use references/section-map.md to know where to look for each feature area.

Step 5 — Create branch and apply minimal edits
bash
# Create a branch for the doc updates
BRANCH="docs/maintenance-$(date +%Y%m%d)"
git checkout -b "$BRANCH"

Apply only the edits needed to fix drift. Rules:

  • Minimal patches only. Fix inaccuracies, don't rewrite sections.
  • Preserve voice and style. Match the existing tone of each document.
  • No cosmetic changes. Don't fix typos, reformat tables, or reorganize sections unless they're part of a factual fix.
  • No new sections. If a feature needs a whole new section, note it in the PR description as a follow-up — don't add it in a maintenance pass.
  • Roadmap items: Move shipped features out of Roadmap. Add a brief mention in the appropriate existing section if there isn't one already. Don't add long descriptions.
Show full SKILL.md (236 more words)Show less
Step 6 — Open a PR

Commit the changes and open a PR:

bash
git add README.md doc/SPEC.md doc/PRODUCT.md .doc-review-cursor
git commit -m "docs: update documentation for accuracy

- [list each fix briefly]

Co-Authored-By: Paperclip <noreply@paperclip.ing>"

git push -u origin "$BRANCH"

gh pr create \
  --title "docs: periodic documentation accuracy update" \
  --body "$(cat <<'EOF'
## Summary
Automated doc maintenance pass. Fixes documentation drift detected since
last review.

### Changes
- [list each fix]

### Change summary (since last review)
- [list notable code changes that triggered doc updates]

## Review notes
- Only factual accuracy fixes — no style/cosmetic changes
- Preserves existing voice and structure
- Larger doc additions (new sections, tutorials) noted as follow-ups

🤖 Generated by doc-maintenance skill
EOF
)"
Step 7 — Update the cursor

After a successful audit (whether or not edits were needed), update the cursor:

bash
git rev-parse HEAD > .doc-review-cursor

If edits were made, this is already committed in the PR branch. If no edits were needed, commit the cursor update to the current branch.

Change Classification Rules

SignalCategoryDoc update needed?
feat:, add, implement, support in messageFeatureYes if user-facing
remove, drop, breaking, !: in messageBreakingYes
New top-level directory or config fileStructuralMaybe
fix:, bugfixFixNo (unless it changes behavior described in docs)
refactor:, chore:, ci:, test:MaintenanceNo
docs:Doc changeNo (already handled)
Dependency bumps onlyMaintenanceNo

Patch Style Guide

  • Fix the fact, not the prose
  • If removing a roadmap item, don't leave a gap — remove the bullet cleanly
  • If adding a feature mention, match the format of surrounding entries (e.g. if features are in a table, add a table row)
  • Keep README changes especially minimal — it shouldn't churn often
  • For SPEC/PRODUCT, prefer updating existing statements over adding new ones (e.g. change "not supported in V1" to "supported via X" rather than adding a new section)

Output

When the skill completes, report:

  • How many commits were scanned
  • How many notable changes were found
  • How many doc edits were made (and to which files)
  • PR link (if edits were made)
  • Any follow-up items that need larger doc work

© paperclipai, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in .agents/skills/doc-maintenance of paperclipai/paperclip.

  • SKILL.md
  • references/audit-checklist.md
  • references/section-map.md

Open the folder on GitHubat commit 3ec7309

Compare with similar skills

Doc Maintenance next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Doc Maintenance compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Doc Maintenance this skillpaperclipai/paperclip99k—~1.6kAutomated safety check: PassMIT
Update DocsArcReel/ArcReel5.4k—~544Automated safety check: NotesAGPL-3.0
Docs Update from DiffQwenLM/qwen-code28k—~1.1kAutomated safety check: PassApache-2.0
Facade YARD Documentation Rulesruby-git/ruby-git1.8k—~5kAutomated safety check: PassMIT
GitHub Code ReviewRedWoodOG/Hermes-Desktop1775 repos~3.4kAutomated safety check: NotesMIT
Wf Spec Wrapupchangkun/wallfacer112—~2.4kAutomated safety check: PassMIT

Similar skills

  • Update Docs

    ArcReel/ArcReel

    根据最近的 git 改动,更新面向用户的文档(README 双语、入门教程、部署、剪映导出等)。手动调用. An agent skill from ArcReel/ArcReel.

    5.4k GitHub stars~544 tokensUpdated yesterday
    DevelopmentAuto-check: notes
  • Docs Update from Diff

    QwenLM/qwen-code

    Reads local git changes and updates only the matching docs pages, so documentation stays in sync with uncommitted or recent code changes.

    28k GitHub stars~1.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Sets facade-specific YARD documentation rules for the Git::Repository public API, layered on the gem's general YARD skill.

    1.8k GitHub stars~5k tokensUpdated 8 days ago
    DevelopmentAuto-check passed
  • GitHub Code Review

    RedWoodOG/Hermes-Desktop

    Review code changes by analyzing git diffs, leaving inline comments on PRs, and performing thorough pre-push review.

    177 GitHub starsUsed in 5 repos~3.4k tokens
    DevelopmentAuto-check: notes
  • Wf Spec Wrapup

    changkun/wallfacer

    Close out a finished spec: write the Outcome section, move the status through the testing gate to complete, update specs/README.md, and commit.

    112 GitHub stars~2.4k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Fantasia Final Cleanup

    vishiri/fantasia-archive

    End-of-batch ship workflow for Fantasia Archive: run full yarn testbatch:verify (not dev scoped gate), fix failures, sync README/AGENTS/rules/skills from Git changes, update in-app changelog, split…

    409 GitHub stars~1.2k tokensUpdated 2 days ago
    DevelopmentAuto-check passed

More from paperclipai/paperclip

All 60 skills in this repo
  • Garden Inbox

    paperclipai/paperclip

    Scan a Paperclip user's Mine inbox, classify reversible archive candidates, request checkbox confirmation, and archive only accepted selections.

    99k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Paperclip

    paperclipai/paperclip

    Interact with the Paperclip control plane API for task coordination and governance.

    99k GitHub stars~9.6k tokensUpdated today
    Auto-check passed
  • Paperclip

    paperclipai/paperclip

    A skill your agent uses for Paperclip-managed tasks and heartbeats: reading task context, delivering task documents or files, updating completion or blockers, coordinating or delegating work, and…

    99k GitHub stars~17k tokensUpdated today
    Auto-check passed
  • Design Guide

    paperclipai/paperclip

    Paperclip UI design system guide for building consistent, reusable frontend components.

    99k GitHub starsUsed in 1 repo~3.1k tokens
    Auto-check passed
  • Paperclip Page

    paperclipai/paperclip

    Publish static HTML pages and asset folders to the Paperclip S3/CloudFront page host.

    99k GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Paperclip Create Agent

    paperclipai/paperclip

    Create new agents in Paperclip with governance-aware hiring.

    99k GitHub starsUsed in 1 repo~2.1k tokens
    Auto-check passed

Categories

Questions about Doc Maintenance

What does Doc Maintenance do?

Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits. Doc Maintenance is an agent skill from paperclipai/paperclip. Audit README, SPEC, and PRODUCT docs against recent git history for drift and make minimal PR-ready edits.

When should I use Doc Maintenance?

Doc Maintenance fits situations like: asked to review docs for accuracy; after major feature merges.

How do I install Doc Maintenance in Claude Code?

Run `npx skills add paperclipai/paperclip --skill doc-maintenance -a claude-code`. Or copy the skill folder (.agents/skills/doc-maintenance in paperclipai/paperclip) into .claude/skills/doc-maintenance in your project. Claude Code loads it when a task matches its description.

How do I install Doc Maintenance in Codex?

Run `npx skills add paperclipai/paperclip --skill doc-maintenance -a codex`. Or copy the skill folder (.agents/skills/doc-maintenance in paperclipai/paperclip) into .agents/skills/doc-maintenance in your project. Codex loads it when a task matches its description.

Can I use Doc Maintenance in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add paperclipai/paperclip --skill doc-maintenance -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-maintenance, .gemini/skills/doc-maintenance, .github/skills/doc-maintenance and .opencode/skills/doc-maintenance in your project.

What does Doc Maintenance need to run?

Going by SKILL.md and its folder, Doc Maintenance needs the command-line tools its instructions call (git and gh).

Does Doc Maintenance access the network?

SKILL.md contains no URLs. Its commands use git and gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Doc Maintenance safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Doc Maintenance use?

Doc Maintenance is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Doc Maintenance use?

About 1.6k tokens (SKILL.md is roughly 6.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1k tokens, read only when the agent opens those files.

What are the alternatives to Doc Maintenance?

Skills that share tags, products or a category with Doc Maintenance: Update Docs (ArcReel/ArcReel, 5.4k stars), Docs Update from Diff (QwenLM/qwen-code, 28k stars), Facade YARD Documentation Rules (ruby-git/ruby-git, 1.8k stars) and GitHub Code Review (RedWoodOG/Hermes-Desktop, 177 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Doc Maintenance?

paperclipai (a GitHub organization) maintains it in paperclipai/paperclip, which has 99,357 GitHub stars. The repository holds 60 skills in this directory. The repository was last updated on October 10, 2026.

Source: paperclipai/paperclip on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.