XXX项目
概要设计说明书
（V1.0）
| 文档编号 |
|
版本号 |
V1.0 |
|||
| 分册名称 |
概要设计说明书 |
第1册/共1册 |
||||
| 总页数 |
|
正文 |
|
附录 |
0 |
|
| 编制 |
|
审批 |
|
生效日期 |
|
|
修改记录
| 版本号 |
变更控制 报告编号 |
更改条款及内容 |
|
更改人 |
审批人 |
更改日期 |
| V1.0 |
|
初稿 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
目录
1 引言
1.1 编写目的
1.2 背景
1.3 术语
1.4 预期读者与阅读建议
1.5 参考资料
2 运行环境
3 业务架构
4 技术架构
5 部署架构
6 数据架构
6.1 数据库环境说明
6.2 数据库命名规则
6.3 数据备份和恢复
7 技术难点
8 接口设计
8.1 用户接口
8.2 外部接口
8.3 内部接口
9 系统安全设计
9.1 数据传输安全性设计
9.2 应用系统安全性设计
9.3 数据存储安全性设计
10 系统非功能性设计
11 界面总体设计
12 系统出错处理设计[可选]
12.1 出错信息
12.2 补救措施
12.3 系统维护设计
1引言
1.1编写目的
说明编写这份概要设计说明书的目的。
1.2背景
描述系统产生的背景，包括：
a) 需开发的软件系统的名称，和英文缩写（可选），项目编号（可选）；
b) 列出此项目的任务提出者、开发者
c) 软件系统应用范围、用户。
1.3术语
列出本文件中用到的专门术语、术语定义、外文首字母组词的原词组。也可用附件说明。或放到本文件的最后。
1.4预期读者与阅读建议
描述本文档的主要读者，以及这些读者在阅读时的阅读重点与建议。可用列表的方式列出。如表：
| 预期读者 |
阅读重点 |
|
|
|
|
|
|
|
|
|
1.5参考资料
列出有关的参考资料，如：
本项目经核准的计划任务书或合同、上级机关的批文；
属于本项目的其他已发表的文件；
本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2运行环境
简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。
3业务架构
说明本系统的总体业务功能，尽量使用图表的形式，并辅以必要的文字说明。
4技术架构
说明对本系统的总体架构设计主要实现的目标，技术选型。
5部署架构
以图形方式画出系统网络结构，说明本系统的网络拓扑结构,并加以文字说明客户端、服务器等之间的关联关系
6数据架构
用一览表及框图的形式说明本系统技术和业务功能的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系（特别是公用模块和其他模块之间的控制关系）。可用数据E-R图进行展示
6.1数据库环境说明
简单介绍与数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性。
6.2数据库命名规则
联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。
6.3数据备份和恢复
描述数据库的备份和恢复策略。
7技术难点
说明在概要设计过程中设计者认为在系统存在的技术难点或者哪些是关键技术。
8接口设计
8.1用户接口
说明与用户接口的输入输出关系，以及将向用户接口提供的命令和它们的语法结构，以及软件的回答信息。
8.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系、协议要求等。
8.3内部接口
说明本系统之内的各个系统元素（各层模块、子程序、公用程序等）之间的接口的安排，包括设计调用关系、输入输出要求、语法结构等。
9系统安全设计
9.1数据传输安全性设计
说明在数据通信和传输过程中安全性设计。
9.2应用系统安全性设计
说明在访问应用系统过程中用户以及访问权限、操作等安全性设计。
9.3数据存储安全性设计
说明在数据和文件在存储过程中的安全性设计。
10系统非功能性设计
1、高可扩展性：
2、高可靠性：
3、性能需求：
4、可维护性：
5、对技术及业务的可适应性：
6、异步：
7、安全：
11界面总体设计
说明界面总体布局和风格设计。例如一级菜单是用什么字号、颜色等的描述，页面布局的色号等的描述，按钮的设计等等
12系统出错处理设计[可选]
12.1出错信息
用一览表的方式说明出错的类型，以及每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。例如：
| 分 类 |
子项及其编码 |
错误名称 |
错误代码 |
备注 |
| 数据库错误 |
连接 |
连接超时 |
100001001 |
|
| 连接断开 |
100001002 |
|
||
| 数据库本身错误代码 |
数据库本身错误代码 |
100002+数据库错误代码 |
|
|
| TCP连接错误 |
连接 |
连接超时 |
101001001 |
|
| 连接断开 |
101001002 |
|
||
| 其它TCP连接错误(socket自身错误代码) |
|
101002+ socket错误代码 |
|
|
| 配置信息错误 |
未配置输入参数 |
|
102001 |
|
| 未配置输出参数 |
|
102002 |
|
12.2补救措施
说明故障出现后可能采取的变通措施，包括：
a．后备技术 说明准备采用的后图示技术，当原始系统数据万一丢失时启用的副 本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；
b．降效技术 说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；
c．恢复及再启动技术 说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。
12.3系统维护设计
说明为了系统维护的方便而在程序内部设计中做出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
