SuperAPI AI 工具集

architectural-decision-records

办公与效率

查看项目

更新于 10-15 22:38

技能介绍

用途:该技能用于创建、更新、评审或解释架构决策记录(ADR)、决策日志、取舍分析、理由、后果、备选方案与状态。它强调面向未来读者,便于重建决策历史。不适用于临时实现细节、会议记录或不重要的决策;若不确定重要性,可先问未来维护者需要知道什么。

主要能力:识别单一决策,多个决策拆分为多个 ADR;检查 preferences.md 中的 preferred-style;若未设置,询问用户选择 MADR full、MADR minimal、Nygard、Y-Statement 或 custom,并记录到 preferences.md。按模板选择:详细取舍用 templates/madr-full.md,简要用 templates/madr-minimal.md,经典轻量用 templates/nygard.md,一句话总结用 templates/y-statement.md,项目自定义用 templates/custom.md;证据不足时输出评审笔记/问题而非已接受 ADR。

使用方式:只记录已知事实,包括背景、需求、约束、选项、理由、决策者和后果;缺失事实标记为 Unknown 或提出聚焦问题,不编造背景、选项或质量属性。诚实记录后果:收益、缺点、后续工作。保留历史:旧 ADR 用新 ADR 取代并链接,不重写抹除。状态值包括 Proposed(评审中)、Accepted(团队承诺)、Deprecated(历史相关但不再推荐)、Superseded(被另一 ADR 取代并链接)。

评审清单:一个决策而非捆绑;重要性影响结构、质量属性、约束或演进;背景解释存在原因;明确被拒选项与取舍;理由与需求挂钩而非偏好;记录缺点与后续工作;状态清晰;未知项标记而非编造。

限制:资料未提供具体安装命令、平台支持、收费或价格信息;模板文件路径与偏好提示为资料中给出的用法,实际使用需按项目环境确认。