SuperAPI AI 工具集

architecture-decision-records

写作与研究

查看项目

更新于 10-16 05:06

技能介绍

用途:在做出重大架构决策、记录技术选型、记录设计权衡、帮助新成员入职、回顾历史决策或建立决策流程时,编写与维护架构决策记录(ADR)。不适合记录细小实现细节、日常补丁或例行维护,或不存在架构决策的场景。

主要能力:提供创建、维护和管理 ADR 的综合模式,涵盖决策上下文、约束与驱动因素的捕获;记录被考虑的选项及权衡;记录决策、理由与后果;关联相关 ADR 并随时间更新状态。

内容模块:包括什么是 ADR、何时编写 ADR、ADR 生命周期;多种模板,如标准 ADR(MADR 格式)、轻量级 ADR、Y-Statement 格式、弃用类 ADR、RFC 风格;并涉及目录结构、ADR 索引(README.md)、自动化(adr-tools)以及提交前、评审中、接受后的实践,另有注意事项(Do's / Don'ts)。

使用方式:按技能中的指令与模板撰写 ADR,捕获决策上下文与驱动因素,列出备选方案及其利弊,说明最终决策、理由与影响,并在必要时链接相关 ADR、更新状态。资料提及可借助 adr-tools 实现自动化,但未提供具体安装或使用命令。

适用场景:技术选型评审、架构演进记录、团队知识沉淀、历史决策追溯。

限制:资料未说明具体收费、价格、支持平台或量化效果;示例中出现的具体技术名词(如 PostgreSQL、MySQL、MongoDB、Event Store、Projections 等)仅为模板示例内容,不代表该技能提供这些技术本身的功能。