3软件概要设计说明书编写规范.docx

1、3软件概要设计说明书编写规范软件概要设计说明书编写规范1 主题内容与适用范围本规范规定了软件概要设计说明书编写的基本内容。本规范主要适用于本公司过程控制软件开发人员编写概要设计使用，其它软件的概要设计可参考执行。2 引用标准GB 8655 计算机软件开发规范GB 8567 计算机软件产品开发文件编制指南GB/T 11457 软件工程术语3 概述软件概要设计的过程,即根据软件需求说明书的要求，将软件进行功能模块化，使得需求分析中提出的每一个功能要求都可由某个功能模块或几个功能模块的组合来实现。概要设计说明书即描述这些功能模块的功能以及模块间的关系。同时，为实现这些要求，还需设计有关的数据库和数据

2、结构。概要设计质量的好坏，直接影响到详细设计和最终的产品质量。在编写概要设计说明书时，应注意以下几个方面:1) 完整性：检查是否覆盖了所有的功能要求。2) 正确性：所描述的内容要正确。3) 一致性：描述的内容和术语与需求分析要一致。4) 可读性：表达方式要清晰，逻辑清楚，多采用图表方式，便于相互理解和交流。5) 必要性：所设计的模块或数据结构是必要的。6) 可追溯性：从需求说明中的某个功能可追溯到实现该功能的模块，反过来从模块实现功能可追溯到需求说明的某个功能要求。4 概要设计说明书的编写内容要求软件概要设计说明书的内容可根据软件的复杂程度由项目设计师写出编写提纲，组织编写。这里仅给出一般的编

3、写内容，项目设计师可根据具体情况参照相关的内容组织编写。概要设计说明书的编写内容一般应包括软件结构设计、数据结构设计、接口设计、功能模块设计、系统初始化设计和系统出错处理设计等几个部分。如某些内容与产品标准或产品设计规范重复，可视需要进行剪裁或注明出处。4.1 软件结构和流程设计软件结构设计的过程即适当地划分软件的层次、模块结构。一般可将软件按纵向逻辑调用关系划分成若干个层次；每一层横向按计算机处理功能归类划分成若干个模块。每个模块又可分成若干个子模块；每个子模块还可分成更小的子子模块；最下层的模块完成最具体的功能。软件结构可以用模块层次图、模块控制流程图和数据控制流程图来表示。4.1.1 模

4、块层次图模块层次图是一种以软件的功能层次关系展现的逻辑结构图。如一个数据采集系统，可将软件结构从内到外分成五个层次如下:第一层：OS层；第二层：设备管理层；第三层: 服务程序层；第四层：应用软件层；第五层: 初始化程序层。每一层可能有若干个功能模块或子系统。应该详细列出每个层次的每个功能模块的名称、功能等。4.1.2 软件模块控制流程图软件模块控制流程图是一种按模块的驱动关系展现的模块逻辑关系图。说明对系统施加不同的外界运行控制时所引起的各种不同运行模块的组合的逻辑关系，如由人机会话引起的运行模块组合关系图，由网络通讯引起的运行模块组合关系图，由时钟中断引起的定时或周期调度运行模块组合的关系图

5、等等。4.1.3 软件数据控制流程图软件数据控制流程图是以系统管理的数据结构为核心说明软件模块与数据间的逻辑关系的描述方法。如针对某一数据结构，与该结构有关的软件模块(任务)及其逻辑关系结构，如： 对该数据结构进行定义的模块(任务) 对数据进行操作(修改、删除、追加等)的有关模块(任务) 访问该数据的有关模块(任务) 访问该数据结构的安全性保护措施等等。4.2 数据结构设计数据结构设计即设计系统中所管理的基本数据以及软件执行过程中的协调控制数据的数据结构、数值取值范围、意义以及数值的变化过程等。一般分为数据库结构设计、共享数据表结构设计和文件数据结构设计等内容。4.2.1 数据库设计系统所管理

6、的基本数据一般应设计成数据库记录形式，如数据采集系统中的采集数据，包括：模拟量输入点记录、开关量输入点记录、数值量点记录、逻辑量点记录等。数据库设计一般包括结构设计和数据定义两部分。1) 数据库结构数据库结构定义即提供一种应用软件支撑环境，属于支撑软件的范畴，当使用通用数据库时，应指明所使用的数据库的名称和版本号；当开发专用的数据库时，要进行数据库结构设计，包括： 数据库结构设计 索引方式 数据库访问函数设计 数据安全性设计 数据一致性设计2) 数据定义数据定义属于应用软件的范畴。是系统设计人员在所使用数据库结构的基础上，根据应用软件的要求进行数据定义(如记录项定义、记录属性和运行状态定义等)

