技术设计文档模板

[flycash]

需求分析

这里要交代清楚背景

场景分析

从用户角度、实际使用的角度出发，分析具体场景

功能需求

从场景分析里面拆解出来的具体功能点，以列表或者表格的形式提供

非功能需求

行业方案

这里描述其它中间件解决类似问题采用的方案，并且要进行优劣分析

设计

描述总体设计

详细设计

要在这里考虑清楚关键 API 的定义，关键算法以伪代码的形式描述清楚

可替换方案

前面讨论的是你选择的方案。如果你觉得还有别的可行的方案，可以在这里描述

例子

测试

单元测试

描述单元测试，要充分考虑正常、异常、边缘输入等。一般建议使用表格驱动的方法来设计测试用例

集成测试

如果引入了新功能，那么应该实际连上数据库执行测试

基准测试

benchmark 测试。要描述清楚是否引入新的基准测试，或者修改已有的基准测试

模糊测试

go fuzzing 测试。要描述清楚是否引入新的模糊测试，或者修改已有的模糊测试

其它

参考资料

可以是文档，合并请求，或者截图等一切可以佐证你的设计，或者描述清楚问题的东西。
中英文资料都可以