---
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/) 许可发布。
