---
source: ../../../core/design-document-standards.md
source_version: 1.0.0
translation_version: 1.0.0
last_synced: 2026-04-10
status: current
---

# 設計文件標準

> 版本: 1.0.0 | 最後更新: 2026-04-01

## 概述

本文件定義軟體專案中建立、維護與審查設計文件的標準，涵蓋高階設計（HLD）與低階設計（LLD）結構、文件生命週期管理、C4 Model 架構圖慣例、設計決策記錄與系統性設計審查。

## 高階設計（HLD）

每份 HLD 必須包含以下 6 個章節：

| 章節 | 目的 |
|------|------|
| **1. 概述** | 定義問題陳述、專案目標與成功標準 |
| **2. 架構** | 描述系統架構決策與元件關係 |
| **3. 資料流** | 描述資料如何在系統中流動 |
| **4. API 介面** | 定義系統對外暴露的介面 |
| **5. 非功能性需求** | 定義品質屬性與限制條件 |
| **6. 里程碑** | 定義實作時程與交付階段 |

## 低階設計（LLD）

每份 LLD 必須包含以下 5 個章節：

| 章節 | 目的 |
|------|------|
| **1. 元件設計** | 定義元件的內部結構 |
| **2. 資料模型** | 定義資料 Schema 與關係 |
| **3. 演算法細節** | 描述關鍵演算法與其複雜度 |
| **4. 錯誤處理** | 定義錯誤情境與恢復策略 |
| **5. 測試策略** | 定義元件的測試方法 |

## 文件生命週期

```
Draft → In Review → Approved → Implemented → Archived
草稿     審查中       已核准       已實作         已封存
```

| 狀態 | 定義 | 進入條件 | 退出條件 |
|------|------|---------|---------|
| **草稿** | 初始建立與迭代 | 作者開始撰寫 | 提交審查 |
| **審查中** | 同儕審查與回饋 | 已提交審查 | 所有審查者核准或拒絕 |
| **已核准** | 接受實作 | 審查通過 | 實作開始 |
| **已實作** | 設計已實現於程式碼中 | 程式碼符合設計 | 系統於生產環境穩定 |
| **已封存** | 不再活躍，保留供參考 | 系統退役或設計被取代 | 不適用 |

## 架構圖 — C4 Model

| 層級 | 名稱 | 範圍 | 適用情境 |
|------|------|------|---------|
| **L1** | **Context** | 系統與外部角色 | 利害關係人溝通 |
| **L2** | **Container** | 應用程式與資料存儲 | 技術概覽、部署規劃 |
| **L3** | **Component** | 內部元件 | 開發者入門、詳細設計 |
| **L4** | **Code** | 類別/模組層級 | 複雜演算法文件 |

## 設計決策記錄

每個重要設計決策必須記錄以下欄位：

| 欄位 | 用途 |
|------|------|
| **Options** | 列出已考慮的替代方案 |
| **Decision** | 所選方案 |
| **Rationale** | 選擇該方案的理由 |
| **Constraints** | 影響決策的限制條件 |
| **Consequences** | 預期的正面與負面影響 |

## 設計審查清單

設計文件須依以下 5 個維度審查：

| 維度 | 檢查重點 |
|------|---------|
| **正確性** | 滿足功能需求、處理邊界情況 |
| **擴展性** | 支援預期負載成長、瓶頸識別 |
| **安全性** | 認證授權、加密、輸入驗證 |
| **可維護性** | 元件邊界清晰、相依性最小化 |
| **可操作性** | 部署策略、監控告警、災難恢復 |

---

**相關標準：**
- [ADR 標準](adr-standards.md) - Architecture Decision Records
- [API 設計標準](api-design-standards.md) - API 介面設計

---

## 授權

本標準以 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 授權釋出。
