doc-maintenance

Audit top-level documentation against recent git history and open a PR with minimal edits.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit top-level documentation (README, SPEC, PRODUCT) against recent git history to find drift — shipped features missing from docs or features listed as upcoming that already landed. Proposes minimal edits, creates a branch, and opens a PR. Use when asked to review docs for accuracy, after major feature merges, or on a periodic schedule.

Core Features & Use Cases

  • Detect documentation drift by comparing README.md, doc/SPEC.md, and doc/PRODUCT.md with recent commits.
  • Build concise change summaries highlighting discrepancies and alignment gaps.
  • Create a feature branch and open a PR with minimal, fact-based edits to restore accuracy.

Quick Start

Run the doc-maintenance skill to audit documentation drift and propose minimal drift fixes.

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 shipped features and my README?

Documentation drift is detected by auditing top-level files like README.md, doc/SPEC.md, and doc/PRODUCT.md against recent git history. This process identifies shipped features missing from docs or features incorrectly listed as upcoming, generating a concise change summary of discrepancies.

How do I automatically create a PR to fix outdated docs after a release?

Automatically fixing outdated docs involves a structured workflow that detects changes, builds a concise change summary, creates a feature branch, and opens a pull request with minimal, fact-based edits to restore accuracy after major feature merges.

What is the best way to audit SPEC and PRODUCT docs for accuracy after merging code?

Auditing SPEC and PRODUCT docs for accuracy is best achieved by comparing them against recent commits to find alignment gaps. This targeted review catches discrepancies between shipped features and documented claims, proposing minimal edits to correct the record.

When should I run a documentation health check against my git history?

A documentation health check against git history should be run during periodic reviews after releases, after major feature merges, or on a scheduled basis. This ensures top-level documentation accurately reflects the current state of shipped features.

Can I review README drift and open a pull request without manual editing?

Yes, reviewing README drift and opening a pull request without manual editing is possible. The workflow detects discrepancies, proposes minimal fact-based edits, creates a feature branch, and opens a PR automatically, restoring accuracy without direct human intervention.