XXXXX概要设计说明书.docx
《XXXXX概要设计说明书.docx》由会员分享,可在线阅读,更多相关《XXXXX概要设计说明书.docx(6页珍藏版)》请在冰豆网上搜索。
![XXXXX概要设计说明书.docx](https://file1.bdocx.com/fileroot1/2023-4/21/016e6a97-516e-4fdb-a14f-da67a952aae0/016e6a97-516e-4fdb-a14f-da67a952aae01.gif)
XXXXX概要设计说明书
密级:
内部公开
概要说明书
名称
XXXXX概要设计说明书
版本号
V1.0
编制
审批
生效日期
研发中心
XXXX年XX月
修改记录
版本号
更改条款及内容
更改人
审批人
更改日期
1.引言
1.1.编写目的
{说明编写这份概要设计说明书的目的。
}
1.2.背景
{描述系统产生的背景,包括:
a、需开发的软件系统的名称,和英文缩写(可选),项目编号(可选);
b、列出此项目的任务提出者、开发者
c、软件系统应用范围、用户。
}
1.3.术语
{列出本文件中用到的专门术语、术语定义、外文首字母组词的原词组。
也可用附件说明。
或放到本文件的最后。
}
1.4.预期读者与阅读建议
{描述本文档的主要读者,以及这些读者在阅读时的阅读重点与建议。
可用列表的方式列出。
如表:
预期读者
阅读重点
}
1.5.参考资料
{列出有关的参考资料,如:
a、本项目经核准的计划任务书或合同、上级机关的批文;
b、属于本项目的其他已发表的文件;
c、本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
}
2.总体设计
2.1.设计目标
{说明对本系统的总体架构设计主要实现的目标。
}
2.2.运行环境
{简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定。
}
2.3.网络结构
{以图形方式画出系统网络结构,说明本系统的网络拓扑结构。
}
2.4.总体设计思路和处理流程
{说明本系统的总体设计思路和处理流程,尽量使用图表的形式,并辅以必要的文字说明。
}
2.5.模块结构设计
{用一览表及框图的形式说明本系统技术和业务功能的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系(特别是公用模块和其他模块之间的控制关系)。
}
2.6.尚未解决的问题
{说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
}
3.接口设计
3.1.用户接口
{说明与用户接口的输入输出关系,以及将向用户接口提供的命令和它们的语法结构,以及软件的回答信息。
}
3.2.外部接口
{说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系、协议要求等。
}
3.3.内部接口
{说明本系统之内的各个系统元素(各层模块、子程序、公用程序等)之间的接口的安排,包括设计调用关系、输入输出要求、语法结构等。
}
4.界面总体设计
{说明界面总体布局和风格设计。
}
5.数据结构设计
{可以在本文说明也可以单独使用数据库设计说明书描述}
5.1.数据库环境说明
{简单介绍同些数据库直接有关的支持软件,如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。
说明这些软件的名称、版本号和主要功能特性。
}
5.2.数据库命名规则
{联系用途,详细说明用于唯一地标识该数据库的代码、名称或标识符,附加的描述性信息亦要给出。
}
5.3.逻辑结构
{数据库设计人员根据需求文档,利用数据建模技术来描述逻辑数据库结构。
要求使用PowerDesigner创建数据库PDM模型。
此处只需列出PDM模型名称。
}
5.4.物理存储
{描述整个逻辑数据模型是如何被转换为数据文件(物理模式)。
文件结构类型在这里应清楚的体现。
}
5.5.数据备份和恢复
{描述数据库的备份和恢复策略。
}
6.系统出错处理设计
6.1.出错信息
{用一览表的方式说明出错的类型,以及每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。
例如:
分类
子项及其编码
错误名称
错误代码
备注
数据库错误
连接
连接超时
连接断开
数据库本身错误代码
数据库本身错误代码
+数据库错误代码
TCP连接错误
连接
连接超时
连接断开
其它TCP连接错误(socket自身错误代码)
+socket错误代码
配置信息错误
未配置输入参数
未配置输出参数
}
6.2.补救措施
{说明故障出现后可能采取的变通措施,包括:
a.后备技术说明准备采用的后图示技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b.降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
a.恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
}
6.3.系统维护设计
{说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
}
7.系统安全设计
7.1.数据传输安全性设计
{说明在数据通信和传输过程中安全性设计。
}
7.2.应用系统安全性设计
{说明在访问应用系统过程中用户以及访问权限、操作等安全性设计。
}
7.3.数据存储安全性设计
{说明在数据和文件在存储过程中的安全性设计。
}