Sync Documentation

Use this skill at the end of a task to ensure documentation matches the code.

majiayu000 Updated 567 repo stars

File contents

Sync Documentation

Use this skill to prevent documentation drift after you change behavior, flows, or structure.

Checklist

  1. architecture.md (index)
  • New module/service/folder? -> add it to the index
  • Changed a main flow? -> update the relevant docs/architecture/* page(s)
  1. docs/architecture/ (leaf docs)
  • Update the page(s) that map to the modified area (backend core/data/indicators, chart map, flows, runs/logging, etc.)
  • Keep each doc short and linkable (LLM-friendly)
  1. README.md
  • New env var? -> document it
  • Changed how to run/test? -> update commands
  1. ROADMAP.md
  • Completed an item? -> mark it done
  • New work discovered? -> add it

Output requirement

In the final response, explicitly list:

  • Updated: architecture.md (if changed)
  • Updated: docs/architecture/... (if changed)
  • Updated: README.md / Updated: ROADMAP.md (if changed)

majiayu000/claude-skill-registry-data/tree/main/documents/sync-documentation commit a37195287c

Frequently asked questions

npx skillmds@latest add majiayu000/sync-documentation