SuperAPI AI 工具集

arc42-section-09

编程与开发

查看项目

更新于 10-23 16:17

技能介绍

该技能面向 arc42 架构文档第 9 章“架构决策”的编写,目标是记录“为什么”这样决策,包括背景、备选方案和真实的权衡,而不仅是记录决定了什么。

用途与格式:以 Nygard ADR 格式为基准(标题、状态、上下文、决策、后果),并增加替代方案表与跨章节影响引用块;这两项属于工具包扩展,官方 arc42 并未强制第 9 章使用特定格式。第 4 章在概要层面总结决策,第 9 章则给出每项决策的完整理由、替代方案和后果。ADR 被视为不可变历史:决策变化时应新建状态为 Accepted 的 ADR,并将旧 ADR 标记为 Superseded by ADR-XXX,不得编辑或删除旧 ADR。

使用方式:技能首先要求不要生成文档,先回答一组上下文问题:第 4 章是否存在并列出其标记为需要完整 ADR 的决策;第 2 章是否存在并检查迫使某些决策的约束;第 1.2 章和第 5 章是否存在以获取质量目标与构建块名称,用于各 ADR 的影响部分。随后向用户说明“架构上重要的决策”判定标准:难以或昂贵逆转、影响多个构建块、在相互竞争的关注点之间有显著权衡、在团队中非显而易见或有争议、约束未来架构选择、直接影响第 1.2 章的一个或多个质量目标;实现细节、显而易见的选择、易于逆转的决策、无系统级影响的单组件选择不需要 ADR。接着按类别系统提问:架构风格、技术栈、数据策略、集成模式、自建与采购、安全方案及其他重要决策。对每个确认的决策询问:背景或问题、决定了什么、认真考虑过哪些替代方案、每个替代方案被否决的原因、正面后果、负面后果或权衡、决策时间与参与人、是否仍然有效或被取代。最后询问详细程度:LEAN 仅含上下文、决策、后果;ESSENTIAL 增加工具包影响块,并在评估过替代方案时增加替代方案表;THOROUGH 在 ESSENTIAL 基础上增加干系人与验证标准。

输出内容:收集完成后生成第 9 章,每项决策一个 ADR,包含概览段落(记录了多少决策、什么触发新 ADR、被取代决策如何处理)、决策日志表(ID、标题、状态、日期,有效决策在前,其次被取代,再次已弃用),以及各 ADR 的状态、日期、干系人(仅 THOROUGH)、上下文、决策、正面与负面后果、替代方案表(仅在确实评估过替代方案时包含)、影响块(受影响构建块→第 5 章、支撑的质量目标→第 1.2 章、产生的约束→第 2 章、产生的风险→第 11 章)、验证(仅 THOROUGH)。

评审与迭代:生成草稿后按清单检查并对不合格项说明问题与处理建议,包括:第 4 章标记的每项决策都有对应 ADR;只记录架构上重要的决策;没有编辑或删除决策,被取代的以 Superseded by ADR-XXX 标记;每个 ADR 都有解释原因的上下文;替代方案有具体否决理由(至少考虑过一个替代方案);后果同时包含正面与负面;每个 ADR 都设置状态和日期;决策产生的风险连接到第 11 章;决策日志完整且与所有 ADR 一致,有效决策排在前面;影响中的构建块名称与第 5 章完全一致,引用的质量目标与第 1.2 章完全一致。最后询问用户希望完善或扩展什么并迭代至满意。

适用场景与限制:适合架构师和团队系统化记录架构决策及其理由与权衡,并与 arc42 其他章节保持交叉引用一致。该技能依赖用户提供的项目上下文与决策信息;第 2、4、1.2、5、11 章缺失时相关复用与交叉检查无法进行。关于收费、价格、平台支持等信息暂未提供。