用途:该技能用于创建新的架构决策记录(ADR),适合在需要记录重要技术决策的背景、可选方案与理由时使用。
主要能力:
- 解析参数,支持指定标题(必填)、状态(proposed、accepted、deprecated、superseded,默认 proposed)和模板(basic(Nygard)、madr、extended,默认 madr)。
- 自动确定 ADR 编号:在 docs/decisions/、docs/adr/ 中查找符合 ADR-.md 或 [0-9][0-9][0-9][0-9]-.md 的文件;无则从 001 开始,否则在最大编号上加一。
- 收集上下文:若未提供,会提示或推断问题陈述、约束、考虑过的选项和决策驱动因素。
- 加载 enterprise-architecture:adr-management 技能获取模板与指导,并按模板类型生成内容,含规范头部、必需章节及待人工填写的占位说明。
- 创建文件:按优先级选择 docs/decisions/ADR-{number}-{slug}.md(目录存在时)、docs/adr/ADR-{number}-{slug}.md(目录存在时),否则创建 docs/decisions/ 目录。slug 为标题小写、连字符形式,如 “Use PostgreSQL” 生成 ADR-001-use-postgresql.md。
- 更新索引:若存在 ADR-INDEX.md 或 decisions 目录下的 README.md,则加入编号、标题、状态和日期。
使用方式示例: /create-adr "Use PostgreSQL for primary database" /create-adr "Switch to event sourcing" status=accepted template=extended /create-adr "Deprecate REST API v1" status=deprecated
模板类型:basic(Nygard)含状态、背景、决策、后果;MADR 额外含日期、决策驱动、考虑选项、决策结果及优缺点;extended 还含执行摘要、约束与假设、权衡表、实施行动项、验证标准、相关决策与参考。
限制:资料未提供具体的安装命令、收费方式与平台支持信息;生成的 ADR 含待填占位内容,需人工补充;创建后需提醒用户填写占位、补充选项优缺点、记录实际决策、关联相关 ADR、最终确定后更新状态并获取干系人评审。质量要求包括编号唯一递增、遵循项目存放约定、包含模板全部必需章节、占位指引清晰、尽可能被索引链接以及日期使用 ISO 8601 格式。