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

第1页 共11页 软件概要设计说明书编写规范 1 主题内容与适用范围 本规范规定了软件概要设计说明书编写的基本内容。 本规范主要适用于本公司过程控制软件开发人员编写概要设计使用，其它软件的概要设计可参考执行。 2 引用标准 GB 8655 计算机软件开发规范 GB 8567 计算机软件产品开发文件编制指南 GB/T 11457 软件工程术语 3 概述 软件概要设计的过程,即根据软件需求说明书的要求，将软件进行功能模块化，使得需求分析中提出的每一个功能要求都可由某个功能模块或几个功能模块的组合来实现。概要设计说明书即描述这些功能模块的功能以及模块间的关系。同时，为实现这些要求，还需设计有关的数据库和数据结构。 概要设计质量的好坏，直接影响到详细设计和最终的产品质量。在编写概要设计说明书时，应注意以下几个方面: 1) 完整性：检查是否覆盖了所有的功能要求。 2) 正确性：所描述的内容要正确。 3) 一致性：描述的内容和术语与需求分析要一致。 4) 可读性：表达方式要清晰，逻辑清楚，多采用图表方式，便于相互理解和交流。 5) 必要性：所设计的模块或数据结构是必要的。 6) 可追溯性：从需求说明中的某个功能可追溯到实现该功能的模块，反过来从模块实现功能可追溯到需求说明的某个功能要求。 4 概要设计说明书的编写内容要求 《软件概要设计说明书》的内容可根据软件的复杂程度由项目设计师写出编写提纲，组织编写。这里仅给出一般的编写内容，项目设计师可根据具体情况参照相关的内容组织编写。概要设计说明书的编写内容一般应包括软件结构设计、数据结构设计、接口设计、功能模块设计、系统初始化设计和系统出错处理设计等几个部分。如某些内容与《产品标准》或《产品设计规范》重复，可视需要进行剪裁或注明出处。 第2 页 共1 1 页 4.1 软件结构和流程设计 软件结构设计的过程即适当地划分软件的层次、模块结构。一般可将软件按纵向逻辑调用关系划分成若干个层次；每一层横向按计算机处理功能归类划分成若干个模块。每个模块又可分成若干个子模块；每个子模块还可分成更小的子－子模块…；最下层的模块完成最具体的功能。软件结构可以用模块层次图、模块控制流程图和数据控制流程图来表示。 4.1.1 模块层次图 模块层次图是一种以软件的功能层次关系展现的逻辑结构图。如一个数据采集系统，可将软件结构从内到外分成五个层次如下: 第一层：OS层； 第二层：设备管理层； 第三层: 服务程序...