Back to Details

create-architectural-decision-record

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Architectural Decision Record

创建架构决策记录

Create an ADR document for 
${input:DecisionTitle}
using structured formatting optimized for AI consumption and human readability.
使用兼顾AI解析与人类可读性的结构化格式，为
${input:DecisionTitle}
创建一份ADR文档。

Inputs

输入项

  • Context: 
    ${input:Context}
  • Decision: 
    ${input:Decision}
  • Alternatives: 
    ${input:Alternatives}
  • Stakeholders: 
    ${input:Stakeholders}
  • 背景：
    ${input:Context}
  • 决策内容：
    ${input:Decision}
  • 备选方案：
    ${input:Alternatives}
  • 利益相关方：
    ${input:Stakeholders}

Input Validation

输入验证

If any of the required inputs are not provided or cannot be determined from the conversation history, ask the user to provide the missing information before proceeding with ADR generation.
如果任何必填输入项未提供，或无法从对话历史中确定，需先请求用户补充缺失信息，再继续生成ADR。

Requirements

要求

  • Use precise, unambiguous language
  • Follow standardized ADR format with front matter
  • Include both positive and negative consequences
  • Document alternatives with rejection rationale
  • Structure for machine parsing and human reference
  • Use coded bullet points (3-4 letter codes + 3-digit numbers) for multi-item sections
The ADR must be saved in the 
/docs/adr/
directory using the naming convention: 
adr-NNNN-[title-slug].md
, where NNNN is the next sequential 4-digit number (e.g., 
adr-0001-database-selection.md
).
  • 使用精准、无歧义的语言
  • 遵循带前置元数据的标准化ADR格式
  • 包含正面和负面影响
  • 记录备选方案及被否决的理由
  • 兼顾机器解析与人类查阅的结构
  • 多条目部分使用编码式项目符号（3-4字母代码+3位数字）
ADR必须保存至
/docs/adr/
目录，命名规则为：
adr-NNNN-[title-slug].md
，其中NNNN为下一个连续的4位数字（例如：
adr-0001-database-selection.md
）。

Required Documentation Structure

必需的文档结构

The documentation file must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following:
md
---
title: "ADR-NNNN: [Decision Title]"
status: "Proposed"
date: "YYYY-MM-DD"
authors: "[Stakeholder Names/Roles]"
tags: ["architecture", "decision"]
supersedes: ""
superseded_by: ""
---
文档文件必须遵循以下模板，确保所有部分均已正确填写。Markdown的前置元数据需按照示例正确结构化：
md
---
title: "ADR-NNNN: [Decision Title]"
status: "Proposed"
date: "YYYY-MM-DD"
authors: "[Stakeholder Names/Roles]"
tags: ["architecture", "decision"]
supersedes: ""
superseded_by: ""
---

ADR-NNNN: [Decision Title]

ADR-NNNN: [Decision Title]

Status

状态

Proposed | Accepted | Rejected | Superseded | Deprecated
提议中 | 已接受 | 已否决 | 已取代 | 已弃用

Context

背景

[Problem statement, technical constraints, business requirements, and environmental factors requiring this decision.]
[问题陈述、技术约束、业务需求以及需要做出此决策的环境因素。]

Decision

决策内容

[Chosen solution with clear rationale for selection.]
[选定的解决方案及明确的选择理由。]

Consequences

影响

Positive

正面影响

  • POS-001: [Beneficial outcomes and advantages]
  • POS-002: [Performance, maintainability, scalability improvements]
  • POS-003: [Alignment with architectural principles]
  • POS-001: [有益成果与优势]
  • POS-002: [性能、可维护性、可扩展性的提升]
  • POS-003: [与架构原则的对齐]

Negative

负面影响

  • NEG-001: [Trade-offs, limitations, drawbacks]
  • NEG-002: [Technical debt or complexity introduced]
  • NEG-003: [Risks and future challenges]
  • NEG-001: [权衡、限制、劣势]
  • NEG-002: [引入的技术债务或复杂度]
  • NEG-003: [风险与未来挑战]

Alternatives Considered

考虑过的备选方案

[Alternative 1 Name]

[备选方案1名称]

  • ALT-001: Description: [Brief technical description]
  • ALT-002: Rejection Reason: [Why this option was not selected]
  • ALT-001: 描述: [简要技术说明]
  • ALT-002: 否决理由: [未选择此选项的原因]

[Alternative 2 Name]

[备选方案2名称]

  • ALT-003: Description: [Brief technical description]
  • ALT-004: Rejection Reason: [Why this option was not selected]
  • ALT-003: 描述: [简要技术说明]
  • ALT-004: 否决理由: [未选择此选项的原因]

Implementation Notes

实施说明

  • IMP-001: [Key implementation considerations]
  • IMP-002: [Migration or rollout strategy if applicable]
  • IMP-003: [Monitoring and success criteria]
  • IMP-001: [关键实施注意事项]
  • IMP-002: [适用的迁移或上线策略]
  • IMP-003: [监控与成功标准]

References

参考资料

  • REF-001: [Related ADRs]
  • REF-002: [External documentation]
  • REF-003: [Standards or frameworks referenced]
undefined
  • REF-001: [相关ADR文档]
  • REF-002: [外部文档]
  • REF-003: [参考的标准或框架]
undefined