create-architectural-decision-record

create-architectural-decision-record

热门

创建架构决策记录(ADR)文档,用于AI优化的决策文档。

3.6万Star
0Fork
更新于 2026/7/11
SKILL.md
readonly只读
name
create-architectural-decision-record
description

创建架构决策记录(ADR)文档,用于AI优化的决策文档。

创建架构决策记录

使用针对AI消费和人类可读性优化的结构化格式,为${input:DecisionTitle}创建ADR文档。

输入

  • 上下文${input:Context}
  • 决策${input:Decision}
  • 备选方案${input:Alternatives}
  • 利益相关者${input:Stakeholders}

输入验证

如果任何必需的输入未提供或无法从对话历史中确定,请在继续生成ADR之前要求用户提供缺失的信息。

要求

  • 使用精确、无歧义的语言
  • 遵循带有前置元数据的标准化ADR格式
  • 包括正面和负面后果
  • 记录备选方案并附上拒绝理由
  • 结构设计便于机器解析和人工参考
  • 对于多项目部分,使用编码项目符号(3-4个字母代码+3位数字)

ADR必须保存在/docs/adr/目录中,命名约定为:adr-NNNN-[title-slug].md,其中NNNN是下一个顺序的4位数字(例如,adr-0001-database-selection.md)。

必需文档结构

文档文件必须遵循以下模板,确保所有部分都适当填写。Markdown的前置元数据应按照以下示例正确结构化:

---
title: "ADR-NNNN: [决策标题]"
status: "提议"
date: "YYYY-MM-DD"
authors: "[利益相关者名称/角色]"
tags: ["架构", "决策"]
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**:[引用的标准或框架]