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

此编写规范是本公司软件项目的概要设计过程的主要可交付成果—概要设计说明书的编写规范。本规范定义了概要设计说明书的最大集标准范本。特定项目组可以根据本规范进行合理的内容剪裁，对于没有包含的元素，请填写“无。”，以便保持所有概要设计说明书在内容编排上的一致性性。

本规范强制要求对软件需求有良好的可追踪性。编写人员应该使用适当的文档间的超级链接技术来加强这种可追踪性。

建议使用本规范的组织在实际应用中根据本规范给设计人员提供模板。 本规范提到的主要设计模型请参考《软件设计过程指南》。

1 引言

1.1 1.2 1.3 1.3.1

编写目的

（描述本文档的编写目的。） 项目背景

（描述本文档所在的软件项目的背景资料。） 定义

引用名词1 名词1的解释

…

（定义本概要设计说明书所引用的名词的含义。） 1.4 1.4.1 …

（罗列本概要设计说明书在编写过程中参考的文献资料。） 参考资料

《文档名称1》 版本号，作者，编写时间

2 任务概述

2.1 2.2 2.3

目标

（描述本文档所在的软件项目的主要目标。） 运行环境

（描述本文档设计的软件运行时依赖的软硬组件和在功能完整的前提下必备的网络环境或设备。） 需求概述

（描述本文档设计的软件的基本数据、功能和行为需求。建议采用规范说明中建议的超级链接技术和需求规格说明书中的内容进行相关联。）

3 软件设计规范

3.1 3.2 3.3

设计方法规范 设计模型规范

程序设计语言（PDL）规范

（PDL语言规范见《程序设计语言（PDL）规范》。如果该规范不能满足设计要求，可以补充或重新 定义。） 3.4

编程语言规范

( 软件项目小组制定在设计时应该共同遵守的标准：采用的设计方法、设计模型、描述软件处理过程的伪

XXX有限公司

文件名称 概要设计说明书编写规范 文件编号 XXX 制定部门 技术部 制定日期 码规范以及系统物理实现做采用的编程语言的规范。这些规范同样适合在详细设计说明书中。)

版次 页码 4 结构设计

4.1

软件结构

（根据前面定义的设计方法规范采用合适的结构模型来描述软件模块化成不同组件之间的依赖关系。对于复杂的软件系统，设计人员应该将结构模型层次化。先展示系统与外部环境或外部组件之间的依赖关系，然后将系统分成子系统后之间的依赖关系，再具体到子模块…。图示符号：系统结构图、UML的类图和对象图等。） 4.2 4.3

软件结构描述

（准确地描述软件结构中各种组件的处理功能或行为、异常处理对策和约束条件。） 组件交互

（根据软件结构中的系统架构展现有依赖关系组件之间的交互过程。图示符号：系统流程图、UML的顺序

图和协作图等。） 4.4

组件交互描述

（准确地描述软件结构中不同组件之间或与外部环境或外部组件之间交互的信息（数据、控制或消息）。）

5 接口设计

( 对在节4中设计的组件之间的交互进行接口规范定义。接口规范要包含接口数据的类型、接口子程序的原型等。) 5.1 5.2 5.3

外部接口设计

（明确定义本文档设计的所有软件组件与外部环境（非人）或外部组件之间接口的规范。） 内部接口设计

（明确定义本文档设计的所有软件组件之间接口的规范。） 人机界面设计

（明确定义本文档设计的软件与操作这之间的接口界面规范。）

6 数据设计

6.1 6.2

数据对象和形成的数据结构

（明确定义本文档设计的软件处理的全局或核心数据对象（名称及属性等）和物理的数据结构。） 全局数据

（明确定义本文档设计的软件的全局或核心的数据。）

7 安全保密设计

（ 定义本文档设计的软件在安全保密方面的处理对策。）

8 维护设计

8.1

故障处理设计

（定义当本文档设计的软件在出现故障时的规范性的错误提示风格和处理方法，明确故障的历史记录形式。） 8.2

兼容性设计

（明确陈述本文档设计的软件在运行时如何适应外部依赖环境的变化。）

9 组件部署设计

（明确规定本文档设计的软件中的各种组件的组件名称和代码（源代码或目标代码）之间的关系。）

XXX有限公司

文件名称 制定部门 概要设计说明书编写规范 技术部 文件编号 制定日期 XXX 版次 页码 10 集成设计

（明确描述本文档设计的软件的各种组件在依赖平台上集成组装的策略、顺序和测试要点。）

11 复用设计

（明确描述本文档设计的软件的各种组件中哪些是以前开发的或外部的经过标准测试的组件、哪些新设 计的组件可以给其它软件开发提供借鉴。）

（以下是一些规定。） 附件：

附件一 宏定义格式

名称 值 附件二 数据结构定义格式

名称 定义 附件三 子程序定义格式

原型 返回 参数

XXX有限公司