概要设计 on Liangweidong's blog

项目全流程模板实战：从启动会议到年终总结的 8 阶段可复用模板

Mon, 15 Dec 2025 00:00:00 +0800

之前在项目全流程：瀑布式 7 阶段 + BRD/MRD/PRD 文档体系写过流程和方法论。但日常真正用得多的不是"流程怎么走"，而是**“启动会议纪要怎么写”、“需求调研清单长啥样”、“运维日报格式”**——这些可复用的具体模板。本篇把 8 个阶段的实战模板一次性整理好，下载即用。

本文写于 2025 年 12 月——站在行业角度，把 5+ 年项目实践中沉淀的"会议纪要 / 调研清单 / 设计模板 / 测试用例 / 运维报表 / 年终总结"全部公开。

阅读对象：项目经理、技术负责人、想统一团队文档规范的工程师 覆盖范围：8 阶段（启动 / 需求 / 设计 / 开发 / 测试 / 运维 / 日常 / 管理）实战模板，全部可直接套用

一、为什么需要模板

团队文档"五乱现象"：

乱格式：A 用 docx、B 用 md、C 用 wiki、D 写纸上
乱命名：“需求 v1.0”、“需求 v1.0(2)"、“需求-最终版”、“需求-最终版-真的不改了”
乱内容：该有的章节没有，不该写的写了一堆
乱责任人：会议纪要没人写 / 写了没人跟 / 跟了没结果
乱归档：项目结束找文档，散落在 5 个工具 10 个目录里

模板的价值：

团队成员看一眼就懂怎么写
格式统一便于归档检索
关键字段不遗漏（日期、责任人、deadline）
历史项目可对比——格式一致才能横向比较

二、阶段 1：启动阶段模板

2.1 启动会议纪要模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66


# XX 项目启动会议纪要

## 基本信息
- **项目名称**：XX 业务系统
- **会议时间**：2025-XX-XX 14:00-16:00
- **会议地点**：XX 会议室 / 腾讯会议
- **会议主持**：XX（PM）
- **记录人**：XX
- **参会人员**：XX、XX、XX、XX（甲方）；XX、XX、XX（乙方）

## 项目背景
（一段话说明为什么要做这个项目，业务驱动是什么）

## 项目目标
1. 业务目标：覆盖 XX 场景，提升 XX 效率
2. 技术目标：高可用 XX%，日均处理 XX 单
3. 时间目标：2025 年 12 月 31 日前上线
4. 质量目标：P0/P1 缺陷 < X 个，P2 缺陷 < X 个

## 项目范围
### 包含（In Scope）
- 模块 A：XX 功能
- 模块 B：XX 功能
### 不包含（Out of Scope）
- 模块 C：（后期规划）
- 模块 D：（明确不做）

## 关键里程碑
| 阶段 | 时间 | 交付物 | 负责人 |
|---|---|---|---|
| 需求确认 | 2025-XX-XX | PRD 终稿 | XX |
| 概要设计 | 2025-XX-XX | 概要设计文档 | XX |
| 详细设计 | 2025-XX-XX | 详细设计文档 | XX |
| 开发完成 | 2025-XX-XX | 可测试版本 | XX |
| 系统测试 | 2025-XX-XX | 测试报告 | XX |
| UAT 验收 | 2025-XX-XX | UAT 报告 | XX |
| 正式上线 | 2025-XX-XX | 上线报告 | XX |

## 资源分配
- **产品**：XX
- **前端**：XX、XX
- **后端**：XX、XX
- **测试**：XX
- **运维**：XX
- **设计**：XX

## 风险评估
| 风险项 | 等级 | 应对措施 | 负责人 |
|---|---|---|---|
| XX 人员变动 | 高 | 提前知识共享 | XX |
| 第三方接口不稳定 | 中 | 提前 mock 联调 | XX |
| 客户需求变更 | 高 | 走变更控制流程 | XX |

## 沟通机制
- **日站会**：每天 9:00-9:15（钉钉会议）
- **周例会**：每周一 14:00-15:00
- **月例会**：每月最后一个周五
- **紧急沟通**：钉钉 / 微信

## 遗留问题
- [ ] XX 接口文档待客户提供
- [ ] XX 流程待 XX 确认

---

**下次会议**：2025-XX-XX 14:00

2.2 启动会议检查清单

1
2
3
4
5
6
7
8


启动会议必答 7 问：
1. 项目目标是？（业务 / 技术 / 时间 / 质量）
2. 项目范围是？（in / out）
3. 关键里程碑是？（按阶段列）
4. 资源是否到位？（人员 / 设备 / 预算）
5. 风险预判是？（3-5 个 top 风险）
6. 沟通机制是？（日 / 周 / 月 / 紧急）
7. 客户方对接人是？（PM / 业务 / 技术）

三、阶段 2：需求阶段模板

3.1 需求调研清单

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54


# XX 模块需求调研清单

## 一、业务背景
1. 当前痛点是什么？
 - 问题 1：XX
 - 问题 2：XX
2. 业务目标是什么？
 - 提升 XX 效率
 - 降低 XX 成本
3. 关键指标（KPI）？
 - 订单处理时间从 5 分钟降到 30 秒
 - 错误率从 2% 降到 0.1%

## 二、用户角色
| 角色 | 描述 | 关键诉求 |
|---|---|---|
| 管理员 | 系统配置 | 简单配置界面 |
| 操作员 | 日常业务 | 流程清晰 |
| 审计员 | 事后审计 | 完整日志 |

## 三、核心场景
### 场景 1：XX 操作
1. 用户：操作员
2. 入口：XX 页面
3. 流程：步骤 1 → 步骤 2 → 步骤 3
4. 成功结果：XX
5. 失败处理：XX

### 场景 2：XX 操作
...

## 四、功能性需求
### FR-001：XX 功能
- 描述：用户可以在 XX 页面 XX 操作
- 优先级：P0
- 验收标准：
 - [ ] 步骤 1 成功
 - [ ] 步骤 2 成功
 - [ ] 异常情况正确处理

## 五、非功能性需求
- 性能：QPS ≥ 1000，RT ≤ 200ms
- 可用性：99.9%
- 安全性：通过等保三级
- 兼容性：Chrome / Edge / Safari 最新版

## 六、约束条件
- 必须对接 XX 已有系统
- 必须使用 XX 技术栈
- 数据库必须用 MySQL 8.0

## 七、待澄清问题
- [ ] XX 业务规则待客户确认
- [ ] XX 字段定义待 XX 提供

3.2 BRD / MRD / PRD 模板速查

文档	受众	重点	模板要点
BRD（Business Requirements Document）	高管 / 业务方	为什么要做、ROI 多少	业务背景、商业价值、投入产出
MRD（Market Requirements Document）	产品 / 市场	市场分析、竞品对比	市场规模、竞品分析、差异化
PRD（Product Requirements Document）	开发 / 测试	具体做什么、怎么做	用户故事、流程图、原型、字段定义

四、阶段 3：设计阶段模板

4.1 概要设计文档

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101


