Skip to content
Get packs

Doc Maintenance

Keeps project docs in sync with recent code changes and drafts release notes

Source Download skill
Repository
paperclipai/paperclip
Stars
110,078
Licence
MIT
Files
1 file

What it does

Once installed, the agent checks what changed in recent commits or pull requests and finds documentation pages that now describe old behavior, such as renamed flags, changed defaults, or outdated examples. It then edits only the lines that need updating, adds missing reference entries, and drafts a grouped release note (Added, Changed, Fixed, Deprecated, Removed). It is guided to avoid rewriting unchanged text so the resulting changes are easy to review.

Great for

  • Engineers who need docs updated after shipping a feature or cutting a release
  • Developer relations or product staff who maintain a project's public documentation
  • Maintainers who want release notes drafted from merged commits

Skip it if

  • Internal-only refactors or renames with no user-visible impact, since the skill itself says not to use it there
  • Open-ended 'improve the docs' requests with no specific behavior change to anchor them, which the skill says need a separate plan first
  • Projects without a commit history or docs source the agent can read, because the skill relies on reviewing commits and doc pages

Try asking

  • “Check the docs against the commits since the last release tag and update anything that changed behavior”
  • “Our new --json flag shipped in this PR; update the CLI reference and add a release note”
  • “Find and fix outdated examples and default values in the configuration docs”
  • “Draft a release note for everything merged since v2.3.0, grouped by Added, Changed, and Fixed”
Step-by-step guide: how to use Doc MaintenanceInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 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

  • Give the agent a clear commit range, such as a release tag or a specific PR, so it knows what to document against.
  • Review the diff yourself: the skill aims for minimal edits, but the agent still needs human checking for accuracy.
  • Ask it to run or verify code examples in your environment, since the skill tells it to re-run examples touching new behavior.

What's inside

  • 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.