update-docs
Close the documentation loop after a feature ships — distill the spec into the living feature doc, update CUJs and indexes, mark the spec shipped — or run an audit to reconcile the docs tree with real
Files1
View on GitHubSKILL.md.claude/skills/update-docs/SKILL.md
GitHubTask
For $ARGUMENTS:
Mode A — close out a shipped spec (default)
- Distill, don't copy. Read the spec folder + final diff. Write/update
docs/product/features/<slug>.md(create thedocs/product/features/dir + a shortREADME.mdindex if absent, and link it fromdocs/index.md): what it does (user terms), how it works (the non-obvious 20%), dated decisions & gotchas, CUJs covered. The feature doc is what future changers ground on — capture what they'd otherwise rediscover painfully, omit what the code says plainly. - Update the registries: feature index in
docs/product/features/README.md· CUJ table indocs/quality/critical-user-journeys.md(new/changed journeys with spec + Maestro flow names) · spec status →shippedinspecs/README.md·docs/index.mdif files were added. - Check for ripples: did this work invalidate any statement in
docs/architecture/*ordocs/conventions/*? Fix in place; if a decision changed, that's a superseding ADR, not a silent edit. Check code↔doc sync rules (e.g. tokens betweentailwind.config.jsandsrc/shared/theme/colors.ts). - Validate: run
npm run docs:lint(links + orphans + taste). Commit asdocs(<slug>): close out spec NNN.
Mode B — audit (drift check, folds /sync-docs)
Sweep for lies: feature docs vs actual slices (ls src/features), CUJ table vs .maestro/flows/, specs index vs spec folders' real status, docs/index.md vs files on disk, AGENTS.md docs map completeness, dead links (npm run docs:lint). Cross-check the last changes (git log --oneline -20 + git diff main --stat) against docs/architecture, docs/conventions, AGENTS.md, README. Report a fix-list ordered by how badly each lie would mislead an agent, then fix the approved ones. End with any HARNESS: proposal.
Tone rules for all docs: short, imperative, present tense, no marketing. If a doc passes 200 lines, split it and re-index.