SuperAPI AI 工具集

adr-architecture

办公与效率

查看项目

更新于 10-16 00:02

技能介绍

用途:把重要架构和技术决策写成可追溯的 ADR,完整记录背景、所选方案、备选方案、权衡与后果,供未来读者在没有当前上下文时仍能理解。

主要能力:提供五步工作流(理解决策、选择 ADR 模板、撰写决策、质量校验、交付归档)。每份 ADR 包含 Context(为何需要该决策)、Decision(具体选择)、Alternatives(其他选项及优劣)、Consequences(权衡、风险与收益)、Status(proposed、accepted、deprecated、superseded)。针对技术选型、架构变更、标准约定、弃用等场景给出对应撰写要点。配有资源文件:resources/template.md(标准模板)、resources/methodology.md(复杂决策方法论)、resources/examples/(database-selection.md、microservices-migration.md、api-versioning.md)、resources/evaluators/rubric_adr_architecture.json(质量评分表)。

使用方式:复制检查清单逐步推进;按 adr-{number}-{short-title}.md 命名,例如 adr-042-use-postgresql-for-primary-database.md,存入 docs/adr/ 或 architecture/decisions/ 目录并顺序编号;用评分表自检,最低分 ≥ 3.5,争议性或高影响决策建议 ≥ 4.5。

适用场景:数据库/框架/库选型、微服务迁移、API 版本策略、组织级标准与弃用计划。

限制与约定:ADR 不可修改,状态可变但内容不变,需变更应写新的替代 ADR;一份 ADR 只记录一个决策;须诚实写出缺点、遗漏风险与真实考虑过的备选方案,避免模糊描述。具体命令、安装方式及收费信息暂未提供。