7、。包括记录类型，每一种记录的数据项数，索引关键字等，针对每个数据项进行定义，如： 项的索引名称 数据项的存储要求(Bytes或Bits) 数据属性(整型、浮点、字符等) 数据的状态(静态、动态等) 数据的意义 动态数据的变化过程 数据范围 访问权限 输入输出格式等。3) 数据库操作与软件模块间的关系说明对数据库记录项进行修改的程序模块，可采用图表的形式说明。8.2.2 共享数据表设计共享数据表一般为软件模块直接管理的表格或缓冲区形式的数据表。这种数据表一般呈层次关系，通常为多个模块(任务)间的协调运行、数据共享用。针对每一种表格(缓冲区),应包括以下设计： 1) 逻辑结构设计逻辑结构设计包括数

8、据结构的名称、数据结构的层次关系、每一层的数据记录数及索引方法等。2) 物理结构设计物理结构设计给出数据表的存储要求，包括每一层每一项的 项名 存储要求(Bytes或Bits) 数据的属性(整型、浮点、字符等) 数据范围 数据的意义 数据的状态(静态、动态等) 数据变化过程等。3) 数据表与软件模块间的关系说明各个数据表与访问这些数据结构的程序模块之间的关系，可采用图表的形式说明。4) 数据表访问的安全性和数据一致性设计，如采用信号灯访问数据表的方法、要求等。文件结构设计文件结构设计即针对系统中管理的每一个数据文件进行设计，包括：1) 文件的类型、结构、长度；2) 数据项的结构定义，包括: 数

9、据项的存储要求(Bytes或Bits) 数据属性(整型、浮点、字符等) 数据范围 访问权限 修改权限 输入输出格式3) 数据文件与软件模块间的关系说明各个数据文件与访问这些数据文件的程序模块之间的关系，可采用图表的形式说明。4.2.2 数据结构设计时应考虑的问题在进行数据库设计、控制表设计和文件结构设计时，应考虑以下内容：1) 数据的一致性；2) 数据的完整性(访问权限)；3) 数据访问的执行效率。4.3 接口设计接口设计一般包括用户接口设计、外部接口设计和内部接口设计三个部分。4.3.1 用户接口设计用户接口设计一般要包括用户操作过程(人机会话)设计、显示画面设计和打印报表设计等。4.3.1

10、.1 用户操作过程设计用户操作过程设计一般包括以下内容:1) 专用键盘定义(如果用到专用键盘的话)2) 用户对话过程设计(包括功能键定义，菜单条、屏幕按钮等设计)3) 操作提示和错误提示信息设计4.3.1.2 显示画面设计显示画面设计包括：1) 屏幕划分，窗口设计2) 显示参数格式、状态、颜色定义显示信息格式、状态、颜色定义4.3.1.3 打印信息接口设计打印信息接口设计包括:1) 打印驱动方式(定时、随机、事件驱动等)2) 打印页面设计，如表头内容、表格行数、内容等3) 表格打印参数格式，如长度、小数位数等4) 信息打印格式，如信息内容、变量格式等4.3.2 外部接口设计外部接口设计包括外部

11、硬件接口和外部软件接口设计。如通讯接口、直接硬件接口、支撑软件接口以及与其它软件模块间的接口设计。4.3.2.1 外部网络通讯接口设计外部通讯网络接口设计是指与本系统范围外的网络接口，如上层管理网等的接口和协议、信息流向、信息、长度和通讯周期等。4.3.2.2 外部串行口通讯接口设计外部串行口通讯接口设计是指与本系统范围外的其它系统采用串行口通讯时的接口关系，包括通讯协议(握手方式、波特率、校验方式等)、信息流向、信息长度和通讯周期等。还应说明当通讯过于频繁或超时时的措施。4.3.2.3 与各支持软件的接口设计指本软件要用到的支持软件的接口设计。如数据库管理服务接口，画面信息库，控制算法、接口

