🚀 快速安装
复制以下命令并运行,立即安装此 Skill:
npx @anthropic-ai/skills install github/awesome-copilot/create-architectural-decision-record
💡 提示:需要 Node.js 和 NPM
创建架构决策记录
为 ${input:DecisionTitle} 创建一份 ADR 文档,使用针对 AI 消费和人类可读性进行优化的结构化格式。
输入项
- 上下文:
${input:Context} - 决策:
${input:Decision} - 备选方案:
${input:Alternatives} - 利益相关者:
${input:Stakeholders}
输入验证
如果任何必需的输入项未提供或无法从对话历史中确定,请在继续生成 ADR 之前要求用户提供缺失的信息。
要求
- 使用精确、无歧义的语言
- 遵循带有前置元数据的标准化 ADR 格式
- 包含积极和消极的后果
- 记录备选方案及其被拒绝的理由
- 结构要利于机器解析和人工参考
- 对多项目部分使用编码的要点列表(3-4 个字母的代码 + 3 位数字)
ADR 必须保存在 /docs/adr/ 目录中,命名约定为:adr-NNNN-[标题-slug].md,其中 NNNN 是下一个顺序的 4 位数字(例如,adr-0001-database-selection.md)。
必需的文档结构
文档文件必须遵循以下模板,确保所有部分都得到适当填写。Markdown 的前置元数据应按照以下示例正确结构化:
---
title: “ADR-NNNN: [决策标题]”
status: “Proposed”
date: “YYYY-MM-DD”
authors: “[利益相关者姓名/角色]”
tags: [“architecture”, “decision”]
supersedes: “”
superseded_by: “”
---
# ADR-NNNN: [决策标题]
## 状态
**已提议** | 已接受 | 已拒绝 | 已替代 | 已弃用
## 上下文
[需要此决策的问题陈述、技术约束、业务需求和环境因素。]
## 决策
[选择的解决方案以及明确的选择理由。]
## 后果
### 积极后果
- **POS-001**: [有益的结果和优势]
- **POS-002**: [性能、可维护性、可扩展性方面的改进]
- **POS-003**: [与架构原则的一致性]
### 消极后果
- **NEG-001**: [权衡、限制、缺点]
- **NEG-002**: [引入的技术债务或复杂性]
- **NEG-003**: [风险和未来的挑战]
## 考虑过的备选方案
### [备选方案 1 名称]
- **ALT-001**: **描述**: [简要的技术描述]
- **ALT-002**: **拒绝理由**: [为何未选择此选项]
### [备选方案 2 名称]
- **ALT-003**: **描述**: [简要的技术描述]
- **ALT-004**: **拒绝理由**: [为何未选择此选项]
## 实施说明
- **IMP-001**: [关键的实施考量]
- **IMP-002**: [迁移或推出策略(如适用)]
- **IMP-003**: [监控和成功标准]
## 参考资料
- **REF-001**: [相关的 ADR]
- **REF-002**: [外部文档]
- **REF-003**: [引用的标准或框架]
📄 原始文档
完整文档(英文):
https://skills.sh/github/awesome-copilot/create-architectural-decision-record
💡 提示:点击上方链接查看 skills.sh 原始英文文档,方便对照翻译。
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

评论(0)