Decision Doc Sync

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

作者 C3SC0-V4113ba1fac59145ed48f727247299ebb09289b87f27bApache-2.03 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫3 天前更新

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

AI 產生的概覽

讓專案文件與架構、慣例和品質閘門等結構性決策保持同步。

功能
這個技能引導代理在結構性變更後更新既有的專案文件。它會檢查 README.md、DESIGN.md、AGENTS.md 和 docs/adr/ 中哪些存在,依決策閘門表將變更分類,並只更新受影響的文件。它也會產出一份清單,列出每個被更新、建立或刻意略過的文件,並各附一行原因。
適用情境
當某項變更引入或改變結構性決策時使用,例如架構、資料夾結構、指令碼、品質閘門、UI/UX 標準或跨領域慣例。記錄架構決策記錄(ADR)時也適用。
執行需求
僅為指示性內容,不含指令碼。它會讀取並編輯專案檔案(README.md、DESIGN.md、AGENTS.md、docs/adr/),並參考 references/doc-map.md 了解 ADR 格式與邊界情況。

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.

來源與署名

來源:C3SC0-V4113/Scaffold位於skills/decision-doc-sync提交ba1fac5

授權條款: Apache-2.0

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架