| name | update-docs |
| description | Use at the end of a unit of work, before commit or PR, to verify related documentation matches the new state |
Updating Documentation for Changes
Use this when wrapping up a unit of work. The mission is narrow: verify related documentation matches the new state before commit or PR, without turning the change into a general documentation cleanup.
Scope
Check documentation against the staged diff only.
git diff --staged --name-only
git diff --staged
If nothing is staged, stop and ask for the intended diff or for changes to be staged first.
Do not fix unrelated stale documentation in this pass. After completing updates, flag it to the user as potentially needing addressing.
Documentation Categories
Design docs
Design docs are decision artifacts, not evergreen current-state documentation. Once accepted, they record what was decided at the time; do not edit the body just because implementation has drifted.
Only update a design doc body when the staged work is the first-pass implementation of that specific design and the implementation changes the intended decision before the design settles.
For older design docs, status is the only normal update:
Rejected when the documented path was explored and intentionally declinedSuperseded by <newer design> when a newer design replaces it
Agent docs
Agent docs describe how future agents should operate in the repo. This includes files like CLAUDE.md, AGENTS.md, skill files, local agent instructions, and similar guidance.
Update them when the staged change affects:
- commands agents should run
- repo conventions or workflows
- architecture or deployment assumptions agents rely on
- known hazards, required skills, or operational procedures
Keep these docs directive and practical.
User docs
User docs are everything meant to help the human configure, deploy, or understand the project: READMEs, guides, API docs, examples, changelogs, package metadata, deployment notes, and similar files.
Update them when the staged change affects user-visible behavior, configuration, commands, APIs, installation, deployment, examples, or troubleshooting.
Do not add internal architecture detail to user-facing docs unless users need it to make correct decisions.
Pass 1: Find Expected Docs
From the staged diff, identify the feature, command, API, config, workflow, or behavior being changed. Then inspect the documentation locations that are likely to describe it.
Common places:
- nearby docs in the changed package, role, app, or module
- repo-level docs
- docs directories
- examples and config templates
- package metadata or manifests that expose commands, APIs, descriptions, or entry points
- agent instruction files when agent behavior is affected
- active design docs when the change implements that design
Read each relevant document to understand its purpose, audience, current style, and level of detail to ensure updates match.
Pass 2: Search for Unexpected Docs
After checking the obvious places, search for references that may live elsewhere.
Use terms from the diff: feature names, command names, flags, config keys, API paths, class/module names, service names, and user-facing concepts.
Example patterns:
rg "feature-or-command-name" -g "*.md" -g "*.mdx" -g "*.rst" -g "*.txt" -g "*.json" -g "*.yaml" -g "*.yml"
rg "config_key|related concept|old behavior" docs .github agents .agents 2>/dev/null
Follow direct cross-references if clearly related.
Deciding What to Change
Update documentation when a reader relying on the current docs would be misled, surprised, or missing important information because of the staged change.
Usually update docs for:
- new or changed commands, flags, APIs, configuration, workflows, or deployment steps
- removed or renamed behavior that docs still mention
- examples that no longer work
- agent instructions that would cause future agents to do the wrong thing
- active first-pass design docs whose intended decisions changed during implementation
- older design docs only when their status should become
Rejected or Superseded by ...
Usually do not update docs for:
- internal refactors with no documented behavior change
- bug fixes that restore documented behavior
- implementation details that do not belong to the doc's audience
- unrelated stale content found during the sweep
- accepted design docs, except for status-only
Rejected or Superseded by ... updates
- historical design docs that are not the design currently being implemented
Writing Updates
Match the document you are editing.
- Preserve its audience, tone, structure, and level of detail.
- Put information where that document's reader would look for it.
- Prefer concise corrections over broad rewrites.
- Describe the current state directly. Do not add changelog language like "previously X, now Y" unless the document is explicitly a changelog.
- Verify examples, commands, links, and cross-references still make sense.
If the right update would be large or contentious, stop and report the documentation gap instead of guessing.
Finish
After updating docs:
- Review the doc diff against the staged code diff.
- Confirm the documentation change is related to the staged work.
- Note unrelated stale docs separately, if found.
- Stage only the documentation updates that belong with this change.
The end state: related docs are current, historical docs stay historical, and the commit remains focused.
