update-docs

Audit project documentation for staleness against current branch code changes.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/vr000m/skills.md --skill update-docs-vr000m
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/vr000m/skills.md/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/vr000m/skills.md --skill update-docs-vr000m

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Syncs project documentation with code changes on the current branch by scanning dev plans, changelogs, READMEs, AGENTS.md, and PR descriptions for staleness against the actual diff, then offering targeted updates. Use after finishing implementation work, before creating or merging a PR, or when the user says "update docs" or "/update-docs".

Core Features & Use Cases

  • Audits documentation for staleness against the latest code changes, identifying items such as missing checkboxes, outdated command references, or architecture notes.
  • Proposes and applies targeted edits to keep dev plans, changelogs, READMEs, AGENTS.md, and PR descriptions aligned with code.
  • Supports a PR workflow by auditing before merges and optionally applying updates automatically.

Quick Start

Run the update-docs command after finishing implementation work to synchronize documentation with the latest code changes.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep my README and changelog updated after code changes?

To keep your README and changelog updated after code changes, audit your documentation against the current branch's diff. This identifies staleness like outdated command references or missing checkboxes, allowing you to apply targeted edits that synchronize project docs with the latest codebase modifications.

What is the best way to sync dev plans with my current branch diff?

Syncing dev plans with your current branch diff involves comparing the plans against actual code changes. This process scans for staleness, proposes targeted updates to reflect the new state of the codebase, and ensures your development plans accurately match the implemented features.

Can I automatically update PR descriptions before merging?

You can update PR descriptions before merging by auditing them for staleness against the codebase diff. This supports a PR workflow by identifying outdated architecture notes or missing details, then optionally applying the documentation updates automatically to align with the latest changes.

How do I audit AGENTS.md files for staleness against codebase modifications?

Auditing AGENTS.md files for staleness against codebase modifications requires scanning the file alongside the current branch's diff. It detects outdated architecture notes or command references, then offers targeted edits to adjust the documentation and accurately reflect the latest code changes.

When do I need to refresh project documentation to match code?

You need to refresh project documentation to match code after finishing implementation work and before creating or merging a pull request. This ensures your dev plans, changelogs, and READMEs are audited for staleness against the actual diff and updated to reflect the latest state.