# XX 系统概要设计说明书

## 1. 引言
### 1.1 编写目的
本文档描述 XX 系统的概要设计方案，作为详细设计、开发和测试的依据。

### 1.2 背景
- 系统名称：XX
- 任务提出者：XX
- 开发者：XX
- 用户：XX

### 1.3 参考资料
- 《XX 系统需求规格说明书》v1.0
- 《XX 项目启动会议纪要》

### 1.4 术语定义
- SaaS：软件即服务
- SLA：服务等级协议

## 2. 设计概述
### 2.1 任务和目标
实现 XX 功能，满足性能 / 可靠性 / 扩展性要求。

### 2.2 运行环境
- 服务器：CentOS 7.6 / Ubuntu 22.04
- 中间件：Nginx / Tomcat / MySQL / Redis / Kafka
- 编程语言：Java 17

### 2.3 条件与限制
- 必须兼容 XX 老系统
- 不能使用商业数据库
- 项目周期 6 个月

## 3. 系统详细需求分析
### 3.1 功能需求
| 编号 | 名称 | 优先级 | 描述 |
|---|---|---|---|
| FR-001 | 用户登录 | P0 | 用户名密码登录 |
| FR-002 | 订单创建 | P0 | 创建新订单 |
| FR-003 | 报表导出 | P1 | 导出 Excel |

### 3.2 性能需求
- 峰值 QPS：5000
- 平均 RT：≤ 200ms
- 数据库响应：≤ 50ms

## 4. 总体方案确认
### 4.1 系统总体结构
![系统架构图]

分层：
- 接入层：Nginx + SLB
- 网关层：Spring Cloud Gateway
- 业务层：Spring Boot 微服务
- 数据层：MySQL + Redis + ES

### 4.2 系统详细界面划分
- 前端：Web（H5） + 小程序 + 移动 App
- 后端：API 服务 + 后台管理系统

## 5. 系统详细设计
### 5.1 系统结构设计
**微服务划分**：
- user-service（用户中心）
- order-service（订单中心）
- payment-service（支付中心）
- notification-service（消息中心）
- gateway-service（API 网关）

### 5.2 系统功能模块详细设计
（采用 HIPO 图分解模块）

### 5.3 模块接口设计
- order-service → payment-service：HTTP REST
- order-service → notification-service：Kafka 消息
- user-service → order-service：gRPC

## 6. 数据库系统设计
### 6.1 数据库选型
- 主库：MySQL 8.0（InnoDB 引擎，utf8mb4）
- 缓存：Redis 7.0
- 搜索：Elasticsearch 8.x

### 6.2 数据库 ER 图
![ER 图]

