doc-maintenance

Identifies documentation drift and proposes edits, then creates a branch and PR for review.

Updated Apr 14, 2026
One-click install
npx skills add https://github.com/lucasadcapital-beep/ancora-auto --skill doc-maintenance-lucasadcapital-beep
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/lucasadcapital-beep/ancora-auto/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/lucasadcapital-beep/ancora-auto --skill doc-maintenance-lucasadcapital-beep

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill audits top-level documentation (README, SPEC, PRODUCT) to identify drift between shipped features and what is documented, then proposes minimal edits, creates a branch, and opens a PR for corrections. Use when reviews are due after major feature merges or on periodic documentation hygiene.

Core Features & Use Cases

  • Detect documentation drift across core docs (README.md, doc/SPEC.md, doc/PRODUCT.md) and surface discrepancies.
  • Propose minimal, non-disruptive edits to align content with current capabilities.
  • Automate branch creation and PR opening to streamline maintenance.

Quick Start

Instruct the Skill to run a docs accuracy pass and push the resulting PRs.

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 between my README and recent code commits?

To detect documentation drift, you compare current README.md, doc/SPEC.md, and doc/PRODUCT.md files against recent commits. This identifies discrepancies between shipped features and documented capabilities, surfacing areas where docs accuracy has degraded over time.

What is the best way to automatically open pull requests for documentation updates?

The best way to open pull requests for documentation updates is to automate branch creation and PR opening after proposing minimal, non-disruptive edits. This streamlines maintenance by preparing corrections in a review-ready branch without disrupting the main codebase.

How do I run a periodic documentation audit for my repository?

You can run a periodic documentation audit by instructing the system to perform a docs accuracy pass. It compares top-level documentation against recent commits to identify drift, then pushes resulting pull requests with proposed corrections for review.

Can I fix README and SPEC files without disrupting my main codebase?

Yes, you can fix README and SPEC files without disruption by proposing minimal, non-disruptive edits on a separate branch. This approach aligns documentation content with current capabilities while keeping the main codebase stable until the pull request is reviewed and merged.

Does documentation maintenance work for post-release checks?

Documentation maintenance works effectively for post-release checks. After major feature merges, it audits top-level docs like README.md and doc/PRODUCT.md to identify drift between shipped features and documented capabilities, then proposes corrections via pull requests.

When should I avoid automated documentation drift detection?

You should avoid automated documentation drift detection when edits would be disruptive rather than minimal. The approach proposes non-disruptive corrections only, so it may not suit projects requiring major documentation rewrites or structural overhauls rather than alignment edits.