整理一个技术开发模板思路，指导自己设计开发，不断迭代
需求背景：描述需求背景，解释What、Why、Who
整体目标：描述期望达到的效果
概要设计：
设计原则：设计的核心指导原则
实体关系：抽象实体之间的关联关系
功能结构：划分重点功能，梳理边界定位，从设计上开始掌控核心特性
重点功能：描述重点功能逻辑，包括不限于伪代码、流程图、时序图、类图等
核心逻辑：可以包括流程处理，分支条件，状态变更，通知方式等
程序扩展：找到变化点，遵循开闭原则使用设计模式掌控变化
错误处理：业务、系统异常的定义，重试处理逻辑
降级容灾：存储与中间件相互备份，日志降级等
监控设计：出现问题及时通知相关方处理
安全考量：排查已知的安全问题，做好报备和安全防护
详细设计：
存储设计：数据库表、字段、索引结构；Redis/Hbase的key设计，Es索引等
接口设计：与上下游系统初步沟通后确认接口的输入输出，错误码等
测试相关：功能模块的单元测试、整体项目压力测试或基准测试
环境部署：资源的申请，机房、中间件的部署方式，大促分组，考虑无损上线、扩容、缩容
其它说明：
使用说明：环境配置，接入说明
问题解答：常用问题解答
网友评论