12、设计等。4.3.2.4 外部软件模块通讯接口设计如果本软件还要与其它子系统通讯时，应定义本软件与其它软件模块间的接口关系。包括启动、被启动方式、输入和输出信息的介质及其格式。4.3.2.5 直接硬件接口设计指本软件要针对其直接编程的硬件接口设计。如过程PIO板等的接口设计、专用键盘的编码设计等。4.3.3 内部接口设计内部接口设计包括功能模块(任务)间的驱动关系、公用服务模块间的调用关系以及局部网络应用层的通讯协议等的设计。4.3.3.1 任务接口设计任务接口设计为以每个任务的启动条件为核心的接口设计，包括：1) 启动的形式(如事件启动，消息启动等)2) 启动的条件(定时启动、周期启动、随机启

13、动)、定时启动的时间、周期启动的周期间隔、随机启动的启动条件等3) 启动时输入的信息及格式4.3.3.2 公用函数调用接口公用函数调用接口设计为以每个公用函数的调用格式为核心的接口设计，包括：1) 函数名称2) 调用格式3) 输入变量定义4) 返回参数定义5) 如果函数中用到用户缓冲区的话，对缓冲区进行定义6) 出错信息定义4.3.3.3 系统内部网络应用层通讯协议系统内部网络应用层通讯协议指系统内部各网络节点间的通讯协议，一般包括：1) 协议号2) 该协议发送方节点和发送模块(任务)3) 接收方节点和处理模块(任务)4) 通知方式5) 数据包长度、内容、格式4.4 软件功能模块设计软件功能模

14、块设计即按照软件结构设计中功能模块的划分，以及数据结构设计和接口设计的要求，针对每一个功能模块进行的概要设计。在一个多任务系统中，功能模块概要设计一般为任务概要设计和公用模块(公用函数)设计。4.4.1 任务/模块概要设计针对每一个任务/模块，规定该任务/模块的启动条件，外部数据和任务应实现的功能。一般包括以下内容:1) 任务/模块名称2) 功能描述：描述该任务/模块实现的功能，与需求功能的对应关系，运行要求(包括时间要求，数据精度要求等)等。3) 启动方式：描述该任务/模块被启动运行的条件(如周期性启动还是事件启动等)，运行方式(是一次性运行还是反复运行的任务/模块)。4) 初始化设计：描述

15、需要任务/模块进行初始化的参数、缓冲区等。5) 传递参数：描述该任务/模块被启动时传递的参数和状态。6) 传递的数据：描述该任务/模块运行过程中用到的外部数据或文件。7) 处理过程概要：按照功能要求，简要描述该任务/模块启动后的处理过程、注意事项。尤其是关系到全局的某些关键步骤和注意事项。边界条件处理：规定在边界条件或异常情况下的处理方式，比如缓冲区超限、通讯过于频繁或超时、传递的参数超过处理范围等情况下的处理等。4.4.2 公用模块设计公用模块一般是在软件结构设计时经过软件功能的纵向分析后，抽象出来的公共函数(子程序)。这些公共函数一般用于帮助应用任务完成某些特定的功能，如访问数据库、访问历

16、史库、网络发送、接收子程序等。跟任务概要设计一样，公用模块设计也应包括以下内容:1) 模块名称2) 功能描述3) 调用形式和参数详细描述4) 执行处理过程 5) 边界条件处理6) 调用返回参数(错误码)4.5 系统异常处理设计系统异常处理即包括系统的软硬件诊断、错误处理措施的设计、故障恢复的方法等。4.5.1 异常项目、级别和诊断方法设计针对系统故障或操作错误，定义什么样的故障或错误为异常项目。另外，还可针对不同的故障设定不同的级别及其故障诊断的方法。4.5.2 故障信息设计针对上述故障项目，说明每一种故障出现时的通知方式和信息的格式、含义和处理方法。4.5.3 补救措施说明故障出现后根据故障

17、级别采取的补救措施，如：1) 后备技术设计：为了减少因系统故障造成的数据丢失，对于系统中的某些关键数据(如历史数据、事件信息、累积数据等)周期性进行备份。说明备份的方法、范围和备份周期。2) 降效技术设计：说明当系统某一局部发生故障时，是否采取降效技术。如降低部分效率或舍弃某一部分功能由其它的方法进行补偿的措施。3) 恢复及再启动技术：确定系统从异常状态恢复到正常状态的方法。如根据故障的波及面系统采取的恢复方法，如：a) 如果数据缓冲区被破坏，在不停止系统的情况下，通过恢复故障前备份的数据缓冲区的内容；b) 如果诊断到某个任务发生故障，可终止该任务运行后再重新启动该任务继续运行；c) 整个系统重新热启动运行或冷启动运行。4.5.4 系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排。如设计运行记录专用模块，在模块运行的重要分支处插入检查点，进行软件运行记录等。便于软件维护人员对运行情况进行分析。记录的内容应该包括经过的时间、模块(任务)的名称及通过时的某些关键参数。4.6 系统初始化设计系统初始化设计包括以下内容：1) 内外存分配;2) 程序装载方法;3) 初始数据的内容和装载方法；4) 热备份数据的内容、备份方法、装载方法；5) 系统启动运行的方式(冷启动方式，热启动方式)。