skills.rest
Jang-zn
Jang-znCOMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Audit README.md, doc/SPEC.md, and doc/PRODUCT.md for drift and open a PR with minimal edits.

Updated Apr 3, 2026
Search Tags:#git#documentation#audit#docs#drift#pull-request
One-click install
npx skills add https://github.com/Jang-zn/paperclip-kr --skill doc-maintenance-jang-zn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/Jang-zn/paperclip-kr/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/Jang-zn/paperclip-kr --skill doc-maintenance-jang-zn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation often diverges from shipped features as codebases evolve. This skill audits the repository's primary docs for drift and misalignment, flagging gaps between what's implemented and what's documented.

Core Features & Use Cases

  • Detect drift in README.md, doc/SPEC.md, and doc/PRODUCT.md by comparing recent commits with the current content.
  • Propose minimal, targeted edits that restore accuracy without rewriting policy or voice.
  • Open a dedicated branch and a PR with a concise change summary for reviewer clarity.

Quick Start

Audit the repository's core docs for drift and generate a minimal-edit PR to restore alignment.

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 in a git repository?▼

You detect documentation drift by auditing top-level files like README.md and doc/SPEC.md, comparing recent git commits against current content to flag gaps between shipped features and documented capabilities.

What is the best way to fix outdated README.md files after a feature merge?▼

The best way to fix outdated README.md files is to generate a dedicated branch with minimal, targeted edits that restore accuracy, then open a pull request with a concise change summary for reviewer clarity.

When should I audit my project docs for misalignment?▼

You should audit your project docs for misalignment during periodic reviews, after major feature merges, or whenever accuracy is questioned, ensuring shipped features match documented capabilities.

Can I automatically create a pull request for documentation updates?▼

Yes, you can automatically create a pull request for documentation updates by detecting drift, proposing minimal targeted edits, creating a branch, and opening a PR with a concise change summary.

Does this documentation audit rewrite the voice or policy of my SPEC.md files?▼

No, this documentation audit does not rewrite the voice or policy of your SPEC.md files; it proposes minimal, targeted edits that restore accuracy without altering the original writing style or policy.

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
khoabdkhoabd

doc-maintenance

Detect documentation drift and generate minimal factual edits via pull requests.

Community
Intermediate
krishsharma1008krishsharma1008

doc-maintenance

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

Community
Intermediate
akaszubskiakaszubski
32

semantic-validation

Detect semantic misalignment between documentation and code implementation.

Community
Intermediate