Documentation Sync

Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository docs may need updating. Keep docs in sync with code and record durable decisions.

Sby Skills Guide Bot
DocumentationIntermediate
108/9/2026
Claude CodeCursorWindsurfCopilotCodex
#documentation#docs-sync#decision-records#adr

Recommended for


name: docs-sync description: Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository documentation may need to be updated.

Docs Sync

  • Check README.md, docs/DECISIONS.md, relevant docs under docs/, and any ADRs.
  • Update docs in the same change as code when public behavior, commands, assumptions, or validation evidence changes.
  • Record durable decisions in docs/DECISIONS.md or a new ADR; do not bury decisions only in chat.
  • Keep docs concise and operational: what changed, why, how to run it, and what remains out of scope.
  • Avoid rewriting unrelated docs or changing historical decisions except to add a dated superseding note.
Related skills