skills.rest
nabitllc
nabitllcOFFICIAL
Explore all skills by this author →
GitHub

doc-maintenance

Audit README, SPEC, and PRODUCT docs against git history and open PRs with minimal accuracy fixes.

Updated Mar 26, 2026
Search Tags:#git#documentation#markdown#pull request#drift detection#audit#github cli
One-click install
npx skills add https://github.com/nabitllc/todero --skill doc-maintenance-nabitllc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/nabitllc/todero/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/nabitllc/todero --skill doc-maintenance-nabitllc

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 stale claims, outdated roadmaps, and false "not supported" statements that mislead users. ## Core Features & Use Cases - Drift Detection: Scans git history since a stored review cursor and classifies commits as features, breaking changes, or structural changes worth documenting. - Targeted Audits: Cross-references README.md, doc/SPEC.md, and doc/PRODUCT.md against the change summary using a structured checklist and section map. - Minimal PR-Ready Edits: Applies only factual fixes on a dedicated branch and opens a GitHub PR via gh, preserving existing voice and structure. - Use Case: After a release merges a plugin system and project archiving, run the skill to move those items out of the Roadmap, update the features table, and open a docs PR automatically. ## Quick Start Ask the agent to audit the README, SPEC, and PRODUCT docs for accuracy against recent commits 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 commits?▼

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 false negatives and stale roadmap items for correction.

How to automate documentation updates after feature merges?▼

Use a git-history-driven audit workflow that scans commits since a stored cursor SHA, cross-references target docs, applies minimal factual edits on a branch, and opens a pull request with the gh CLI.

What documents does the doc audit cover?▼

The audit targets README.md, doc/SPEC.md, and doc/PRODUCT.md. Development docs like DEVELOPING.md, DATABASE.md, CLI.md, and release notes are explicitly out of scope as lower-risk internal files.

Does the doc maintenance skill rewrite documentation sections?▼

No, it applies only minimal factual patches to fix drift. It preserves existing voice and structure, avoids cosmetic changes, and notes larger additions like new sections as follow-ups in the PR description.

What tools are required to run a git-based doc audit?▼

The workflow requires git for commit history and branch management, plus the GitHub CLI (gh) to create pull requests. No external packages or scripts are needed beyond standard shell commands.

Related Skills

Explore More Software Engineering Skills→
Lionad-MorotarLionad-Morotar
7

rebase-commits

Consolidates fragmented Git commits into logical units with optimized messages.

Community
Intermediate
supercent-iosupercent-io

changelog-maintenance

Generate release notes and migration guides following Keep a Changelog and Semantic Versioning.

Official
Intermediate
fabioc-alohafabioc-aloha
1

documentation-quality-assurance

Audit documentation for accuracy, integrity, and currency.

Community
Advanced
AstyanMAstyanM
1

api-docs

Generate OpenAPI, Markdown, or Postman documentation from source code.

Community
Advanced