概要设计格式和内容

1引言

1.1编写目的

说明编写这份概要设计说明书的目的，指出预期的读者。

1.2背景

说明：

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

b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的平台。

1.3定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4参考资料

列出有关的参考文件，如：

a. 本项目的经核准的计划任务书或合同，上级机关的批文；

b. 属于本项目的其他已发表文件；

c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2总体设计

使读者有个全局观，对后面的模块设计有准备。

2.1需求规定

说明对本系统的主要的输入输出项目、处理的功能性能要求。

2.2运行环境

简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。

2.3基本设计概念和处理流程

说明本系统的基本设计概念和处理流程，尽量使用图表的形式。

程序设计的基本概念有程序、数据、子程序、子例程、协同例程、模块以及顺序性、并发性、并行性、和分布性等。

2.4结构

用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.

2.5功能需求与程序的关系

本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：

2.6人工处理过程

说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。

2.7尚未解决的问题

说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。

3接口设计

这些接口不是编程中的interface，而是软件的可用资源。使读者可以了解到有哪些可供使用的资源。

3.1用户接口

说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。

3.2外部接口

说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。

3.3内部接口

说明本系统之内的各个系统元素之间的接口的安排。

4运行设计

4.1运行模块组合

说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。

4.2运行控制

说明每一种外界的运行控制的方式方法和操作步骤。

4.3运行时间

说明每种运行模块组合将占用各种资源的时间。

5软件结构设计

阐述总体设计里的各子系统和子系统里各模块的如下内容：

每个模块做什么，实现了哪些功能
每个模块怎么做，包括输入、输出、逻辑、与其他模块的衔接、接口
每个模块所处的逻辑位置
每个模块所处的物理位置
每个模块的层次结构，可以用软件框图来展示
每个模块的关系，诸如依赖、通信等关系
每个模块的接口，模块之间如何传递信息以及信息本身的结构
每个模块的处理方式，其需要满足于哪些功能或性能上的要求

6系统数据结构设计

6.1逻辑结构设计要点

给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。

6.2物理结构设计要点

给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。

6.3数据结构与程序的关系

说明各个数据结构与访问这些数据结构的形式:

7系统出错处理设计

7.1出错信息

用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含义及处理方法。

7.2补救措施

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

a. 后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；

b. 降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；

c. 恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。

7.3系统维护设计

说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。