软件工程总体-详细设计说明书

软件工程

概要设计说明书

编写概要设计说明书的目的是说明对程序系统总体设计的考虑，包括程序的基本流程和组织结构、输入/输出、接口设计、运行设计、数据结构设计和系统出错处理设计等，为系统的详细设计提供基础。其编写内容为：

1.引言

1.1背景

说明被开发软件的名称、项目提出者、开发者。

1.2参考资料

列出本文件用到的下列参考资料，包括作者、来源、编号、标题、发表日期、出版单位及保密级别等，如：

1）软件需求说明书。

2）同概要设计有关的其他文件资料

1.3术语和缩写词

列出本文件中专用的术语、定义和缩写词

2．需求

利用软件需求说明书，对以下各条内容进行细化、扩充或变更（若有的话）

2.1总体描述

对软件系统进行总的描述。用图表示本系统各部分之间的关系，以及用户机构与本系统主要部分之间的关系。

2.2功能

定量和定性地表示软件总体功能，并说明系统是如何满足功能需求的。

2.3性能

说明精度、时间特性、灵活性等要求。

2.4运行环境

简要说明对运行环境的规定，如设备、支持软件、接口、保密与安全等

3．总体结构设计

用图表说明本系统结构，即系统元素（子系统、模块子程序、公用程序等）的划分、模块之间的关系及分层控制关系

用图表形式表示个功能需求与模块的关系

4．接口设计

4.1外部接口

说明本系统同外界的所有接口安排，包括硬件接口、软件接口、用户接口

4.2 内部接口

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

5．运行设计

5.1运行过程

说明系统的运行过程（例如，装入、启动、停机、恢复、再启动等）

5.2系统逻辑流程

用图表形式描述系统的逻辑流程，即从输入开始，经过系统的处理，到输出的流程。集中表示系统的动态特性、入口和出口，与其它程序的接口、各种运行、优先级、循环和特殊处理。

6．系统数据结构设计

6.1逻辑数据结构设计

给出本系统（或子系统）内所使用的各个数据项、记录、文件的标识、定义、长度，以及它们之间的相互关系。

给出上述数据元素与各个程序的相互关系

6.2物理数据结构设计

给出本系统（或子系统）内所使用的各个数据项、记录、文件的存储要求，访问方法，存取单位，存取的物理关系（媒体，存储区域）

7．系统出错处理设计

7.1出错信息

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

7.2补救措施

说明故障出现后可能采用的变通措施，如后备技术、降效技术、恢复技术及再启动技术等

8．系统维护技术

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

细节设计说明书

编写详细设计说明书的目的是向程序员详细描述该软件系统各个层次中的每一个模块（或子程序）的设计细节。其编写内容为：

1．引言

1.1背景

说明该软件系统名称、开发者、细节设计原则和方法。

1.2参考资料

列出有关的参考资料名称、作者、发表日期、出版单位

1.3术语和缩写词

列出本文件中专用的术语、定义和缩写词

2．程序系统结构

用图表列出本程序系统内各个模块（或子程序）的名称、标识符，以及这些模块（或子程序）之间的层次关系

3．模块（或子程序）1（标识符）设计说明

从本文件3考试，逐个给出上述每个模块（或子程序）的设计考虑

3.1模块（或子程序）描述

简要描述安排本模块（或子程序）的目的意义、程序的特点

3.2功能

详细描述此模块（或子程序）要完成的主要功能

3.3输入项

描述每一个输入项的特征，如：标识符、数据类型、数据格式、数值的有效范围、输入方式等

3.4输出项

描述每一个输出项的特征，如：标识符、数据类型、数据格式、数值的有效范围、输出方式等

3.5处理过程

详细说明模块（或子程序）内部的处理过程、采用的算法、出错处理

3.6接口

分别列出和本模块（或子程序）有调用关系的所有模块（或子程序）及其调用关系，说明与本模块（或子程序）有关的数据结构

3.7限制条件

说明本模块（或子程序）运行中受到的限制条件

4．模块（或子程序）2（标识符）设计说明

用类似3的方式，说明第二个模块（或子程序）乃至第N个模块（或子程序）的设计考虑