软件开发技术方案模板

技术开发方案模板概述及术语1.可以引用产品文档，并且带上产品文档链接2.对一些系统中产生的术语做出解释交代清楚技术方案设计的背景、逻辑2架构设计2.1整体架构说明：讲清楚业务架构、应用架构，二选一。即使是小迭代架构不变也需要引用之前的架构图。2.2各个核心功能的流程图/时序图/状态3功能清单/系统用例3.1依赖方功能清单序号依赖系统功能点功能描述修改类型对接人1服务1功能1新增小可爱2服务2功能2新增小可爱3服务3功能3注意订单类型与业务订单的映射修改小可爱4新增・・・・3.2内部功能清单序号功能点功能描述修改类型开发者1功能11、防重校验2、安全校验新增小可爱2功能21、功能描述1新增小可爱3功能31、功能描述修改小可爱4新增・・・・41亦模型设ER根据需求的大小，若是小迭代，可以不用DDL考虑索引DML4.4MQ设计5配置说明：项目中涉及到的相关数据库初始化配置、参数配置、定时任务配置、消息配置等5.1配置中心nacos/Apollo配置属于新增或者修改需要备注清楚#新增xx1:xx2:xx3:305.2定时任务配置填写定时任务的JobHandler.任务描述、cron.任务参数（根据业务需要可填可不填）、负责人信息

JobHandler*JobHandler*任务描述*Cron*任务参数*负责人*xxJob任务描述00/10***?无小可爱5.3mq配填写新增的mqtopic名称以及group名称。mq的类名新增的topic新增的group^口详细设计6.1创建活动说明：接口入参、出参字段、错误码、实现的逻辑描述、接口变更的影响范围7其他方面7.1监控方案监控类型监控内容指标项责任人链路监控Rest接口的非200链路数据库写入失败MQ发送失败缓存链路监控调用外部接口的异常监控错误量错误率延迟变化指数负责开发该模块的研发日志监控1.数据库慢日志日志量级负责开发该

业务打印日志日志量级业务日志告警变化指数模块的研发数据监控数据日增长总量级监控某种业务角度汇总的总量级数据量级增长率负责开发该模块的研发用户行为监控页面错误页面访问量级页面加载性能页面加载异常错误量错误率PV、UV负责该产品的前端研发基础设施监控各种中间件、设备的运行状态防火墙监控数据库宿主机购买的三方资源使用量CPU内存磁盘资源使用量运维*注意监控并不一定都能联动报警，但在已知的确定性的异常监控数据，可以联动报警；监控需要做到常规巡检，系统上线不是终点，上线后的稳定性保障性工作更重要；监控需要常态化，监控指标是洞察系统运行质量的眼睛；上线前需要预先设置好以上监控的点，建议各负责人上线后定期产出巡检报告。7.2灰度方案*注意灰度是系统平滑升级的必要条件灰度方案需要找准灰度的特征属性，常用的如：区域、人员id7.3应急方案*注意当通过监控或者业务反馈并确认异常后，需要有如下必要流程：发布故障通告，确保通知、协调到各方（运营人员、产品、研发Leader）,必要时需要提供相关信息给运营人员，并且做停服维护公告；紧急问题，可以联系运维做端上流量限制：包括数据库关键词限流、网关接口限流/关闭、配置防火墙隔离规则、用户/IP访问熔断等；BUG修复类问题，需要紧急发布的需要领导审批；因故障连带其他服务异常的，需要联系运维做紧急资源隔离，缩小故障范围；故障处理完毕及时发布故障解除公告。说明：目前基础设施缺失服务内部接口限流、熔断措施，对于一些来源为内部服务调用产生的故障可能还需要调用方的服务紧急发布，停止调用行为；对于来