doc-maintenance

Audit documentation drift against git history and open a PR.

1|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/kangnam7654/stapler --skill doc-maintenance-kangnam7654
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/kangnam7654/stapler/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/kangnam7654/stapler --skill doc-maintenance-kangnam7654

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 identify 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 documentation drift by comparing docs to latest commits.
  • Propose minimal edits and automate branch/PR creation to fix drift.
  • Use Case: After a major feature merge, run maintenance to ensure docs reflect new behavior and capabilities.

Quick Start

Run the doc-maintenance skill to scan for drift, generate minimal edits, and open a 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 against recent git history?

Documentation drift is detected by scanning core docs like README.md and SPEC.md against recent git commits to surface mismatches between shipped features and current documentation. The audit identifies missing updates or outdated references automatically.

What is the best way to fix outdated README and SPEC files after a feature merge?

Fix outdated README and SPEC files by auditing documentation drift and proposing minimal edits. The process creates a dedicated branch and opens a PR directly, ensuring proposed corrections are validated through the standard git review workflow.

Can I automate documentation reviews for post-release corrections?

Automated documentation reviews for post-release corrections are supported by comparing top-level docs against the latest commits and generating a branch with a PR. This enforces minimal edits validated by git history and the defined workflow.

Does this docs audit workflow require any external dependencies?

No external dependencies are required to run the docs audit workflow. It relies entirely on your existing git history and core documentation files to validate changes and propose minimal corrections without needing additional packages or tools.

When should I run a documentation drift audit?

Run a documentation drift audit after major feature merges, during periodic reviews, or when onboarding new team members to keep docs aligned with current features. This ensures top-level documentation accurately reflects recent git history.