updating-docs

Decides whether a code change requires documentation updates and which file owns them.

Updated Sep 15, 2026
One-click install
npx skills add https://github.com/tomada1114/quick-reply-drill --skill updating-docs-tomada1114
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: updating-docs
Source: https://github.com/tomada1114/quick-reply-drill/tree/main/.agents/skills/updating-docs
Command: npx skills add https://github.com/tomada1114/quick-reply-drill --skill updating-docs-tomada1114

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When a pull request changes code, it is often unclear whether documentation must change too, and if so, which file should carry the update. This Skill resolves that triage by judging changes on reader-observable behavior rather than edit location, and by routing each update to the correct surface. ## Core Features & Use Cases - Documentation impact triage: Determines whether a change is user-observable and owes a doc update, treating "no update needed" as a legitimate outcome for refactors and test-only edits. - Surface routing: Assigns each update to exactly one owner — README.md for the tour and quick start, AGENTS.md for architecture and rules, CONTRIBUTING.md for setup and PR process, .env.example for environment variables, or TSDoc for published symbol contracts. - Skill lifecycle tracking: Records skill additions, renames, and deletions in AGENTS.md's Skills table, which a test asserts stays in sync with the authored directory. - Use Case: A pull request moves an architecture boundary between zones. Use this Skill to decide the change belongs in AGENTS.md, not README.md, and that no CONTRIBUTING.md edit is owed. ## Quick Start Ask the agent to review your pull request diff and decide which documentation files, if any, need to be updated.

Frequently Asked Questions about updating-docs

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

FAQPage Schema
How do I decide if a pull request needs a documentation update?▼

Judge by what a reader can observe, not which directory was edited. Quick start changes, API route behavior, and new pages require README updates; refactors, test-only changes, and internal rule edits require none.

Which documentation file should I update for an architecture change?▼

Architecture boundaries, zone rules, gates, and pnpm command changes belong in AGENTS.md. README.md only changes when the first ten minutes with a checkout change, and CONTRIBUTING.md covers setup and the pull request process.

Does editing a SKILL.md file require updating other documentation?▼

Editing a skill's content is not user-observable and requires no README, CONTRIBUTING, or AGENTS.md change. The exception is adding, renaming, or deleting a skill, which must be recorded in AGENTS.md's Skills table.

When should a change get a TSDoc comment instead of a README update?▼

TSDoc documents a published symbol's contract in src/**, such as the language-model port's request and response types that adapter authors read. This Skill decides whether a comment is owed; the writing-typescript skill owns what it says.

Should I add a lint rule to verify code examples in documentation?▼

No. The repository deliberately has no gate that compiles fenced examples, and adding one creates another thing to keep true. Keep examples eye-checkable, or put runnable code in src/ where tests already call it.