概要设计说明书
项目承担部门:
撰写人(签名):
完成日期:
本文档使用部门:□主管领导 □项目组 □客户(市场)
□维护人员 □用户
评审人(签名):
评审日期:
批准人(签名):
批准日期:
文档修订记录
版本编号或者更改记录编号 |
*变化状态 |
简要说明(变更内容和变更范围) |
日期 |
变更人 |
批准日期 |
批准人 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*变化状态:A——增加,M——修改,D——删除
文档审批信息
序号 |
审批人 |
角色 |
审批日期 |
签字 |
备注 |
目录
1 引言… 3
1.1 编写目的… 3
1.2 项目背景… 3
1.3 定义… 3
1.4 参考资料… 3
2 总体设计… 4
2.1 需求规定… 4
2.2 运行环境… 4
2.3 基本设计概念和处理流程… 4
2.4 结构… 4
2.5 功能需求与程序的关系… 4
2.6 人工处理过程… 4
2.7 尚未解决的问题… 5
3 接口设计… 5
3.1 用户接口… 5
3.2 外部接口… 5
3.3 内部接口… 5
4 运行设计… 5
4.1 运行模块组合… 5
4.2 运行控制… 5
4.3 运行时间… 5
5 系统数据结构设计… 6
5.1 逻辑结构设计要点… 6
5.2 物理结构设计要点… 6
5.3 数据结构与程序的关系… 6
6 系统出错处理设计… 6
6.1 出错信息… 6
6.2 补救措施… 6
6.3 系统维护设计… 7
1 引言
1.1 编写目的
提示:
描述编写软件需求说明书的目的;
说明软件需求说明书所预期的读者。
1.2 项目背景
提示:
待开发的软件系统的名称;
项目的委托单位、开发单位、用户和主管部门;
该软件系统与其他系统或其他机构的基本的相互往来关系。
1.3 定义
提示:
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4 参考资料
提示:
列出有关资料的作者、标题、编号、发表日期、出版单位,说明能够得到这些文件资料的来源,可包括:
项目经核准的计划任务书、合同或上级机关的批文;
项目开发计划;
需求说明书;
测试计划;
本文档中各处引用的文件、资料、包括采用的软件开发标准或规范,例如《公司数据库对象命名规范》。
2 总体设计
2.1 需求规定
说明对本系统的主要输入输出项目、处理的功能性能要求,详细说明可参见《软件需求说明书》。
2.2 运行环境
简要说明对本系统的运行环境(包括硬件环境和支持环境)的规定,详细说明参见《软件需求说明书》。
2.3 基本设计概念和处理流程
说明本系统的基本设计概念、开发工具和处理流程,处理流程尽量使用图表的形式。
2.4 结构
用框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,分层次地给出各元素之间的控制与被控制关系,用一览表的形式扼要说明每个系统元素的标志符和功能。
要求:
1、明确记述页面名称和页面功能概要页面。
2、页面名称和其它设计书(页面一览表,页面布置,页面项目定义)是同样的。
3、页面之间的变迁,必须记述作为活动的按钮名称或者是活动名称。
4、页面变迁从左侧开始,尽可能从左向右记述变迁。
5、关于处理,联合其他系统.系统结束等特殊处理需要记述,对于普通处理不用特别记述。
例:
2.5 人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程。
2.6 尚未解决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3 接口设计
3.1 用户接口
说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。一般公司开发的系统中主要是导出的文件、自定义的查询或公式、系统提示信息等。
3.2 外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3.3 内部接口
说明本系统之内的各个元素之间的接口的安排。如单据对象等。
4 运行设计
如系统运行中没有特殊的控制或要求,本节可不填写。
4.1 运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
4.2 运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
4.3 运行时间
说明每种运行模块组合将占用各种资源的时间。
5 数据结构设计
见《表设计书》。
6 系统出错处理设计
6.1 出错信息
用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含义及处理方法。
错误号 |
错误情况 |
系统输出信息 |
处理办法 |
1 |
数据库无法连接 |
“请检查数据库服务器和网络是否正常运行,系统将重新登陆” |
系统缓存现有数据,重新登陆,如正常回到原处理页面 |
2 |
|
|
|
…… |
|
|
|
N |
|
|
|
6.2 补救措施
说明故障出现后可能采取的变通措施,包括:
后备技术说明准备采用的后备技术,当原始系统数据万一丢失启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
6.3 系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。各个程序之间的对应关系,可采用矩阵图的形式。
概要设计说明书