Skip to content
Get packs

Doc Maintenance Audit

Checks README and spec docs against recent git commits and opens minimal fix PRs

Source Download skill
Repository
paperclipai/paperclip
Stars
110,078
Licence
MIT
Files
3 files

What it does

Once installed, the agent reviews a project's main documentation (README, SPEC, and PRODUCT files) against recent git history to find places where the docs no longer match the code, such as shipped features still listed as roadmap items or claims that something is unsupported when it now is. It then makes small factual edits on a new branch, opens a pull request with those changes, and records the last reviewed commit so the next run starts from there.

Great for

  • Maintainers of an active open-source or product repo who want docs kept roughly in step with shipped features
  • Teams that run a periodic or post-release documentation review and want a first-pass draft PR
  • Developers who already use git and the GitHub CLI and want the agent to automate doc drift checks

Skip it if

  • Projects without git history or without a GitHub-style PR workflow, since the steps depend on git and the gh command (the skill is written for the Paperclip repo's specific doc paths)
  • Anyone expecting a full documentation rewrite; the skill is designed to make minimal edits and defer larger additions to follow-up work
  • Unattended runs on repos where an automated commit or push to a shared branch is not wanted, since the skill creates branches, commits, pushes, and opens PRs

Try asking

  • “Are our docs up to date? Audit the README and doc/SPEC.md against commits since the last review.”
  • “We just merged the plugin system. Check whether the README roadmap or features table needs updating.”
  • “Run the doc maintenance workflow and open a PR with any accuracy fixes.”
  • “Summarise what code changes since the last review might affect our product docs, without editing anything yet.”
Step-by-step guide: how to use Doc Maintenance AuditInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 3 original files, the MIT licence and an attribution note.

    doc-maintenance.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip doc-maintenance.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip doc-maintenance.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Run it first as a read-only audit (ask for the change summary only) to see what it would change before letting it create a branch and PR.
  • Review the PR diff carefully; the skill classifies commits by keyword and may miss or misjudge changes, so human confirmation is important.
  • Commit the .doc-review-cursor file history alongside the docs so later runs know where the last review ended.

What's inside

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

Redistributed unmodified from paperclipai/paperclip under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.