decision-doc-sync

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

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.
当变更引入或改变结构性决策时加载此skill:架构、UI/UX标准、脚本或质量门禁,或跨领域约定。

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.
  1. 在编辑前检查哪些文档已存在;仅更新已存在的文档,并且仅在下方规则要求时创建文档。
  2. 将每个事实保存在一个文档中,并从其他文档链接到它,而不是重复内容。
  3. 记录决策本身,而不是变更历史。
  4. 变更后绝不留下与代码矛盾的文档。

Decision Gates

决策门禁

Change typeDocument
Architecture, folder structure, scripts
README.md
Visual or UX standard, tokens, component usage
DESIGN.md
Agent workflow, commands, operational guidance
AGENTS.md
Durable decision with alternatives and consequencesnew record in
docs/adr/
变更类型文档
架构、文件夹结构、脚本
README.md
视觉或UX标准、tokens、组件用法
DESIGN.md
Agent工作流、命令、操作指南
AGENTS.md
具有备选方案和后果的持久决策
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.
  5. Reread the edited sections against the code.
  1. 检查
    README.md
    、
    DESIGN.md
    、
    AGENTS.md
    和
    docs/adr/
    中哪些存在。
  2. 使用上表对变更进行分类;一次变更可能涉及多行。
  3. 更新每个受影响且存在的文档。
  4. 对于ADR,遵循
    docs/adr/
    中现有的编号和格式;参见 references/doc-map.md。
  5. 根据代码重新阅读编辑过的部分。

Output Contract

输出契约

List every document updated, created, or deliberately skipped, with a one-line reason each.
列出每个已更新、已创建或有意跳过的文档,并附上一行原因。

References

参考

  • references/doc-map.md — ADR format and edge cases.
  • references/doc-map.md — ADR格式和边界情况。