Decision Doc Sync

C3SC0-V4113/Scaffold/skills/decision-doc-sync

by C3SC0-V4113ba1fac59145ed48f727247299ebb09289b87f27bApache-2.03 starsListed Oct 9, 2026Updated Oct 9, 2026Repository updated 3 days ago

Trigger: architecture change, new convention, UI/UX standard, quality gate change, ADR. Keep existing project docs in sync with structural decisions.

Instructions onlyProductivity & Workflow
AI-generated overview

Keeps project documentation in sync with structural decisions such as architecture, conventions, and quality gates.

What it does
This skill guides an agent through updating existing project documents after a structural change. It checks which of README.md, DESIGN.md, AGENTS.md, and docs/adr/ exist, classifies the change against a decision-gate table, and updates only the affected documents. It also produces a list of every document updated, created, or deliberately skipped, with a one-line reason for each.
When to use it
Use it when a change introduces or alters a structural decision, such as architecture, folder structure, scripts, quality gates, UI/UX standards, or a cross-cutting convention. It is also relevant when recording an architecture decision record (ADR).
Requirements
Instructions only; no scripts. It reads and edits project files (README.md, DESIGN.md, AGENTS.md, docs/adr/) and references references/doc-map.md for ADR format and edge cases.

Decision Documentation Sync

Activation Contract

Load this skill when a change introduces or changes a structural decision: architecture, UI/UX standards, scripts or quality gates, or a cross-cutting convention.

Hard Rules

  1. Check which documents exist before editing; update only documents that exist, and create one only when a rule below requires it.
  2. Keep each fact in one document and link to it from others instead of duplicating it.
  3. Record the decision itself, not the change history.
  4. Never leave a document contradicting the code after the change.

Decision Gates

Change typeDocument
Architecture, folder structure, scriptsREADME.md
Visual or UX standard, tokens, component usageDESIGN.md
Agent workflow, commands, operational guidanceAGENTS.md
Durable decision with alternatives and consequencesnew record in docs/adr/

Execution Steps

  1. Check which of README.md, DESIGN.md, AGENTS.md, and docs/adr/ exist.
  2. Classify the change with the table above; one change may hit several rows.
  3. Update each affected document that exists.
  4. For an ADR, follow the existing numbering and format in docs/adr/; see references/doc-map.md [blocked].
  5. Reread the edited sections against the code.

Output Contract

List every document updated, created, or deliberately skipped, with a one-line reason each.

References

  • references/doc-map.md [blocked] — ADR format and edge cases.

Source and attribution

Source:C3SC0-V4113/Scaffoldinskills/decision-doc-syncat commitba1fac5

License: Apache-2.0

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal