update-docs

Assess whether design documentation needs updating based on recent git changes and update it.

Updated Jun 4, 2026
One-click install
npx skills add https://github.com/PeteRichardson/skills --skill update-docs-peterichardson
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/PeteRichardson/skills/tree/main/update-docs
Command: npx skills add https://github.com/PeteRichardson/skills --skill update-docs-peterichardson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping design documentation in sync with code changes is easy to forget and tedious to verify manually. This Skill inspects your recent git changes, determines whether they are structural enough to warrant a documentation update, and either updates the design doc or confirms it is still current. ## Core Features & Use Cases - Change Analysis: Reads staged or unstaged git diffs to classify changes as structural, behavioral, or cosmetic. - Staleness Detection: Checks the design doc's last-updated date and commit history to judge whether it is likely out of date. - Decision Matrix: Applies a clear rubric (new modules, public APIs, data models warrant updates; bug fixes and test-only changes do not) to avoid unnecessary doc churn. - Use Case: After refactoring a module and adding a new public API, run the Skill to confirm the design doc is stale and trigger a full update via the /design-doc skill. ## Quick Start Ask the assistant to check whether the design doc is still current given your recent changes and update it if needed.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I check if my design doc is out of date after code changes?

Run the update-docs skill, which inspects your staged or unstaged git diff to understand the nature of the change, then compares it against the design doc's last-updated date and commit history to judge staleness.

What kinds of code changes require a design doc update?

Structural changes warrant updates: new modules or packages, new public API surfaces, changed data models or core types, and architecturally significant dependencies. Bug fixes, test additions, config changes, and internal refactors without interface changes do not.

Does the skill update documentation for every code change?

No. The skill deliberately avoids updating docs for non-structural changes, since churn is worse than minor staleness. If no update is warranted, it simply confirms the design doc is current.

How does the skill perform the actual documentation update?

When an update is warranted, it delegates to the /design-doc skill, which handles the full update cycle: reading the current doc, identifying stale sections, and rewriting them. The update-docs skill itself only makes the assessment.

When should I not use an automated doc-currency check?

Avoid it for documentation-only commits or cosmetic changes where the answer is obvious. It is most valuable after structural work like new modules or API changes, where doc staleness is a real risk.