SuperAPI AI 工具集

make-decision-doc

设计与创作

查看项目

更新于 10-16 09:50

技能介绍

用途:决策文档存放于仓库根目录 decisions/NNN-kebab-name.md,说明某项选择为何做出、权衡了什么、实际考虑过哪些备选,以及何时可能重新审视。它不是功能规格、操作指南或变更日志。

何时编写:当出现不显而易见的架构选择、未来贡献者会问“为什么不用 X”;当选择存在易被事后质疑的权衡(性能与简洁、锁定与灵活、易用与正确);当偏离常见默认或行业标准做法且理由重要时。若选择显然、未认真考虑备选、或理由已在代码注释、change file、PR 描述中,则不必写。

工作流:先阅读 decisions/ 下已有文件(如 decisions/001-*.md)以匹配语气与结构;用 ls decisions/ | wc -l 统计现有文件数并加 1 取下一个编号,文件名格式为 NNN-kebab-slug.md,前缀三位补零;slug 命名所决定的对象而非动词(如 single-matcher 而非 pick-single-matcher);按结构起草,保持有据,不写假设性备选与愿景式语言;如与其他决策相关,用脚注链接([NNN]: ./NNN-other.md)。

结构:无固定模板,匹配现有文档风格。常见形态为:H1 标题用一句话或问题让读者扫一眼即懂;开头 1–3 段说明选择是什么、为何出现、现实备选是什么,先给具体语境;权衡章节可用“什么变简单/变难”“为何选 X”或按维度(性能、复杂度、易用性)命名,用 H2;可选的“何时重新审视”用编号列表列出会推翻该决定的条件;正文引用相关决策或外部来源时用脚注链接。

内容规则:每条主张都要有依据,引用基准、博客、代码引用或实测行为;若理由是“感觉更好”就直说,不要包装。只列真正权衡过的备选,虚构选项会削弱文档。决定用过去时(“我们选择了 X”),持续影响用现在时(“X 意味着我们不需要 Y”)。行文紧凑,代码引用用仓库标准 path/to/file.ts 风格,具体片段用反引号围栏。避免营销语气和模糊填充语,直接给出结论。

检查清单:是否读过至少一篇现有决策文档以匹配风格;文件名是否为 NNN-kebab-slug.md 且编号为下一个可用值;H1 是否一行传达决定;备选是否为真正考虑过的;是否引用具体证据而非断言;若决定可能反转,是否有“何时重新审视”章节。

限制:资料未提供该技能的具体安装方式、收费情况、平台支持或效果数据。