doc-maintenance

Detects outdatedness in docs by comparing them to git commit history.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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

  • Automated drift detection: compares docs to recent changes and flags inconsistencies.
  • Change-driven recommendations: suggests minimal edits and branch/PR automation.
  • Workflow automation: creates a maintenance branch and PR draft to fix drift.

Quick Start

Automatically scan for documentation drift and propose minimal edits via a maintenance branch and PR.

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 merging a new feature?

Detect documentation drift by comparing top-level repository docs against recent git history. The audit identifies shipped features missing from README or SPEC files and flags inconsistencies, ensuring documentation accuracy without manual review.

Can I automate creating a maintenance branch and PR for documentation updates?

Yes, you can automate documentation updates by creating a maintenance branch and opening a draft PR. This workflow proposes minimal edits to fix drift detected in repository docs, streamlining the review process for documentation changes.

What is the best way to audit top-level docs against repo history for accuracy?

The best way to audit top-level docs for accuracy is to scan repository history for recent feature merges and compare them against existing documentation. This automated drift detection ensures documentation matches the actual codebase state.

Does the documentation audit modify non-documentation files in the repository?

No, the documentation audit applies strict rules to avoid changes to non-documentation files. It only proposes minimal edits to top-level documentation files like README and SPEC, ensuring source code remains untouched during the maintenance process.

When do I need to run a documentation drift audit?

You need to run a documentation drift audit after major feature merges, when asked to review docs for accuracy, or on a periodic schedule. This ensures your top-level repository documentation stays synchronized with the actual codebase.