“概要设计说明书”编写规范

“概要设计说明书”编写规范  

 

    软件的概要设计又称为软件系统（程序系统）的设计，本文件应说明软件系统即程序系统设计的总体考虑，包括系统的基本处理流程、软件系统的组织结构、模块划分、功能分配、数据结构、接口、运行、出错处理和系统维护等方面的设计，为详细设计提供基础。

1 引言

1.1   编写目的

说明编写本设计说明书的目的，指出预期的读者

1.2   背景

a.         说明待开发软件系统的名称

b.         列出开发此软件系统的提出者、开发者、和用户

1.3   基线

说明本系统设计的设计基线

1.4   范围

说明本设计说明书所涉及的设计内容范围

1.5   定义

列出本设计说明书中用到的专门术语和外文字母组合词的原词组

1.6   参考资料

a.         属于项目的其他已发表的文件

b.         本设计说明书中引用到的文件、资料，包括所用到的软件开发标准

列出这些文件资料的标题、编号、发表日期、出版单位和查找来源

2         总体设计

2.1   概述

2.1.1          需求规定

说明本系统主要的输入、处理、输出的功能和性能要求等

2.1.2          运行环境

说明本系统运行的硬件环境和支持环境

2.2   设计

2.2.1          设计构思

说明对本系统设计的构思、采用的关键技术、主要算法和关键数据结构

2.2.2          系统流程

a.         用流程图示出本系统的主要控制流程和处理流程

b.         用流程图示出本系统的主要数据通路，并说明处理的主要阶段

2.2.3          结构设计

a.         系统元素

确定本系统的元素及其功能，用一览表说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，按层次给出它们的标识符和功能。

b.         系统层次结构

用框图分层次地给出各个系统元素之间的控制和被控制的关系

2.2.4          功能需求与程序的关系

用功能需求与程序的矩阵图表形式，示出各项功能的实现与各系统元素之间的分配关系

3         系统数据结构设计

3.1   数据结构

列出本系统所使用的主要数据结构，包括名称、标识符及数据项等

3.2   数据结构与系统元素之间的关系

用数据结构与系统元素之间的矩阵图表形式，示出各个数据结构与访问这些数据结构的系统元素之间的关系

4         接口设计

4.1   用户接口

说明本系统向用户提供的命令、语法结构及系统回答信息等

4.2   外部接口

说明本系统的软件同硬件和支持软件之间的接口

4.3   内部接口

说明本系统内部相关模块之间的接口

5         运行设计

5.1   系统初始化

说明本系统初始化过程

5.2   运行模块组合

说明本系统每项外界运行需经过哪些内部模块的组合和支持软件

5.3   运行控制

说明每项外界运行的控制方式、方法和操作步骤

5.4   运行时间

说明每项运行模块组合预计占用各种资源的时间

5.5   运行安全

说明系统安全运行的控制

6         信息结构设计（当相关需求或软件规格定义有要求时）

按逻辑结构和物理结构给出本软件有关信息的设计要点

6.1   逻辑结构设计

6.1.1          图形设计

6.1.2          中文（包括单个汉字、短语、词组）设计

6.2   物理结构设计

6.3   信息结构与程序的关系

用信息结构与系统元素之间的矩阵图表形式，示出各个信息结构与访问这些信息结构的系统元素之间的关系

7         出错处理和维护

7.1   出错信息

用一览表列出本系统各种可能出错或故障的信息形式及其含义

7.2   补救措施

说明系统故障出现后可能采取的变通措施，包括：

a.         后备技术——当系统原始数据一旦丢失时，启用副本的建立和启动技术

b.         降效技术——使用另一效率稍低的方法以求得所需结果的某些部分，如手工操作和人工记录数据

c.         恢复及再启动技术——让系统从故障点恢复执行或系统重新启动运行的方法等

7.3   系统维护

说明专门安排用于系统检测与维护的检测点和系统检测维护的专用模块等

8         尚待解决的问题

说明本设计中尚待解决而系统完成之前应该解决的问题

 

附加说明：

• 本规范根据国家标准GB/T  8566-1995的规定，参照国家标准GB  8567-88而制定
• 编写本文档时，要求具有本规范规定的所有条目。如果某条目内容在其他地方已说明或无内容可填写，应声明或填写“无内容可填写”，并在可能的情况下说明理由
• 编制文档时，文档排印格式按“文档排版印刷格式约定”编制