### 6.3 核心表结构
```sql
CREATE TABLE `t_order` (
 `id` bigint(20) NOT NULL AUTO_INCREMENT,
 `order_no` varchar(32) NOT NULL COMMENT '订单号',
 `user_id` bigint(20) NOT NULL,
 `amount` decimal(10,2) NOT NULL,
 `status` tinyint(4) NOT NULL DEFAULT '0',
 `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 PRIMARY KEY (`id`),
 UNIQUE KEY `uk_order_no` (`order_no`),
 KEY `idx_user_id` (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单表';

7. 接口设计

（详见《接口设计文档》）

8. 性能设计

读写分离：主库写 / 从库读
分库分表：orders 表按 user_id 哈希 64 张
缓存：热点数据 Redis 缓存
消息队列：异步任务用 Kafka

9. 安全设计

鉴权：JWT Token
数据传输：全站 HTTPS
密码加密：BCrypt
敏感数据：脱敏存储 / 脱敏展示
防 SQL 注入：MyBatis 参数化
防 XSS：前端转义 + 后端过滤
防 CSRF：Token 机制

10. 部署设计

部署方式：Kubernetes
副本数：每个微服务 ≥ 3 副本
自动扩缩容：CPU > 70% 扩容，< 30% 缩容

11. 监控设计

业务监控：Prometheus + Grafana
链路追踪：SkyWalking
日志聚合：Loki / ELK
告警：钉钉 / 邮件 / 飞书

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32



### 4.2 详细设计文档（关键模块）

**只对核心模块做详细设计**（用户量大 / 业务复杂 / 风险高的）：

```markdown
# 订单创建详细设计

## 1. 模块编号
MODULE-ORDER-CREATE-001

## 2. 模块名称
订单创建

## 3. 输入
- 用户 ID
- 商品列表（SKU + 数量）
- 收货地址
- 优惠码（可选）
- 支付方式

## 4. 处理
1. 参数校验
2. 风控检查（防刷单）
3. 库存预占（Redis DECR）
4. 价格计算
5. 订单写入（事务）
6. 库存扣减（异步）
7. 消息发送（Kafka）

## 5. 算法描述
### 5.1 库存预占算法

查 Redis 库存：GET stock:sku:{skuId}
检查库存 ≥ 请求数量
扣减：DECRBY stock:sku:{skuId} {qty}
设置预占标记：SET prehold:order:{orderId} {skuId}:{qty} EX 600
失败回滚：INCRBY stock:sku:{skuId} {qty}

1
2

### 5.2 价格计算

总价 = sum(商品单价 × 数量) 优惠 = 满减 + 优惠券 + 会员折扣实付 = max(总价 - 优惠, 0.01)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17



## 6. 输出
- 成功：order_no, pay_url, expire_at
- 失败：错误码 + 错误信息

## 7. 异常处理
| 异常 | 处理 |
|---|---|
| 库存不足 | 释放预占 + 提示 |
| 用户风控 | 拒绝 + 记录日志 |
| 支付失败 | 30 分钟内可重试 |
| 系统异常 | 全局回滚 + 告警 |

## 8. 性能指标
- 期望 QPS：1000
- RT 目标：≤ 200ms
- 99 线：≤ 500ms

五、阶段 4：开发阶段模板

5.1 Git Commit 规范

1
2
3
4
5


<type>(<scope>): <subject>

<body>

<footer>

type 必填：

feat：新功能
fix：修复 bug
docs：文档
style：代码格式（不影响逻辑）
refactor：重构
perf：性能优化
test：测试
chore：构建 / 工具

示例：

1
2
3
4
5
6
7
8


feat(order): 支持拼团订单创建

新增拼团业务逻辑：
- 拼团订单写入独立表 t_group_buy
- 拼团成功后批量更新普通订单
- 失败时 24h 自动退款

Closes #123

5.2 Code Review 检查清单

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


Code Review Checklist：
- [ ] 代码符合团队规范（命名 / 格式 / 注释）
- [ ] 没有重复代码（DRY）
- [ ] 函数 / 类职责单一（SRP）
- [ ] 关键路径有日志
- [ ] 异常处理正确
- [ ] 单元测试覆盖
- [ ] SQL 性能（避免 SELECT * / 避免 N+1）
- [ ] 安全（SQL 注入 / XSS / 越权）
- [ ] 配置外化（不硬编码）
- [ ] 文档 / 注释更新

5.3 提测清单

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


# XX 模块提测清单

## 提测信息
- **模块名称**：XX
- **提测版本**：v1.0.0
- **提测人**：XX
- **提测时间**：2025-XX-XX
- **测试人**：XX
- **预计测试时间**：3 天

## 提测内容
### 新功能
1. 用户登录（FR-001）
2. 订单创建（FR-002）
3. 报表导出（FR-003）

### 修复 Bug
1. 修复 #123 订单重复创建
2. 修复 #456 库存显示错误

## 已知问题
- [ ] 性能未优化
- [ ] 国际化未完成

## 配置文件
- 数据库：10.0.1.100:3306 / order_db
- Redis：10.0.1.101:6379
- 测试账号：test / {{TEST_PASS}}

## 提测说明
- 部署地址：https://test.example.com
- 源码地址：https://git.example.com/order-service
- 接口文档：https://wiki.example.com/api/order

六、阶段 5：测试阶段模板

6.1 测试用例模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31


# XX 模块测试用例

## TC-001：用户登录成功
- **模块**：用户中心
- **优先级**：P0
- **前置条件**：存在账号 test@example.com / {{PWD}}
- **步骤**：
 1. 打开登录页
 2. 输入邮箱 test@example.com
 3. 输入密码
 4. 点击"登录"
- **期望**：跳转到首页，显示用户名

## TC-002：用户登录密码错误
- **模块**：用户中心
- **优先级**：P0
- **前置条件**：存在账号 test@example.com
- **步骤**：
 1. 打开登录页
 2. 输入邮箱 test@example.com
 3. 输入错误密码 "wrong"
 4. 点击"登录"
- **期望**：提示"密码错误"，不跳转

## TC-003：用户登录连续 5 次失败
- **模块**：用户中心
- **优先级**：P1
- **前置条件**：账号未被锁定
- **步骤**：
 1. 连续 5 次输入错误密码
- **期望**：账号被锁定 30 分钟，提示"账号已锁定"

6.2 缺陷报告模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


# 缺陷报告 #001

## 缺陷信息
- **标题**：订单提交后未生成订单号
- **模块**：订单中心
- **严重程度**：P0（阻塞主流程）
- **优先级**：紧急
- **发现人**：XX
- **发现时间**：2025-XX-XX
- **指派人**：XX

## 复现步骤
1. 登录账号 test@example.com
2. 选择商品 A 加入购物车
3. 点击"提交订单"
4. 查看订单列表

## 期望结果
订单列表中应该有一个新订单，订单号 = "OD20250315001"

## 实际结果
订单列表为空，控制台报 500 错误

## 截图
[图：500 错误]

## 错误日志

java.lang.NullPointerException at OrderService.createOrder:124

1
2
3
4



## 修复建议
OrderService.createOrder 第 124 行：orderNoGenerator.generate() 返回 null，
可能是 Redis 连接失败导致 ID 生成器初始化失败

6.3 性能测试报告模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33


# XX 系统性能测试报告

## 测试信息
- **测试时间**：2025-XX-XX
- **测试人**：XX
- **测试工具**：JMeter 5.5 / wrk
- **测试环境**：生产等配（4 核 8G × 3 节点）

## 测试场景
### 场景 1：登录接口
- 并发：100
- 持续时间：5 分钟
- 期望 RT：≤ 200ms
- 期望 QPS：≥ 500

## 测试结果
| 指标 | 实测 | 期望 | 结论 |
|---|---|---|---|
| 平均 QPS | 680 | ≥ 500 | ✅ |
| 平均 RT | 145ms | ≤ 200ms | ✅ |
| P99 RT | 320ms | ≤ 500ms | ✅ |
| 错误率 | 0.02% | ≤ 0.1% | ✅ |

## 性能瓶颈
1. 数据库连接池不够（100 并发只够 50）
 - 优化：调大 hikariCP.maximumPoolSize=200
2. Redis pipeline 未用
 - 优化：批量操作改用 pipeline

## 优化建议
1. 引入 Redis 缓存（首屏加载提速 50%）
2. 数据库读写分离
3. 接口合并（10 个接口合并成 1 个）

七、阶段 6：运维阶段模板

7.1 运维日报模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38


# 运维日报 - 2025-XX-XX

## 值班信息
- **值班人**：XX
- **值班时间**：00:00-24:00
- **联系方式**：{{PHONE}}

## 系统状态
- **整体状态**：✅ 正常
- **核心服务**：✅ 正常
- **数据库**：✅ 正常（主从延迟 0.5s）
- **缓存**：✅ 正常
- **消息队列**：✅ 正常（积压 0）

## 业务指标
- **日活用户**：10.2 万（环比 +5%）
- **订单数**：3.5 万（环比 +8%）
- **支付金额**：{{AMOUNT}}（环比 +12%）
- **接口 QPS**：平均 1200，峰值 3500
- **错误率**：0.05%

## 告警记录
| 时间 | 内容 | 等级 | 处理人 | 状态 |
|---|---|---|---|---|
| 14:23 | 订单接口 RT 飙升至 800ms | P1 | XX | 已处理 |
| 18:30 | Redis 内存使用 75% | P2 | XX | 监控中 |

## 变更操作
- 10:00 XX 服务发版 v1.2.3（XX 提交）
- 15:30 扩容 order-service 副本数 3→5

## 待办事项
- [ ] XX 数据库主从延迟监控告警规则待优化
- [ ] XX 证书下月到期需续期

## 明日计划
- 03:00 订单服务滚动发版
- 09:00 XX 项目联调

7.2 故障报告模板（Postmortem）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39


# 故障复盘报告 - 2025-XX-XX XX 故障

## 故障信息
- **故障名称**：XX 服务不可用
- **故障时间**：2025-XX-XX 14:30 - 15:45（持续 75 分钟）
- **影响范围**：XX 功能不可用，影响 XX 用户
- **业务影响**：订单损失 {{AMOUNT}}
- **故障等级**：P0

## 时间线
| 时间 | 事件 | 操作人 |
|---|---|---|
| 14:30 | 告警：订单服务 RT > 5s | 系统 |
| 14:35 | 值班人介入 | XX |
| 14:40 | 确认数据库连接池耗尽 | XX |
| 14:50 | 重启 order-service，临时恢复 | XX |
| 15:00 | 再次告警，确认是 Redis 大 Key 阻塞 | XX |
| 15:20 | 删除大 Key，服务恢复 | XX |
| 15:45 | 监控观察 15 分钟无异常 | XX |

## 根因分析
订单服务依赖 Redis 中的用户信息缓存，**XX 业务在 14:00 写入了一个 1.2GB 的大 Key**（单用户订单数据），**导致 Redis 单线程阻塞**。

**根因**：
- 业务代码 **未对写入数据做大小限制**
- 监控未对 Redis 大 Key 告警

## 改进措施
| 措施 | 负责人 | Deadline |
|---|---|---|
| Redis 写入数据大小限制（< 1MB） | XX | 2025-XX-XX |
| 监控增加 Redis 大 Key 告警（> 100MB） | XX | 2025-XX-XX |
| 业务代码评审增加"单 Key 大小"检查项 | XX | 长期 |
| 数据库连接池按业务分级 | XX | 2025-XX-XX |

## 经验教训
- **缓存不是万能的**：写入也可能拖慢服务
- **大 Key 是定时炸弹**：必须监控 + 限制
- **告警覆盖要全**：不能只看 QPS / RT，**也要看数据本身**

7.3 上线变更单

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


# 上线变更单 - 2025-XX-XX

## 变更信息
- **变更标题**：XX 服务发版 v1.2.3
- **变更类型**：功能发布
- **申请人**：XX
- **审核人**：XX
- **变更时间**：2025-XX-XX 02:00-04:00
- **影响范围**：XX 模块 / XX 接口

## 变更内容
- 新增 XX 功能（需求 #123）
- 修复 XX bug（缺陷 #456）
- 性能优化 XX（压测提升 20%）

## 变更步骤
1. [ ] 备份当前版本配置
2. [ ] 滚动发版 order-service:v1.2.3
3. [ ] 健康检查（30s 内）
4. [ ] 关键接口冒烟测试
5. [ ] 监控观察 1 小时
6. [ ] 关闭变更工单

## 回滚方案
- 命令：`kubectl rollout undo deployment/order-service`
- 数据回滚：本次无 DDL，无需数据回滚
- 预计回滚时间：5 分钟

## 风险评估
| 风险 | 等级 | 应对 |
|---|---|---|
| 新版本引入 bug | 中 | 1 小时监控窗口 |
| 缓存击穿 | 低 | 限流保护 |
| 第三方接口超时 | 低 | 重试 3 次 |

## 审批
- [ ] 申请人：XX
- [ ] 审核人：XX
- [ ] 运维：XX
- [ ] PM：XX

八、阶段 7：日常阶段模板

8.1 周报模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


# XX 周报 - 第 XX 周（2025-XX-XX ~ 2025-XX-XX）

## 本周完成
- ✅ XX 模块开发完成
- ✅ XX 接口联调通过
- ✅ 修复 XX bug（#123, #456）

## 下周计划
- [ ] XX 模块开发
- [ ] XX 模块联调
- [ ] XX 模块提测

## 风险与问题
1. **XX 接口响应慢**（P1）
 - 现象：RT 800ms
 - 影响：用户投诉
 - 进展：已定位是数据库慢 SQL，索引待加
2. **XX 人员变动**
 - XX 同学下月离职
 - 需要招人 / 知识共享

## 数据指标
- 需求完成率：60%（12/20）
- 缺陷修复率：80%（16/20）
- 代码提交：32 commits

8.2 月报模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


# XX 项目月报 - 2025 年 XX 月

## 项目总览
- **项目阶段**：开发 / 测试 / 试运行
- **整体进度**：60%（计划 65%）
- **风险等级**：中

## 本月里程碑
| 里程碑 | 计划 | 实际 | 偏差 |
|---|---|---|---|
| 需求确认 | 04-15 | 04-18 | +3 天 |
| 概要设计 | 04-30 | 04-30 | 准时 |
| 详细设计 | 05-15 | 进行中 | - |

## 关键指标
- 需求完成：30 / 50（60%）
- Bug 修复：40 / 50（80%）
- 代码提交：120 commits
- 联调通过：15 / 20（75%）

## 资源投入
- **开发**：12 人 × 22 天
- **测试**：3 人 × 10 天
- **运维**：2 人 × 5 天

## 主要问题
1. **第三方接口不稳定**：
 - 现象：调用 XX 接口超时率 10%
 - 应对：已加超时重试 + 降级方案
2. **人员不足**：
 - 后端缺 1 人
 - 已启动招聘

## 下月计划
- 完成全部 50 个需求开发
- 完成系统测试
- UAT 启动

九、阶段 8：管理阶段模板

9.1 部门年终总结模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47


# 2025 年部门年终总结

## 一、项目完成情况
- **总数**：本年完成 15 个大型项目 + 20 个小型项目
- **按时交付率**：70%
- **延期率**：20%（平均延期 15 天）
- **取消率**：10%

### 重点项目
1. **项目 A**（XX 客户 ERP）
 - 按时交付，质量达标，客户非常满意
 - 难点：数据迁移 + 系统集成
2. **项目 B**（零售电商）
 - 因需求变更延期 1 个月交付
 - 客户最终满意
3. **项目 C**（移动应用）
 - 按时交付，后期性能问题已优化

## 二、团队绩效
- **人员规模**：XX 人（年初 X → 年末 X）
- **代码提交**：平均 +15%
- **Bug 率**：下降 10%
- **培训**：组织 XX 次技术分享
- **新工具引入**：Jira / Confluence / 飞书

## 三、技术创新
- **微服务架构**：覆盖 XX 项目
- **云原生**：K8s / Docker 全栈
- **AI 应用**：XX 场景
- **数据库**：升级到 MySQL 8.0

## 四、客户反馈
- **正面**：85% 客户表示满意
- **负面**：高峰期响应慢（已修复）
- **NPS 评分**：8.5/10

## 五、问题与不足
1. 需求变更管理不规范
2. 测试覆盖度不够
3. 文档沉淀不足
4. 跨部门协作效率低

## 六、明年规划
- **项目管理**：引入敏捷 + Scrum
- **技术创新**：AI / 区块链深入
- **团队建设**：技术培训 + 文化建设
- **客户管理**：满意度提升到 90%

9.2 个人年终总结模板

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


# 2025 年个人年终总结 - XX

## 一、本人工作
### 项目贡献
- 项目 A：负责 XX 模块，**提前 1 周交付**
- 项目 B：解决 XX 难题，**节省 XX 工时**
- 项目 C：性能优化，**QPS 提升 3 倍**

### 技术成长
- 学习 XX 技术栈
- 主导 XX 方案设计
- 输出 XX 篇技术文档

## 二、绩效数据
- 需求完成：XX 个（超出 XX%）
- 代码质量：Bug 率 < 1%
- 团队贡献：带新人 XX 名

## 三、问题反思
- XX 决策考虑不周
- XX 沟通效率低
- XX 技术深度不够

## 四、明年规划
- **业务**：承接更重要项目
- **技术**：深入 XX 领域
- **管理**：带 XX 人小团队
- **学习**：XX 认证 / 培训

十、模板使用建议

10.1 不要"全用”

小项目（< 1 个月）：只需要周报 + 提测清单
大项目（> 3 个月）：全流程模板都用
个人开发者：只需要 git commit + 周报

10.2 模板要"活"用

格式可以微调（但保留关键字段）
章节可以根据项目裁剪（但不要全删）
结合团队实际情况（但不要"无中生有"）

10.3 模板要"持续迭代"

每季度 review 一次
收集"用得不顺"的地方
改进后通知全员

10.4 模板要"轻量"

不要追求完美格式——能用就行
不要堆砌图表——数据 > 形式
不要写大段废话——说人话

十一、配套工具推荐

工具	用途	模板
语雀	知识库 / 文档	概要设计、需求、复盘
Confluence	团队 Wiki	启动会议、设计、决策记录
飞书 / 钉钉	沟通 / 审批	周报、日报、变更单
Notion	文档 + 数据库	需求跟踪、缺陷管理
Jira / 禅道	需求 / 任务	需求、Bug、Sprint

生产推荐组合：

小型团队：语雀 + 钉钉 + GitHub Issues
中大型团队：Confluence + Jira + 飞书 / 钉钉
外企 / 国际化：Notion + Linear + Slack

十二、最佳实践清单

所有文档放同一处——避免散落
关键字段必填——日期 / 责任人 / 状态
会议纪要 24h 内发出——避免遗忘
周报同一天提交——建立节奏
故障复盘 1 周内完成——趁热打铁
缺陷 / 需求有唯一编号——可追溯
模板持续迭代——每年 review 一次
配合自动化——CI/CD / 监控减少手写
重要文档双语——外企必备
历史归档——项目结束后 1 年内可查

十三、与其他阶段的衔接

当前模板	产出	下一阶段模板
启动会议	目标 / 范围 / 里程碑	需求调研
需求调研	PRD / 用户故事	概要设计
概要设计	系统架构 / 接口	详细设计
详细设计	模块设计 / 算法	提测清单
提测清单	测试范围	测试用例
测试用例	用例 / 缺陷	性能测试
性能测试	性能指标	上线变更
上线变更	上线操作	运维日报
运维日报	每日状态	月报 / 年终

形成闭环：每个阶段的输出是下个阶段的输入。

下一步

想看 项目全流程 7 阶段方法论（瀑布式）→ 项目全流程：瀑布式 7 阶段
想看 架构设计基础（概要 vs 详细）→ 架构设计基础
想看 敏捷开发协作（22 款 CI 工具）→ 敏捷开发协作
想看 JDK 自建镜像实战（容器化基础）→ JDK 自建镜像实战

2024+ 视角（模板升级：从静态文档到 AI + 工具链）

2025 年写的 8 阶段模板，在 2024-2026 年的"AI 时代"有几条升级路径：

AI 辅助生成阶段物：
- LLM 拆解用户故事：粘贴 PRD 一段，AI 自动拆成 N 个 Story + 验收标准 + 边界用例
- AI 生成测试用例：给定接口契约，AI 自动出 50+ 用例（正常 / 异常 / 边界 / 安全）
- AI 评审代码 / ADR：Copilot Review / Coderabbit 自动给 PR 提建议
模板从 Word 转向 Wiki + LLM Prompt：
- 启动会议纪要 → Notion / 飞书模板 + LLM 摘要
- 概要设计 → Mermaid + ADR + Confluence
- 测试用例 → 表格化 + 自动同步到 TestRail / Zentao
协作工具栈推荐（2024-2026）：
- 小团队（< 10 人）：Notion + Linear + Slack + GitHub
- 中大型（10-100 人）：Confluence + Jira + 飞书 + GitLab
- 外企/国际化：Notion + Linear + Slack + GitHub Enterprise
绩效数据自动化：
- Jira / Linear 自动统计：Story 完成率、Bug 修复率、PR 数、Code Review 数
- GitLab / GitHub 统计：commit 数、loc、活跃时间
- Sentry / Datadog 统计：故障率、MTTR
LLM 时代的新模板：
- Prompt 库模板：每个阶段都沉淀"经过验证的 Prompt"
- Agent 工作流模板：需求 Agent + 设计 Agent + 测试 Agent 的协作模板
- 知识库 RAG 模板：把团队历史文档喂给向量库，新人提问直接得到历史答案
SRE 化运维日报：
- 2025 年的运维日报已经不需要人手写——Prometheus + Grafana + ChatOps 自动汇总
- 模板保留，但使用频率下降到周/月级别
AIGC 时代的"反模板"提醒：
- 模板能提升下限，但会扼杀创新——小项目/创新业务别套全模板
- AI 生成的文档必须人工 review——LLM 会"自信地胡说"
- 关键决策必须有 ADR——不能被模板/AI 替代

核心升级逻辑：模板的"格式统一"价值在 2024 年依然存在，但"内容生成"价值已经被 AI 接管——团队需要把精力从"写文档"转向"评审文档 + 决策 + 沉淀知识"。这也是 2024+ 项目管理最大的范式转移。

详细设计实战：数据库 + 接口 + 概要设计的层次化文档

Mon, 15 Sep 2025 00:00:00 +0800

详细设计（Detailed Design）是项目从"概要"走向"可编码"的关键文档——它是程序员写代码的"施工图"。本文基于多年项目实践，给出一套层次化、可落地的详细设计实战模板。

本文写于 2025 年 9 月——敏捷开发的时代，详设不会过时，只是形式更轻量。

一、详细设计 vs 概要设计

维度	概要设计	详细设计
粒度	模块 / 子系统	函数 / 类 / 表
读者	架构师 / PM	程序员
目的	划定边界	指导编码
重点	架构图 / 模块划分	数据结构 / 算法 / 接口
产物	架构图 / 接口契约	类图 / 时序图 / 表结构
更新频率	季度	周 / 迭代

二、详细设计 7 大章节

2.1 章节结构总览

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


1. 引言
 1.1 编写目的
 1.2 背景
 1.3 参考资料
 1.4 术语定义及说明

2. 设计概述
 2.1 任务和目标
 2.2 需求概述
 2.3 运行环境概述
 2.4 条件与限制
 2.5 详细设计方法和工具

3. 系统详细需求分析
 3.1 详细需求分析
 3.2 详细系统运行环境及限制条件分析
 3.3 接口需求分析

4. 总体方案确认
 4.1 系统总体结构确认
 4.2 系统详细界面划分

5. 系统详细设计
 5.1 系统结构设计及子系统划分
 5.2 系统功能模块详细设计
 （采用 HIPO 图进行功能分解与模块描述）
 5.3 用 IPO 或结构图描述各模块的组成结构、算法、模块间的接口关系，
 以及需求、功能和模块三者之间的交叉参照关系
 5.4 系统界面详细设计

6. 数据库系统设计
 6.1 数据库概念设计（E-R 图）
 6.2 数据库逻辑设计（表结构）
 6.3 数据库物理设计（索引 / 分区）
 6.4 数据字典

7. 接口设计
 7.1 内部接口（模块间）
 7.2 外部接口（系统间）
 7.3 用户接口（UI）

三、章节 1：引言

3.1 编写目的

模板：

本文是某项目的详细设计文档，目的是：

明确系统的功能模块划分和接口关系

为程序员编码提供"施工图"

作为测试用例设计的依据

作为项目验收的标准

预期读者：项目开发工程师、测试工程师、架构师、产品经理

3.2 背景

模板：

项目名称：某业务系统委托单位：某部门开发单位：某研发部主管部门：某信息中心

3.3 参考资料

模板：

序号	文档名称	作者	日期	版本
1	需求规格说明书	张三	2025-09-01	V1.0
2	概要设计文档	李四	2025-09-10	V1.0
3	数据库设计规范	王五	2025-08-15	V2.0

3.4 术语定义

术语	解释
CRM	客户关系管理
ERP	企业资源计划
MES	制造执行系统
…	…

四、章节 2：设计概述

4.1 任务和目标

任务：完成某业务系统的详细设计，确保系统可实现性。

目标：

100% 覆盖需求规格说明书的功能点
性能指标：响应时间 < 2s，并发 1000+
可用性：99.9%
安全性：通过等保三级

4.2 需求概述

简要说明系统要实现的核心功能（不超过 5 页）：

用户管理（登录、权限、角色）
订单管理（创建、查询、修改、删除）
报表管理（日报、月报、季报）
系统管理（参数配置、日志审计）

4.3 运行环境

维度	描述
操作系统	Linux 7+ / Windows Server 2016+
Web 服务器	Nginx 1.20+
应用服务器	Tomcat 9 / Spring Boot 内嵌
数据库	MySQL 8.0+
缓存	Redis 6+
消息队列	RabbitMQ / Kafka
监控	Prometheus + Grafana
日志	ELK（Elasticsearch + Logstash + Kibana）

4.4 条件与限制

必须兼容 IE 11 浏览器（仅老系统迁移）
数据库必须使用 MySQL（甲方要求）
单台服务器资源：16 核 32G
项目周期：6 个月

4.5 详细设计方法和工具

设计方法：面向对象（OOAD）+ 结构化（SA/SD）
设计模式：MVC、Factory、Strategy、Observer
设计工具：PlantUML、draw.io、Visio
文档工具：Confluence + Markdown

五、章节 3：详细需求分析

5.1 功能需求矩阵

需求 ID	需求名称	优先级	详细说明
FR-001	用户登录	高	支持账密、SSO、扫码登录
FR-002	权限管理	高	RBAC 模型
FR-003	订单创建	高	包含订单明细
…	…	…	…

5.2 非功能需求

类别	指标
性能	响应时间 < 2s，并发 1000+
可用性	99.9%（年宕机 < 8.76 小时）
安全性	等保三级
兼容性	Chrome / Edge / Firefox 最新版
可维护性	模块独立部署

5.3 接口需求

内部接口：模块 A 调用模块 B 的接口
外部接口：与 CRM、ERP、支付的接口
数据接口：数据库、缓存、文件

六、章节 4：总体方案确认

4.1 系统总体结构

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


┌────────────────────────────────────┐
│ 表现层（Web/App） │
├────────────────────────────────────┤
│ API 网关（Gateway） │
├────────────────────────────────────┤
│ 业务服务层（订单 / 用户 / 报表） │
├────────────────────────────────────┤
│ 数据访问层（MyBatis / JPA） │
├────────────────────────────────────┤
│ 数据层（MySQL / Redis / MQ） │
└────────────────────────────────────┘

4.2 模块划分

模块编号	模块名称	职责
M-001	用户中心	登录、权限、SSO
M-002	订单中心	订单生命周期
M-003	报表中心	数据聚合、可视化
M-004	系统中心	字典、参数、日志

七、章节 5：系统详细设计（核心）

7.1 模块 HIPO 图

HIPO（Hierarchy plus Input-Process-Output） 是经典的结构化设计方法。

示例：订单中心 HIPO 图

1
2
3
4
5
6
7
8
9


 订单中心
 │
 ┌─────────────────┼─────────────────┐
 │ │ │
 订单创建 订单查询 订单修改
 │ │ │
 ┌────┴────┐ ┌───┴───┐ ┌────┴────┐
 │ │ │ │ │ │
 输入参数 业务规则 输入条件 返回结果 输入参数 业务规则

7.2 模块详细设计

每个模块都需要包含：

字段	描述
1. 模块编号	M-002
2. 模块名称	订单中心
3. 输入	订单数据 / 用户 ID / 操作类型
4. 处理	业务逻辑描述
5. 算法描述	伪代码 / 流程图
6. 输出	订单结果 / 错误码

7.3 模块 1：订单创建（M-002-001）

1. 模块编号：M-002-001

2. 模块名称：订单创建

3. 输入：

1
2
3
4
5
6
7
8
9


{
 "userId": "12345",
 "items": [
 {"productCode": "P001", "qty": 2, "price": 99.00},
 {"productCode": "P002", "qty": 1, "price": 199.00}
 ],
 "addressId": "A001",
 "remark": "请尽快发货"
}

4. 处理：

校验用户登录态
校验商品库存（每件商品）
校验地址有效性
计算订单总金额（含运费、优惠）
创建订单记录
冻结库存
返回订单号

5. 算法描述（伪代码）：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49


def create_order(user_id, items, address_id, remark):
 # 1. 校验登录
 user = check_login(user_id)
 if not user:
 return error(401, "未登录")

 # 2. 校验库存
 for item in items:
 stock = get_stock(item.product_code)
 if stock < item.qty:
 return error(400, f"商品 {item.product_code} 库存不足")

 # 3. 校验地址
 address = get_address(address_id)
 if not address or address.user_id != user_id:
 return error(400, "地址无效")

 # 4. 计算金额
 total = 0
 for item in items:
 total += item.qty * item.price
 shipping_fee = calc_shipping(address, total)
 discount = calc_discount(user, total)
 final_total = total + shipping_fee - discount

 # 5. 创建订单
 with transaction():
 order_no = generate_order_no()
 order = Order(
 order_no=order_no,
 user_id=user_id,
 status="待付款",
 total=final_total,
 remark=remark
 )
 order.save()

 for item in items:
 order_item = OrderItem(
 order_no=order_no,
 **item
 )
 order_item.save()

 # 6. 冻结库存
 for item in items:
 freeze_stock(item.product_code, item.qty, order_no)

 return success({"order_no": order_no, "total": final_total})

6. 输出：

1
2
3
4
5
6
7
8


{
 "code": 200,
 "data": {
 "orderNo": "SO20250915001",
 "total": 397.00,
 "payUrl": "https://pay.example.com/..."
 }
}

7.4 模块 2：订单查询（M-002-002）

输入：

1
2
3
4
5
6


{
 "userId": "12345",
 "page": 1,
 "size": 20,
 "status": "待发货"
}

处理：

分页查询订单主表
关联查询订单明细
返回结果

输出：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
 "code": 200,
 "data": {
 "total": 50,
 "list": [
 {
 "orderNo": "SO20250915001",
 "status": "待发货",
 "total": 397.00,
 "items": [...]
 }
 ]
 }
}

八、章节 6：数据库系统设计

8.1 E-R 图

1
2
3


用户 ──< 订单 >── 订单明细 >── 商品
 │
 └──< 支付

8.2 核心表设计

订单主表（t_order）：

字段	类型	必填	说明
order_no	VARCHAR(32)	Y	主键
user_id	BIGINT	Y	用户 ID
status	VARCHAR(20)	Y	订单状态
total_amount	DECIMAL(18,2)	Y	总金额
shipping_fee	DECIMAL(18,2)	Y	运费
discount	DECIMAL(18,2)	Y	优惠
final_amount	DECIMAL(18,2)	Y	实付金额
address_id	BIGINT	Y	收货地址 ID
remark	VARCHAR(500)		备注
created_at	DATETIME	Y	创建时间
updated_at	DATETIME	Y	更新时间
version	INT	Y	乐观锁版本

订单明细表（t_order_item）：

字段	类型	必填	说明
id	BIGINT	Y	主键
order_no	VARCHAR(32)	Y	订单号
product_code	VARCHAR(50)	Y	商品编码
product_name	VARCHAR(200)	Y	商品名称（冗余）
qty	INT	Y	数量
price	DECIMAL(18,2)	Y	单价
amount	DECIMAL(18,2)	Y	金额

支付表（t_payment）：

字段	类型	必填	说明
id	BIGINT	Y	主键
order_no	VARCHAR(32)	Y	订单号
pay_type	VARCHAR(20)	Y	支付方式
pay_amount	DECIMAL(18,2)	Y	支付金额
pay_status	VARCHAR(20)	Y	支付状态
pay_time	DATETIME		支付时间

8.3 索引设计

表	索引	字段	类型
t_order	PK	order_no	主键索引
t_order	IDX_user_status	user_id, status	联合索引
t_order	IDX_created	created_at	普通索引
t_order_item	PK	id	主键索引
t_order_item	IDX_order	order_no	普通索引
t_order_item	IDX_product	product_code	普通索引
t_payment	PK	id	主键索引
t_payment	IDX_order	order_no	唯一索引

8.4 数据字典

订单状态字典：

状态码	状态名称	描述
10	待付款	订单创建未支付
20	已付款	已支付待发货
30	已发货	已发货待收货
40	已完成	已确认收货
50	已取消	用户主动取消
60	已退款	退款完成

九、章节 7：接口设计

7.1 RESTful API 规范

统一格式：

1
2
3
4
5
6
7


{
 "code": 200,
 "message": "success",
 "data": { ... },
 "timestamp": "2025-09-15T10:00:00Z",
 "traceId": "abc123"
}

错误码：

错误码	含义
200	成功
400	参数错误
401	未登录
403	无权限
404	资源不存在
500	系统错误

7.2 订单 API 列表

方法	路径	描述
POST	`/api/orders`	创建订单
GET	`/api/orders/{orderNo}`	查询订单详情
GET	`/api/orders`	分页查询
PUT	`/api/orders/{orderNo}`	修改订单
DELETE	`/api/orders/{orderNo}`	删除订单（仅草稿）
POST	`/api/orders/{orderNo}/pay`	发起支付
POST	`/api/orders/{orderNo}/cancel`	取消订单

7.3 API 详细设计

POST /api/orders 创建订单

请求：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


POST /api/orders HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGc...

{
 "items": [
 {"productCode": "P001", "qty": 2, "price": 99.00}
 ],
 "addressId": "A001",
 "remark": "请尽快发货"
}

响应：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


HTTP/1.1 200 OK
Content-Type: application/json

{
 "code": 200,
 "message": "success",
 "data": {
 "orderNo": "SO20250915001",
 "total": 198.00,
 "payUrl": "https://pay.example.com/..."
 }
}

错误码：

code	message	触发条件
400	INVALID_PARAMS	参数校验失败
401	UNAUTHORIZED	未登录
403	NO_PERMISSION	无下单权限
409	STOCK_NOT_ENOUGH	库存不足
500	SYSTEM_ERROR	系统异常

十、详细设计的常见问题

10.1 写得太"概要"

症状：详细设计文档和概要设计文档内容重复，没有具体到函数 / 表 / 接口。

解决：每个模块都必须有"输入 / 处理 / 输出 / 算法描述"4 个要素。

10.2 写得太"详细"

症状：详细设计文档变成代码注释，文档太长没人看。

解决：只描述"做什么"和"用什么算法"，不写具体代码。伪代码为主，复杂逻辑用流程图。

10.3 不更新

症状：代码已经改了好几版，详细设计文档还是 v1.0。

解决：

每个迭代更新一次
引入变更管理（设计变更需评审）
详细设计与代码不一致时，以代码为准 + 标注 TODO 更新文档

10.4 不评审

症状：详细设计文档直接进入开发，没有同行评审。

解决：

必须经过至少 2 人评审
评审 checklist：覆盖率、正确性、一致性、可读性

十一、写在最后

详细设计的本质是"将概要变成可施工的图纸"——既不能太抽象（程序员看不懂），也不能太具体（变成代码注释）。

个人建议：

新项目起步：用本模板的 7 大章节结构

敏捷项目：用轻量版（只保留 3 / 5 / 6 / 7 章节）

核心模块：必须写（订单、支付、库存）

辅助模块：可以只写接口设计

评审流程：至少 2 人同行评审 + 1 人架构师 review

参考资料

架构设计基础：概要设计与详细设计的区别与实践

Fri, 30 Oct 2015 00:00:00 +0800

这是一份关于"概要设计 vs 详细设计"的对比梳理，源于 2015 年前后的架构师培训资料。为什么把它单独提一篇？因为在多数团队里，“概要设计"和"详细设计"的边界是模糊的——有人写到伪代码、有人只画个框图，评审会上吵成一团。

一、为什么这篇值得读

很多团队把"设计文档"当成一个文档：写完直接进开发。结果：

评审会上没人能看完 50 页的"设计文档”
设计粒度不统一，有人写到 SQL，有人只画模块图
模块之间的接口没定清楚，联调时互相甩锅

正确做法是先概要、后详细——概要设计解决"分模块、定接口、估工作量"，详细设计解决"模块内算法、流程、状态"。两个文档职责分离、粒度分离、受众分离。

When to use：当一个系统超过 3 个人、超过 3 个月、超过 3 个子系统时，概要设计文档就是必需的。否则项目进入开发就是"集体蒙眼摸象"。

二、概要设计 vs 详细设计：分界

维度	概要设计	详细设计
回答的问题	系统怎么分？模块怎么交互？	模块内部怎么实现？
粒度	模块、子系统、接口	类、函数、算法
产物	分层数据流图、结构图、数据字典	流程图、状态图、伪代码、局部变量说明
受众	架构师、技术总监、项目经理	模块开发者本人
评审重点	模块划分是否合理、接口是否清晰	算法是否正确、边界条件是否覆盖
改动代价	改了概要 → 重新评估工作量	改了详细 → 一般不影响工期
数量级	通常 10-50 页	一个模块 5-20 页（视复杂度）

Tip：概要设计是多人协作的契约——3 个开发者按概要分工，每人拿到的接口定义清晰到**“传什么、返回什么、什么时候调”。详细设计是单人实现的笔记**——算法怎么写、变量怎么命名、异常怎么抛，是开发者自己的事。

三、概要设计的 4 个原则

源文档里写得很清楚：

评价总体设计的可行性——概要设计是判断"这个项目能不能做、按什么方案做"的依据
检查模块是否完整——保证每个功能都有对应模块实现，不能有"无主功能"
评估开发工作量、指导开发计划——尤其在不写详细设计的情况下，模块数 × 经验系数 = 工期
避免两个误区：
- ❌ 过于重视业务流程（应该在需求里画，不该在概要里写）
- ❌ 过于重视细节实现（应该在详细里写，不该在概要里写）

四、概要设计的内容清单

4.1 总述

需求或目标（讲一下事情的起源）、环境、局限

这是给评审者**30 秒内理解"为什么做这个系统"**的入口。

4.2 总体设计

从全局角度说：

组织结构
功能
处理流程
有哪些模块
模块间的关系
运行环境

输出图：

系统结构图
系统流程图
数据流程图

4.3 外部接口

总体说明：

外部用户
软、硬件接口（可用资源）
第三方系统
网络协议
数据格式

4.4 模块设计（核心）

每个模块"做什么"、简要说明"怎么做"（输入、输出、处理逻辑、与其它模块或系统的接口），处在什么逻辑位置、物理位置。

模块描述——说明哪些模块实现了哪些功能
模块层次结构——可使用某个视角的软件框架图表达
模块间的关系——模块间依赖关系描述、通信机制描述
模块的核心接口——说明模块传递的信息、信息的结构（重点！必须写到"参数名+类型+含义"）
处理方式设计——说一些满足功能和性能的算法（只写算法思想，不写实现）

4.5 数据结构

逻辑结构
物理结构

4.6 容灾设计

出错信息
出错处理
降级方案
数据备份与恢复

4.7 监控设计

运行模块组合
控制
时间
告警阈值
日志规范

4.8 用户界面设计

界面布局
交互流程
UI 规范引用

4.9 安全设计

认证
授权
加密
审计

4.10 其它设计

国际化
性能
兼容性
可扩展性

4.11 制定规范

设计原则
代码规范
接口规约
命名规则

五、概要设计的关键产出物

产出物	作用	形式
分层数据流图	描述系统从输入到输出的加工过程	图
结构图	描述模块的层次和调用关系	图
数据字典	描述系统中所有数据项的含义、类型、长度、取值范围	表
模块清单	列出所有模块及功能	表
接口清单	列出所有模块间接口	表
关键流程说明	文字描述关键业务如何流转	文字 + 流程图

六、详细设计：模块内的实现

详细设计阶段，每个模块可以分给不同人并行设计。设计者工作对象是一个模块：

根据概要设计赋予的局部任务和对外接口
设计并表达出模块的算法、流程、状态转换

6.1 详细设计的关键产出

流程图——模块内主要处理流程
状态图——模块涉及的状态机
局部变量——模块内使用的临时变量
关键函数签名——参数、返回值、异常

6.2 详细设计 vs 概要设计的回退规则

如果发现有结构调整（如分解出子模块等）的必要，必须返回到概要设计阶段，将调整反应到概要设计文档中，而不能就地解决、不打招呼。

Why：详细设计改了不影响别人，但概要设计改了影响所有模块的接口。默默改概要设计 = 让所有下游模块的接口定义失效。

七、概要设计的 5 个常见坑

接口定义不细——只写"调用模块 A"，不写"传什么、返回什么、什么时机调"。联调时两套理解
数据字典缺失——文档里所有"用户 ID"都是一个意思吗？长度？类型？枚举值？没有数据字典就各写各的
过度细化——把详细设计的内容写到概要设计，评审会变成代码 review，没人能看完
不画部署图——只有逻辑架构，没有物理部署。运维拿不到"这台机器跑什么"的答案
不写非功能——性能、可用性、安全、合规等都不写，验收时客户发现没满足

八、核心 5 点提炼

概要设计是"分模块、定接口、估工期"的契约——它的粒度停在模块和接口，不写到类和方法
详细设计是"单模块的实现笔记"——粒度到函数和算法，单模块可并行设计
数据结构 > 算法——概要设计阶段数据字典比算法重要，因为数据结构是模块间共享的
改了概要必须通知所有相关人——默默改概要 = 默默改契约 = 撕毁合作基础
不写详细设计时，概要要写得更细——反之则要保留详细设计的预算

九、When to use

场景	必备设计
1 人、1 个月、1 模块	不需要正式设计文档
2-3 人、2-3 个月、单一系统	概要设计
3+ 人、3+ 月、多子系统	概要设计 + 详细设计
多团队、外部审计、合规项目	概要设计 + 详细设计 + 评审记录 + 变更记录

参考资料

2024+ 视角

2015 年的"概要 vs 详细"分界到 2024-2026 年依然成立，但形式与协作方式发生了几个关键变化：

C4 模型取代大段文字：Simon Brown 的 C4 模型（Context → Container → Component → Code）成为软件架构图的事实标准。一张 C4 上下文图顶 50 页"总体设计说明"。Structurizr DSL + Structurizr Lite 是写 C4 的工具首选。
ADR（Architecture Decision Records）正式成为评审产物：每个重要决策一个 ADR（Markdown 文件 + git 管理），模板：
- 状态：提议 / 已接受 / 已废弃 / 已取代
- 上下文：要解决什么问题
- 决策：选了哪个方案
- 后果：trade-off、风险、未来影响
架构评估从 ATAM → ADR + Fitness Functions：
- 2015 年前用 ATAM（架构权衡分析法） 做架构评审
- 2024 年用 ADR 累积 + 持续验证：每个架构属性（性能 / 可用性 / 安全）有对应的 Fitness Function（自动测试），CI 中持续验证
云原生架构让"物理部署"和"逻辑架构"分离：
- 概要设计要写"逻辑架构" + “物理部署（K8s/Serverless）” 两层
- Infrastructure as Code（Terraform / Pulumi / Crossplane）让部署图也是 git 的一部分
微服务架构的概要设计新要素：
- 服务边界（按业务能力 / DDD 子域）
- 通信模式（同步 REST/gRPC vs 异步事件）
- 数据一致性（Saga / Outbox / CDC）
- 可观测性（OTel / RED/USE 指标）
架构师角色升级：从"画图 + 评审"到"决策 + 治理 + 演进"——C4 + ADR + Fitness Function + ADR 看板 + 架构腐化检测（SonarQube / ArchUnit）。
“概要 vs 详细"边界依然不变：
- 概要：模块 / 接口 / 部署 / 数据流（C4 Level 1-3）
- 详细：类 / 函数 / 算法 / 状态机（C4 Level 4 + 序列图）
- 永远不要在概要设计里写伪代码——让代码本身就是详细设计

2015 视角 vs 2024 视角对照：

维度	2015	2024
图表	Visio / Rational Rose	C4 + Structurizr + Mermaid
决策记录	邮件 / Word 评审	ADR（git 管理）
物理部署	表格 + Visio	Terraform / Helm / Crossplane
架构评估	ATAM 评审会	ADR + Fitness Function + 持续验证
架构腐化	人工 review	ArchUnit + SonarQube

结论：2015 年这篇"先概要、后详细"的方法论至今仍是行业最佳实践，但工具从 Visio 转向 C4 + ADR + IaC，治理从一次性评审转向持续验证。