概要设计文档-模板

一、概念理解

根据IEEE 610.12标准对它们的定义：

概要设计（Preliminary Design）：分析设计备选方案，并定义软件体系结构、构件、接口、以及一个系统或构件的时间和大小估计的过程。
详细设计（detailed design）：将一个系统或构件的概要设计进行精化和扩展，达到设计充分完善而能够被实现程度的过程。
概要设计实现软件的总体设计、模块划分、用户界面设计、数据库设计等等；
详细设计则根据概要设计所做的模块划分，实现各模块的算法设计，实现用户界面设计、数据结构设计的细化，等等。

概要设计是一个团队完成一个系统，根据需求形成的模块划分、技术复用、功能划分、数据库结构、接口等技术决策和约定，是构架起需求、用户体验、程序研发之间的桥梁，使需求转化为软件可以实现的阶段。-

概要设计的目标是使团队有一个清晰、准确的实现系统的思路。

二、概要设计文档-模板

1.需求说明（需求细化分析）

【简要描述本系统所涉及到的的需求，对设计选型、设计方案决策的影响等】

1.1 用户需求：

描写用户关注的问题，软件的价值点

1.2 用户范围：

描写有什么角色、那类用户使用系统。

1.3 设计清单

1.4 不涉及清单

2.系统设计

2.0 技术选型

【描述本系统内的技术选型】

2.1 设计思路：

【描述本系统的整体设计思路，涉及重点功能、重要算法的概要描述】
设计过程中考虑的点、方案、选择或放弃的原因
关联外部系统及服务:【描述其关联的外部系统及服务】
复用设计
- 复用清单:【列举我们复用的服务和系统，以及可复用但未复用的服务和系统，并说明原因。】
- 被复用可行性:【如果是项目，是否可孵化成产品；是否可跨行业复用。如果被其他系统复用，哪些是可复用的。】

2.2 功能结构：

软件功能树型结构（分层功能模块）

2.3 逻辑架构：

功能模块内部，功能模块与外部的关系

2.4 角色权限设计

角色
权限

2.5 单值代码设计

2.6 配置参数设计

常规参数
复杂参数

2. 7 开发规范

包结构规范
命名规范
注释规范
SMD维护

3.数据库设计

3.1 设计思路

【比如表的设计思路、数据拆分思路等。】

3.2 具体模块数据库表结构设计：设计系统的ER图

3.3 数据流向、具体模块数据流图

3.4 存储设计

3.5 冗余设计

【写出哪个库、表、字段需要冗余，冗余数据如何同步。】

3.6 数据初始化

3.7 设计规范

4.接口设计

4.1 内部接口

4.2 外部接口

5.关键技术与算法：

用来解决了重点、难点业务功能的技术点

6.功能模块A**

6.1 设计思路

6.2 实现思路

6.3 类设计：

类图

6.4 画出时序图

7.功能模块B*

…

8.非功能性设计

8.5.1 性能设计

【本子系统涉及到的用户量、数据量、最大并发量、如涉及到上下级单位，网络带宽情况，是否满足性能需求，是否做集群、是否做分布式部署。】

8.5.2 可用性设计

【可用性要求，如果出现宕机的影响如何。如果要求高可用，描述一下我们的高可用设计方案。】

8.5.3 安全性设计

【是否设计，安全要求如何，是否是互联网应用，描述一下我们的安全设计方案。】