38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
|
|
# 完成架構 (Finalize Architecture) 技能指南
|
|||
|
|
|
|||
|
|
## 概述
|
|||
|
|
`finalize-architecture` 是 Architect Pipeline 的最後一個步驟,在挑戰審查與修訂完成後,對架構文件進行最終完整性檢查與格式驗證。
|
|||
|
|
|
|||
|
|
## 輸入與輸出
|
|||
|
|
### 輸入
|
|||
|
|
- `docs/architecture/{feature}.md`
|
|||
|
|
|
|||
|
|
### 輸出
|
|||
|
|
- 最終 `docs/architecture/{feature}.md`
|
|||
|
|
|
|||
|
|
## 驗證步驟
|
|||
|
|
1. **章節完整性檢查**:18 個必備章節是否都存在與實質內容
|
|||
|
|
2. **Mermaid 圖表驗證**:至少 3 張圖表(System、Sequence、Data Flow)、語法正確、無孤兒元件
|
|||
|
|
3. **資料庫 Schema 驗證**:所有表格含欄位、類型與限制式、索引有理由
|
|||
|
|
4. **API 合約驗證**:所有端點含方法、路徑、請求/回應結構
|
|||
|
|
5. **ADR 驗證**:至少 1 個 ADR,含 Context、Decision、Consequences、Alternatives
|
|||
|
|
6. **可追溯性驗證**:每個元素是否可追溯到 PRD 需求
|
|||
|
|
7. **格式驗證**:章節順序、Markdown 語法、無外部檔案參照
|
|||
|
|
8. **架構審查閘道**:確認挑戰審查的 Gate Decision 是否為 PASS 或 CONDITIONAL PASS
|
|||
|
|
|
|||
|
|
## 完成檢查清單
|
|||
|
|
- [ ] 18 個必備章節存在且實質(或是 N/A with reason)
|
|||
|
|
- [ ] 至少 3 張 Mermaid 圖表
|
|||
|
|
- [ ] Database Schema 有完整表格定義
|
|||
|
|
- [ ] API Contract 有完整端點規格
|
|||
|
|
- [ ] 至少 1 個 ADR 且格式完整
|
|||
|
|
- [ ] 所有元素可追溯到 PRD 需求
|
|||
|
|
- [ ] 架構審查閘道為 PASS 或 CONDITIONAL PASS
|
|||
|
|
- [ ] Risks 區段已填寫
|
|||
|
|
- [ ] Open Questions 區段已填寫(或明確寫 None)
|
|||
|
|
|
|||
|
|
## 不應做的事
|
|||
|
|
- 不設計新架構
|
|||
|
|
- 不改變架構決策
|
|||
|
|
- 不新增未在挑戰審查中驗證的重大內容
|
|||
|
|
- 不產生 `docs/architecture/{feature}.md` 以外的檔案
|