SKILL.md
readonlyread-only
name
create-architectural-decision-record
description
建立一份架構決策記錄(ADR)文件,用於 AI 優化的決策文件化。
建立架構決策記錄
為 ${input:DecisionTitle} 建立一份 ADR 文件,採用結構化格式,同時優化 AI 處理與人類閱讀。
輸入
- 背景:
${input:Context} - 決策:
${input:Decision} - 替代方案:
${input:Alternatives} - 利害關係人:
${input:Stakeholders}
輸入驗證
如果任何必要輸入未提供或無法從對話歷史中確定,請要求使用者提供遺漏的資訊,再繼續產生 ADR。
需求
- 使用精確、無歧義的語言
- 遵循標準 ADR 格式,包含 front matter
- 同時包含正面與負面後果
- 記錄替代方案及其拒絕理由
- 結構化以利機器解析與人類參考
- 對於多項目章節,使用編碼項目符號(3-4 字母代碼 + 3 位數字)
ADR 必須儲存在 /docs/adr/ 目錄中,命名規則為:adr-NNNN-[title-slug].md,其中 NNNN 是下一個順序的 4 位數字(例如 adr-0001-database-selection.md)。
必要文件結構
文件必須遵循以下範本,確保所有章節適當填寫。Markdown 的 front matter 應按照以下範例正確結構化:
---
title: "ADR-NNNN: [決策標題]"
status: "Proposed"
date: "YYYY-MM-DD"
authors: "[利害關係人姓名/角色]"
tags: ["architecture", "decision"]
supersedes: ""
superseded_by: ""
---
# ADR-NNNN: [決策標題]
## 狀態
**Proposed** | Accepted | Rejected | Superseded | Deprecated
## 背景
[問題陳述、技術限制、業務需求及需要此決策的環境因素。]
## 決策
[選擇的解決方案及其明確的選擇理由。]
## 後果
### 正面
- **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**:[參考的標準或框架]






