skills.rest
adamtpang
adamtpangCOMMUNITY
Explore all skills by this author →
Website𝕏@adamtpangGitHub

doc-maintenance

Audit README, SPEC, and PRODUCT docs against git history and apply minimal PR-ready fixes.

Updated Jun 16, 2026
Search Tags:#documentation#pull request#github#drift detection#git history#docs maintenance#readme audit
One-click install
npx skills add https://github.com/adamtpang/summon.company --skill doc-maintenance-adamtpang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/adamtpang/summon.company/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/adamtpang/summon.company --skill doc-maintenance-adamtpang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation drifts out of sync with shipped code as features merge, leaving READMEs, specs, and product docs with false claims, stale roadmaps, and missing capabilities. This Skill detects that drift automatically and fixes it with minimal, review-ready edits. ## Core Features & Use Cases - Drift Detection: Scans git history since the last review cursor, classifies commits as features, breaking changes, or structural changes, and builds a change summary. - Targeted Audits: Cross-references README.md, doc/SPEC.md, and doc/PRODUCT.md against the change summary using a structured checklist and section map to find false negatives and false positives. - Minimal PR-Ready Edits: Applies only factual fixes on a dedicated branch, preserves existing voice and structure, and opens a GitHub PR with a full change summary. - Use Case: After a major release merges a plugin system and project archiving, run this Skill to confirm the README roadmap no longer lists them as planned, update SPEC claims, and open a docs PR automatically. ## Quick Start Ask the agent to audit the README, SPEC, and PRODUCT docs for accuracy against recent git history and open a PR with any needed fixes.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I check if my README is out of date with recent code changes?▼

Run a doc audit that compares git history since the last review against README content. The Skill classifies commits as features, breaking changes, or structural changes, then flags shipped features missing from the README and roadmap items that already shipped.

How to automate documentation drift detection after feature merges?▼

Use a cursor-based workflow that stores the last-reviewed commit SHA in a .doc-review-cursor file, scans commits since that point, and audits target docs against the change summary. It then applies minimal edits on a branch and opens a GitHub PR.

Which documents does the doc audit cover?▼

It audits README.md, doc/SPEC.md, and doc/PRODUCT.md, checking features tables, roadmaps, quickstart instructions, and model accuracy. DEVELOPING.md, DATABASE.md, CLI.md, and plan files are explicitly out of scope as lower-risk dev-facing docs.

Does the doc maintenance skill rewrite documentation sections?▼

No, it applies only minimal factual fixes and preserves existing voice, structure, and formatting. New sections or large additions are noted as follow-ups in the PR description rather than added during a maintenance pass.

What happens when no documentation changes are needed?▼

If the audit finds no notable drift, the Skill skips edits and only updates the .doc-review-cursor file with the current HEAD commit. This keeps the next review scoped to new changes without creating empty PRs.

Related Skills

Explore More Software Engineering Skills→
luyzkkluyzkk

git-workflow-and-versioning

Enforce conventional commits, atomic save-point commits, and short-lived branches.

Community
Advanced
navyapdh11navyapdh11

pr-report

Analyze a pull request and generate a tutorial-style HTML or Markdown review report.

Community
Advanced
wizelinewizeline

authoring-release-docs

Generate release notes, changelogs, and README files from Jira exports and commit logs.

Official
Intermediate
rahmatullahbossrahmatullahboss

bmad-agent-bmm-tech-writer

Load a technical writer persona to generate and review documentation.

Community
Intermediate