skills.rest
navyapdh11
navyapdh11COMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Audit documentation drift against git history and open a PR.

Updated Apr 24, 2026
Search Tags:#git#documentation#audit#maintenance#docs#drift#pr
One-click install
npx skills add https://github.com/navyapdh11/navya-cleaning-april --skill doc-maintenance-navyapdh11
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/navyapdh11/navya-cleaning-april/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/navyapdh11/navya-cleaning-april --skill doc-maintenance-navyapdh11

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audits documentation drift between shipped features and what is described in README.md, SPEC.md, and PRODUCT.md, proposing minimal edits, creating a branch, and opening a PR.

Core Features & Use Cases

  • Automatically detects discrepancies across core docs against recent commits, including feature tables, roadmaps, and foundational concepts.
  • Proposes minimal, non-destructive edits to restore accuracy, and automates branch creation and PR initiation.
  • Use Case: After a feature release, run the maintenance skill to align docs with the new capabilities and timelines.

Quick Start

Run the doc-maintenance skill to audit the top-level docs for drift and prepare a PR with the suggested edits.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I audit documentation drift against my git history?▼

Documentation drift is detected by comparing shipped features in README.md, SPEC.md, and PRODUCT.md against recent git commits. The process identifies discrepancies between delivered capabilities and documented content, then proposes minimal edits via a pull request to restore accuracy.

What is the best way to update README and SPEC files after a feature release?▼

Updating docs after a release involves running a maintenance audit that detects changes across core documentation, builds a concise change summary, and proposes non-destructive edits to align docs with new capabilities and timelines.

Can I automatically create a PR for documentation fixes?▼

You can automatically create a PR for documentation fixes. The process detects documentation drift, creates a dedicated branch, proposes minimal non-destructive edits to restore accuracy, and opens a pull request while preserving the existing documentation voice.

When do I need to run a documentation maintenance audit?▼

A documentation maintenance audit is needed during post-release reviews, periodic maintenance cycles, or on-demand checks. It catches discrepancies between what is delivered and what is documented across README.md, SPEC.md, and PRODUCT.md files.

Does the documentation audit preserve my existing writing style?▼

The documentation audit preserves your existing writing style. It implements a deterministic workflow that proposes minimal, non-destructive edits to restore accuracy while explicitly preserving the existing documentation voice throughout the changes.

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
mdmagnuson-creatormdmagnuson-creator

merge-conflicts

Merge target branches into source branches and resolve pull request conflicts.

Community
Advanced
czer323czer323

git-workflows

Generate PR descriptions, commit messages, and release notes from branch diffs.

Community
Advanced
AbeJitsuAbeJitsu

format-standardize

Apply user-defined formatting standards across code, documentation, and content outputs using ESLint and Prettier.

Community
Basic