概 要 设 计 说 明 书
项目名称:
项目版本:
拟 制:
审 核:
批 准:
文件版本:
南京三宝科技股份有限公司
年 月 日
概要设计说明书
1. 引言
编写目的
阐明编写概要设计说明书的目的,指明读者对象。
项目背景
应包括:
a.待开发软件系统的名称
b.列出此项目的任务提出者、开发者以及用户
c.该软件系统与其他系统的关系
定义
列出本文档中所用到的专门术语的定义和外文缩写词的原文。
参考资料
列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,这些资料可包括:
a. 项目经核准的计划任务书、合同或上级机关的批文;
b. 项目开发计划;
c. 需求规格说明书;
d. 测试计划(初稿);
e. 用户操作手册(初稿);
f. 文档所引用的资料、采用的标准或规范。
2. 任务概述
目标
阐明本项目所需达到的目标。
运行环境
简要地说明对本产品的运行环境(包括硬件环境和支持环境)的规定。
需求概述
概述本产品的功能需求、性能需求等。
条件与限制
说明本产品在实现时所必须满足的条件和所受的限制,以及相应的原因。必须满足的条件
包括输入数据的范围以及格式,所受的限制包括软件环境、硬件环境等方面的内容。
3. 总体设计
处理流程
说明本系统的基本设计概念和处理流程,尽量使用图表的形式(如流程图)。
总体结构和模块外部设计
用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,
扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系。
软件体系结构
【用图来表示软件系统的总体结构框架,并对其进行描述。】
子系统划分
子系统清单
各子系统功能描述
程序模块划分和功能分配
程序模块清单
各程序模块功能描述
功能-程序模块对照表
用一张如下的矩阵图说明各项功能需求的实现同各程序模块的分配关系:
模块-数据实体对照表
人工处理过程
【描述不能完全自动处理而需人工处理的过程。】
4. 接口设计
用户接口
说明向用户提供的命令和它们的语法结构,以及软件的应答信息。
外部接口
说明本系统同外界的所有接口的安排,包括软件与硬件之间的接口、本系统与各支持软件之
间的接口关系。
内部接口
说明本系统之内的各个系统元素之间的接口的安排。
5. 数据结构设计
逻辑结构设计
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录和文卷
的标识、定义、长度及它们之间的层次的或表格的相互关系。
物理结构设计
给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存
取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。
数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
6. 运行设计
运行模块的组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所
历经的内部模块和支持软件。
运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
运行时间
说明每种运行模块组合将占用各种资源的时间。
7. 出错处理设计
出错输出信息
用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理
方法。
出错处理对策
说明故障出现后可能采取的变通措施,包括:
a.后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启
动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b.降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果
的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c.恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从
头开始重新运行的方法。
系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统
的检查与维护的检测点和专用模块。
8. 安全保密设计
9. 维护设计
【说明为方便维护工作的设施,如维护模块等。】