SuperAPI AI 工具集

design-system-adr

设计与创作

查看项目

更新于 10-15 21:38

技能介绍

用途:为设计系统团队编写与维护架构决策记录(ADR),回答“为什么是这样”这一问题。格式为 Equinor Design System 团队所用:在 Michael Nygard 的上下文/决策/后果结构之上按 MADR 组织,包含驱动因素、带优缺点的选项、Good, because / Bad, because 后果、确认小节;元数据用项目符号列表而非 YAML front matter,模板见 references/template.md。

主要能力:生成编号决策记录、检查(lint)、替代(supersede)旧记录、生成索引表。脚本命令包括:python3 $skill/scripts/adr.py next --gh(取下一个可用编号)、new "标题" --deciders "..."、check documentation/adr、index --write。

使用方式:先确认决策是 Proposed 还是已 Accepted、是否放入公开仓库;记录放入目标仓库 documentation/adr/,模板复制为 0000-template.md。文件名形如 NNNN-short-kebab-title.md,H1 标题不带编号。编写顺序:Context、Decision Drivers、Options Considered(至少两个,各自有 Pros/Cons)、Decision、Consequences(Good, because / Bad, because)、Confirmation、Related。合并前运行 check,索引用 index --write 生成 README.md,不手写。

限制:状态使用封闭词表,日期为 YYYY-MM-DD;接受后正文不可变,只允许改 Status 行;编号由 PR 认领,不得复用或重编号;Confirmation 缺失、无不良后果、残留指导注释等仅告警。若只有结论没有备选方案,应说明这是一份备忘而非决策。规则由记录确立时需登记到 CLAUDE.md 或 AGENTS.md。