skills.rest
Lautaro073
Lautaro073COMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Audit top-level documentation against recent git history to detect drift.

Updated Mar 23, 2026
Search Tags:#git-history#documentation-quality#pr-management#docs-audit#branch-workflow#doc-maintenance#documentation-drift
One-click install
npx skills add https://github.com/Lautaro073/zCorvus_agents --skill doc-maintenance-lautaro073
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/Lautaro073/zCorvus_agents/tree/main/AI_Workspace/Agents/Frontend/skills/doc-maintenance
Command: npx skills add https://github.com/Lautaro073/zCorvus_agents --skill doc-maintenance-lautaro073

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit top-level documentation (README, SPEC, PRODUCT) against recent git history to identify drift where features are shipped but not documented or listed as upcoming that already landed. Proposes minimal edits, creates a branch, and opens a PR.

Core Features & Use Cases

  • Detect documentation drift across README.md, doc/SPEC.md, and doc/PRODUCT.md and surface misalignments.
  • Propose minimal, non-destructive edits and create a branch plus PR to fix drift.
  • Support periodic reviews or post-release audits to maintain docs accuracy.

Quick Start

Run the doc-maintenance skill to scan the repository for documentation drift and open a PR with minimal edits.

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 after merging new features?▼

Documentation drift is detected by auditing top-level files like README.md and doc/SPEC.md against recent git history. This surfaces misalignments where features shipped but lack documentation, enabling you to propose minimal edits and open a PR.

What is the best way to audit README and SPEC files for undocumented changes?▼

The best way to audit README and SPEC files for undocumented changes is scanning git history against documentation using a structured checklist. This identifies drift and proposes non-destructive edits via a branch and PR workflow.

How do I automate documentation updates after a major release?▼

You can automate documentation updates after a major release by running a drift audit on your repository. It compares shipped features against current docs, proposes minimal corrective edits, and automatically opens a PR.

Does this documentation audit create branches and pull requests automatically?▼

Yes, this documentation audit creates branches and pull requests automatically. It follows a branch-and-PR workflow to propose minimal, non-destructive edits directly to your repository after detecting documentation drift.

Can I use a structured checklist for periodic documentation reviews?▼

Yes, you can use a structured checklist for periodic documentation reviews. The audit references a structured checklist to systematically evaluate README.md, doc/SPEC.md, and doc/PRODUCT.md for drift during periodic checks.

What files are supported for detecting documentation drift?▼

Supported files for detecting documentation drift include README.md, doc/SPEC.md, and doc/PRODUCT.md. The audit scans these top-level documents against recent git history to find undocumented shipped features.

Related Skills

Explore More Content & Communication Skills→
priyansh19priyansh19
1

doc-maintenance

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

Community
Advanced
canpok1canpok1

github

Automate GitHub issues, pull requests, and review threads via gh CLI.

Community
Advanced
spencerbeggsspencerbeggs

merge-prep

Squash git feature branch commits into one conventional commit for PR merging.

Community
Advanced
ryanthedevryanthedev
351

cc-documentation-quality

Automate documentation quality reviews across codebases during PR reviews.

Community
Basic