doc-maintenance

Audit README, SPEC, and PRODUCT docs against recent git history for drift.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

  • Detects drift between shipped features and documentation for README, SPEC, and PRODUCT.
  • Proposes minimal, non-destructive edits and automates branch/PR workflow.
  • Suitable for periodic maintenance, release rechecks, or pre-PR documentation alignment.

Quick Start

Run the maintenance workflow to audit README, SPEC, and PRODUCT against recent commits and propose 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 audit documentation drift against recent git history?

Documentation drift occurs when shipped features are missing from docs or listed features have already landed. Auditing detects this drift by comparing README, SPEC, and PRODUCT files against recent git history, then proposing minimal edits and opening a pull request to align the documentation.

Can I use this workflow to align docs before opening a pull request?

Yes, running a documentation audit before opening a pull request aligns your README, SPEC, and PRODUCT files with current capabilities. It proposes minimal, non-destructive edits, creates a branch, and opens a PR to ensure documentation accuracy prior to merging.

Does the docs audit workflow modify files directly or create a pull request?

The docs audit workflow creates a pull request rather than modifying files directly. It enforces a safe, auditable workflow by creating a dedicated branch, proposing minimal non-destructive edits to align documentation with shipped features, and opening a PR for review.

What is the best way to detect drift between shipped features and documentation?

The best way to detect drift between shipped features and documentation is running a periodic audit of top-level files like README, SPEC, and PRODUCT against recent git history. This identifies inconsistencies and proposes minimal edits to align docs with shipped capabilities.

When do I need to run a documentation audit for my repository?

Run a documentation audit after major feature merges, on a periodic schedule, or before opening a pull request. This ensures your README, SPEC, and PRODUCT files accurately reflect current capabilities and prevents drift between shipped features and documentation.