doc-maintenance

Audit README, SPEC, and PRODUCT against recent commits and open a PR with minimal edits.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/windingriverholdings/paperclip --skill doc-maintenance-windingriverholdings
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/windingriverholdings/paperclip/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/windingriverholdings/paperclip --skill doc-maintenance-windingriverholdings

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit top-level documentation (README, SPEC, PRODUCT) against recent git history to find drift — shipped features missing from docs or features listed as upcoming that already landed. Proposes minimal edits, creates a branch, and opens a PR. Use when asked to review docs for accuracy, after major feature merges, or on a periodic schedule.

Core Features & Use Cases

  • Detect changes since the last review, classify changes into Feature/Breaking/Structural.
  • Build a concise change summary and patch target docs using minimal edits.
  • Create a branch, commit changes, and open a PR with a standardized body referencing the audit checklist.

Quick Start

Run the doc maintenance workflow to audit changes and open a PR with drift-correcting edits.

Frequently Asked Questions about doc-maintenance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit documentation drift after merging new features?

To audit documentation drift, compare top-level docs like README and SPEC against recent git commits to identify missing or outdated features, then apply minimal edits to correct the discrepancies and open a PR.

What is the best way to keep README and SPEC files synchronized with code changes?

The best way to keep README and SPEC files synchronized is to run periodic audits that classify recent commits into Feature, Breaking, or Structural changes, generate a concise summary, and patch the docs with minimal edits via a PR.

Can I automatically generate pull requests to fix outdated documentation?

Yes, you can automatically generate pull requests to fix outdated documentation by creating a branch, applying minimal drift-correcting edits to target files, and opening a PR with a standardized body referencing an audit checklist.

Does documentation drift detection work for periodic reviews and major feature merges?

Documentation drift detection works for both periodic reviews and major feature merges by detecting changes since the last review, classifying them, and proposing minimal edits to update top-level documents such as README, SPEC, and PRODUCT files.

How do I classify recent commits to update top-level project documentation?

Classify recent commits into Feature, Breaking, or Structural categories to build a concise change summary, then use that classification to apply minimal targeted edits to top-level project documentation files.

When should I run a documentation audit for my repository?

Run a documentation audit when asked to review docs for accuracy, immediately after major feature merges, or on a periodic schedule to ensure top-level documents reflect the current state of shipped features in git history.