skills.rest
mighty-hq
mighty-hqCOMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Audit top-level documentation drift against recent git history and open a PR.

Updated Mar 15, 2026
Search Tags:#documentation drift#product messaging#accuracy check#spec validation#release documentation#git history audit
One-click install
npx skills add https://github.com/mighty-hq/mighty-paperclip --skill doc-maintenance-mighty-hq
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/mighty-hq/mighty-paperclip/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/mighty-hq/mighty-paperclip --skill doc-maintenance-mighty-hq

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Prevent documentation drift by auditing top-level docs against recent code changes, ensuring shipped capabilities aren’t missing and “coming soon” or “not supported” claims don’t linger after release.

Core Features & Use Cases

  • Drift detection from git history: Scans commits since the last review cursor to identify notable feature, breaking, and structural changes.
  • Targeted audits of key docs: Checks README.md, doc/SPEC.md, and doc/PRODUCT.md for false negatives, false positives, and quickstart/feature/“works with” accuracy.
  • Minimal, low-churn remediation: Creates a docs-update branch and proposes the smallest factual edits possible, then opens a PR (or just advances the cursor if no edits are needed).
  • Change-driven coverage: Uses the audit checklist and section map to focus review effort on the most likely doc hotspots for each change category.

Quick Start

Ask the agent: “Run doc maintenance to audit README.md, doc/SPEC.md, and doc/PRODUCT.md for drift since the last review, then open a PR with minimal accuracy fixes.”

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I prevent documentation drift after merging code changes?▼

Prevent documentation drift by auditing top-level docs against recent git history, identifying shipped capabilities and lingering claims, then proposing minimal factual edits via a pull request.

How do I audit README and SPEC files for accuracy against commit history?▼

Audit README and SPEC files for accuracy by scanning commit messages and diffs since the last review cursor, classifying notable changes, and checking user-facing claims against an audit checklist and section map.

What is the best way to update product messaging docs after a release?▼

The best way to update product messaging docs after a release is to run a change-driven audit that identifies false negatives and lingering claims, then applies low-churn remediation through a docs-update branch and PR.

Does documentation drift detection work for post-merge and periodic review workflows?▼

Documentation drift detection works for both post-merge and periodic review workflows by comparing recent git history against README.md, doc/SPEC.md, and doc/PRODUCT.md to find structural changes affecting user-facing claims.

Can I automate spec validation and accuracy checks to open a PR with minimal edits?▼

You can automate spec validation and accuracy checks to create a docs-update branch, propose the smallest factual edits possible, open a PR with the fixes, and advance the review cursor if no edits are needed.

Related Skills

Explore More Content & Communication Skills→
srirajksrirajk

Git Risk Analysis

Analyze git history to produce a structured PR risk profile.

Community
Advanced
khoabdkhoabd

doc-maintenance

Detect documentation drift and generate minimal factual edits via pull requests.

Community
Intermediate
christopher-busschristopher-buss
6

review

Review code changes against coding standards and project specifications.

Community
Intermediate
manuelbrandner85manuelbrandner85

dart-fix-runtime-errors

Resolve Dart static analysis errors and runtime type mismatches.

Community
Intermediate