概要设计 - 模版

概要设计 -

系统名称:*****
文档修订历史
|版本号 | 作者 |备注 |修订日期|
| —- | —- | —- | —- |
|v1.0|****|创建模版 |2020-7-29|

 

1. 需求背景

【【描述需求背景或者开发重构的目的/出发点】
原先大家写文档都是本机写文档,然后评审时统一交给主持人进行投影,文档版本管理也比较混乱

2. 需求分析

2.1. 产品需求分析【产品需求适用】

【用于描述对产品提出的需求的理解和分析:产品定位、新增功能、业务目标等,避免对需求的理解和产品不一致,导致做无用功】
XXXX。。。

2.2. 技术技术需求分析【技术优化适用】

【用于描述对技术团队提出的技术需求的理解和分析:技术债务清理、市场反馈问题改善、性能体验优化、技术指标达成、技术方案更新等。此处应包含技术改善项目和大致的实现策略】
XXXX。。。

3. 整体实现方案

3.1. 整体框架图

【展示应用整体的框架图,包括整体结构、应用分层、模块解耦】
XXXX。。。  

3.2. 核心功能流程图

【展示新增核心功能的流程图,帮助梳理整个功能的逻辑,减少编码过程中由于前期考虑不周导致的不稳定性和随机bug】
XXXX。。。  

4. 模块设计

【根据原型或者UX稿识别需要新增或修改的页面、模块、组件,尽量解耦】
XXXX。。。  

5. 接口设计

【列出所有关联接口及功能描述,详细参数交互后续补充,标注新增或修改】
XXXX。。。

6.异常流程设计

【列出所有交互异常流程处理方案,接口异常处理方案】

7. 风险及应对方案

【列出开发相关的风险项:资损风险、安全风险、指标达成风险、进度风险等,以及针对各项风险的应对方案。如设计中包含,需详细说明;如不包含,请写明【确认无此风险】

7.1. 资损风险分析

XXXX。。。  

7.2. 安全风险分析

XXXX。。。  

7.3. 接口改动是否兼容老版本

XXXX。。。  

7.4. 代码改动是否兼容老版

XXXX。。。  

7.5. 路由修改删除是否已检查页面投放情况

XXXX。。。  

7.6. 其它风险说明

XXXX。。。  

8. 各节点里程碑

【列出各领域的关键事项及时间节点,以便各领域协同、项目透明、进度可预知】
XXXX。。。