本文最后更新于 992 天前,其中的信息可能已经有所发展或是发生改变。
发布版本-需求标题
文档变更记录
日期 | 版本号 | 修订内容 | 修订人 |
---|---|---|---|
目 录
[TOC]
XXX功能详细设计
【
详细设计文档针对一个具体功能或者模块进行详细设计,
完成设计文档后,一定将【】
的所有示例内容都删除。不能直接删除章节,若不进行设计,请写“无”。
注意修改页文档版本控制。
】
合并请求:https://xxx.xxx.com/xxx/-/merge_requests/xxxx
设计评审时必须带上分支合并请求并且标记为WIP,代码审核者每天预留30分钟做代码复查。
需求分析
需求描述
【
对需求进行详细的描述,表明为什么要做这个需求,这个需求能够解决什么问题。
】
业务流程分析
【
阐述该需求涉及系统哪些流程,如果涉及到需要和其他系统对接需要有流程图。
】
功能性需求描述
【
讲述该需求的功能点。
】
功能设计
设计思路
【
描述本需求实现的详细设计思路
】
接口设计
接口设计原则
https://cloud.google.com/apis/design
接口清单
【
接口名称
Protocol buffer源码
】
数据库设计
设计思路
【
比如表的设计思路、数据拆分思路等。
】
数据库设计内容
【
创建表或者新增、修改字段的sql。
】
冗余设计
【写出哪个库、表、字段需要冗余,冗余数据如何同步。
数据库对象 | 冗余设计 | 数据同步策略 |
---|---|---|
】
影响范围
性能影响
【本次新增的功能、接口等需要评估是否会对系统产生性能压力,如果有需要考虑如何优化。】