doc-maintenance

Scan top-level documentation for drift against git history and open PRs.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the process of auditing and updating top-level documentation to ensure it remains accurate after major feature merges or on a periodic schedule.

Core Features & Use Cases

  • Automated Audit: Scans documentation for drift and proposes minimal edits.
  • Branch Creation: Automatically creates a branch for proposed changes.
  • PR Opening: Opens a pull request with updates for review.
  • Use Case: Use this Skill after a major feature merge to ensure the documentation reflects the latest features and changes.

Quick Start

Run the doc-maintenance skill to update documentation accuracy.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I automate documentation updates after a major git merge?▼

Automated documentation updates scan top-level docs for drift against recent git history, propose minimal edits, create a branch, and open a pull request. Run the process after major feature merges to ensure accuracy.

What is documentation drift and how do I detect it in my repository?▼

Documentation drift occurs when top-level docs no longer reflect recent code changes. Automated audits detect this drift by scanning documentation against git history and proposing minimal edits to restore accuracy.

Can I automatically open a pull request for documentation changes?▼

Yes, automated doc maintenance creates a dedicated branch for proposed documentation changes and automatically opens a pull request with the updates for team review.

How do I audit top-level documentation against recent git history?▼

Automated auditing scans top-level documentation to identify drift against recent git history. It processes commits to generate changesets, proposing minimal edits to keep documentation accurate.

Do I need scripts to automate documentation maintenance?▼

Yes, automated documentation maintenance requires scripts for processing recent git commits and generating the changesets needed to propose minimal edits and open pull requests.

When should I run an automated documentation audit?▼

Run an automated documentation audit after a major feature merge or on a periodic schedule to ensure top-level documentation accurately reflects the latest software features and changes.