关于 decision-doc-sync
decision-doc-sync 是用于让项目文档与结构性决策及代码保持一致的技能。它将改动类型对应到现有文档或 ADR，并强调记录决策、避免事实重复。
主要功能
- 01分类结构性决策
- 02将改动映射到文档
- 03仅更新已存在的文档
- 04将长期决策记录为 ADR
- 05对照实现检查文档
适用场景
- 01记录架构改动
- 02更新界面或体验规范
- 03记录工作流与脚本约定
- 04跨领域改动后复查文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/decision-doc-sync确认已加载。
附带文件references/doc-map.md
详细介绍
决策文档同步
激活约定
当变更引入或修改结构性决策时，加载此技能：架构、UI/UX 标准、脚本或质量门禁，或跨领域约定。
硬性规则
- 编辑前检查哪些文档已存在；只更新已存在的文档，并且仅在下方规则要求时才创建文档。
- 每项事实只记录在一份文档中，并从其他文档链接到该文档，而不是重复记录。
- 记录决策本身，而非变更历史。
- 变更后，绝不能让文档与代码相矛盾。
决策关卡
| 变更类型 | 文档 |
|---|---|
| 架构、文件夹结构、脚本 | README.md |
| 视觉或 UX 标准、设计令牌、组件用法 | DESIGN.md |
| Agent 工作流、命令、操作指南 | AGENTS.md |
| 包含备选方案和后果的持久决策 | 在 docs/adr/ 中创建新记录 |
执行步骤
- 检查
README.md、DESIGN.md、AGENTS.md和docs/adr/是否存在。 - 使用上表对变更分类；一次变更可能涉及多行。
- 更新每份已存在且受影响的文档。
- 对于 ADR，遵循
docs/adr/中现有的编号和格式；参见 references/doc-map.md。 - 根据代码重新检查已编辑的部分。
输出约定
列出每份已更新、已创建或有意跳过的文档，并各用一行说明原因。
参考资料
- references/doc-map.md — ADR 格式和边界情况。
评论
支持 Markdown