skills.rest
googlarz
googlarzCOMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Compare README.md, doc/SPEC.md, and doc/PRODUCT.md against recent commits to detect documentation drift.

3|Updated Apr 11, 2026
Search Tags:#git#workflow#documentation#audit#drift#pull-request
One-click install
npx skills add https://github.com/googlarz/stapler --skill doc-maintenance-googlarz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/googlarz/stapler/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/googlarz/stapler --skill doc-maintenance-googlarz

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

  • Drift detection: compare README.md, doc/SPEC.md, and doc/PRODUCT.md against recent commits to surface outdated or missing content.
  • Minimal edits & PR workflow: propose small, non-destructive edits and generate a patch-ready branch and PR.
  • Scope-aware: applicable for periodic reviews, post-release checks, or on-demand audits.

Quick Start

Run the doc maintenance workflow to audit documentation against recent commits and generate drift-correcting 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 in a git repository?▼

Detect documentation drift by comparing README.md, doc/SPEC.md, and doc/PRODUCT.md against recent git commits to surface shipped features missing from docs or outdated upcoming features.

What is the best way to automatically fix outdated documentation after a feature merge?▼

Automatically fix outdated documentation by running a doc-maintenance workflow that proposes minimal edits, creates a git branch, and opens a pull request to correct drift after feature merges.

How do I audit README and SPEC files against recent commits?▼

Audit README and SPEC files by running a structured workflow that performs change detection and summarization against recent commits, generating patch-ready branches and pull requests for inaccuracies.

Can I schedule periodic reviews to check for documentation drift?▼

Yes, you can schedule periodic reviews to check for documentation drift. The workflow supports scope-aware audits applicable for periodic checks, post-release reviews, or on-demand accuracy validations.

Does the doc audit workflow create destructive edits to existing documentation?▼

No, the doc audit workflow proposes small, non-destructive minimal edits to existing documentation. It generates a patch-ready branch and PR rather than applying destructive changes directly.

Related Skills

Explore More Content & Communication Skills→
priyansh19priyansh19
1

doc-maintenance

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

Community
Advanced
ka2kamaka2kama
2

review-and-merge

Automate pull request review, feedback handling, and merge execution.

Community
Advanced
awinogradovawinogradov
5

run

Automate development workflows from planning through pull request monitoring.

Community
Advanced
luiztrilhaluiztrilha

dunderia-doc-maintenance

Audit MaestrIA documentation against recent code commits and apply corrections.

Community
Intermediate