doc-maintenance

Detect documentation drift against recent git history and open a PR with minimal edits.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps ensure documentation accuracy by comparing current docs to recent commits, surfacing drift between code/features and the user-facing docs.

Core Features & Use Cases

  • Detect documentation drift between README.md, SPEC.md, and PRODUCT.md against recent git history.
  • Propose minimal edits and automate branch creation and PR generation to fix drift.
  • Use after major feature merges or on periodic reviews to keep docs aligned with product reality.

Quick Start

Run the maintenance check to audit README.md, doc/SPEC.md, and doc/PRODUCT.md for drift and open a PR with minimal edits.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I detect documentation drift after a feature release?▼

To detect documentation drift after a feature release, audit target documents like README.md and SPEC.md against recent git history. This process compares code changes to user-facing docs, identifies inconsistencies, and proposes minimal edits to fix inaccuracies.

Can I automatically create a branch and PR to fix outdated docs?▼

Yes, you can automatically create a branch and open a PR to fix outdated docs. The maintenance audit identifies drift between your code and documentation, proposes the necessary minimal edits, and generates a pull request directly from the changes.

What is the best way to audit README and SPEC files for accuracy?▼

The best way to audit README and SPEC files for accuracy is comparing them against recent git commits. This surfaces drift between code modifications and user-facing documentation, allowing you to review and apply minimal corrective edits.

How do I perform a periodic documentation maintenance review?▼

Perform a periodic documentation maintenance review by running an audit check on files such as README.md, doc/SPEC.md, and doc/PRODUCT.md. This compares current docs against recent git history to surface drift and open a PR with proposed fixes.

Why does my documentation show drift from the current codebase?▼

Documentation drift occurs when user-facing docs are not updated after code changes. Running a maintenance audit compares target documents against recent git history to identify these inconsistencies and propose minimal edits for correction.