技术设计文档(模板)¶
用法:一个系统或功能一份,动手写代码之前完成。小改动可以口述,超过一周工作量必须有此文。
1. 背景与目标¶
<为什么做、解决什么、验收标准>
2. 需求清单¶
- 功能需求:<逐条、可测试>
- 非功能需求:<性能预算、平台约束、兼容性>
3. 方案概述¶
<一段话描述整体方案 + 模块关系(草图或文字)>
4. 模块拆分与职责¶
| 模块 | 职责 | 依赖 |
|---|---|---|
5. 数据结构与接口¶
<关键数据结构、状态机、事件;接口列表(参数 / 返回 / 错误)>
6. 性能预算¶
<帧时间 / 内存 / 带宽预算,测量方法,超标预案>
7. 测试计划¶
<单测范围、手动验证清单、边缘情况>
8. 风险与备选方案¶
| 风险 | 概率 | 影响 | 备选 |
|---|---|---|---|
9. 决策记录¶
| 日期 | 决策 | 理由 | 替代方案 |
|---|---|---|---|