doc-maintenance

Detect documentation drift and open a PR with minimal edits.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/Avishai-Tsabari/agents_manager --skill doc-maintenance-avishai-tsabari
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/Avishai-Tsabari/agents_manager/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/Avishai-Tsabari/agents_manager --skill doc-maintenance-avishai-tsabari

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit and fix documentation drift between code and docs by proposing minimal edits, creating a branch, and opening a PR to align README, SPEC, and PRODUCT after changes.

Core Features & Use Cases

  • Detect drift across top-level docs (README, doc/SPEC.md, doc/PRODUCT.md) against recent commits.
  • Propose minimal, non-destructive edits to restore accuracy without rewrites.
  • Automatically create a feature branch and open a PR to apply fixes after major releases or on a periodic schedule.

Quick Start

Run a doc-maintenance audit to scan the repository for drift and generate a PR with suggested changes.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I keep my README and SPEC documentation in sync with recent code commits?▼

To keep documentation in sync with code, this Skill audits recent commits against README, SPEC, and PRODUCT files to detect drift. It then proposes minimal edits and opens a pull request with the suggested changes.

Can I automatically fix documentation drift after merging a major feature?▼

Yes, you can automatically fix documentation drift after major feature merges. The Skill operates on demand or on a periodic schedule, creating a feature branch and opening a PR with non-destructive edits to align your docs.

What is the best way to audit top-level project documents for outdated information?▼

The best way to audit top-level project documents is to compare recent repository commits against target files like README, doc/SPEC.md, and doc/PRODUCT.md. This process aggregates a precise change summary for reviewer approval.

Does the documentation update process rewrite my entire README and SPEC files?▼

No, the documentation update process does not rewrite your files. It proposes minimal, non-destructive edits to restore accuracy, ensuring your README and SPEC documents remain structurally intact while fixing drift.

How do I schedule periodic documentation audits for my repository?▼

You can schedule periodic documentation audits by running the Skill on a recurring basis. It will automatically scan for drift between your code and docs, then create a branch and open a PR with the necessary alignment changes.

Why does documentation drift occur between product specs and code branches?▼

Documentation drift occurs when recent code commits modify features without corresponding updates to README, SPEC, or PRODUCT files. This Skill identifies those discrepancies and proposes minimal edits to restore accuracy.