软件概要设计说明书软件工程专业

概要设计说明书概要设计说明书 1 1导言导言 对该文档的目的、功能范围、术语、相关文档、参考资对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。料、版本更新进行说明。1.11.1目的目的 旨在推动软件工程的规范化，使设计人员遵循统一的概旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。现、测试、维护、版本升级等。1 12 2范围范围本文档用于软件设计阶段的概要设计，它的上游本文档用于软件设计阶段的概要设计，它的上游( (依据的基依据的基线线) )是是需求分析规格书需求分析规格书它的下游是它的下游是详细设计说明书详细设计说明书，并为并为详细设计说明书详细设计说明书提供测试的依据。提供测试的依据。 概要设计说明书概要设计说明书 软件概要设计的范围是：软件系统总体结构设计、全局软件概要设计的范围是：软件系统总体结构设计、全局数据库和数据结构设试、外部接口设计、主要部件功能分配数据库和数据结构设试、外部接口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖设计、部件之间的接口设计等方面的内容。该范围应覆盖需求规格说明书需求规格说明书中的功能点列表、性能点列表、接口列中的功能点列表、性能点列表、接口列表。表。 概要设计说明书概要设计说明书 1 13 3命名规则命名规则 变量对象命名规则：申明全局变量、局部变变量对象命名规则：申明全局变量、局部变量对象的命名规则。量对象的命名规则。 数据库对象命名规则：申明数据库表名、字数据库对象命名规则：申明数据库表名、字段名、索引名、视图名等对象的命名规则。段名、索引名、视图名等对象的命名规则。1 14 4术语定义术语定义 术语定义或解释一般用表格形式给出，如表术语定义或解释一般用表格形式给出，如表所示。所示。 概要设计说明书概要设计说明书 序号术语名称术语定义1总体结构软件系统的总体逻辑结构。按照不同的设计方法，有不同的总体逻辑结构。若采用面向功能或面向数据的设计方法，则总体逻辑结构为一树形的功能模块结构。若采用面向对象或面向部件（构件）的设计方法，则总体逻辑结构为部件（构件）的组装图2外部接口本软件系统与其他软件系统之间的接口，接口设施可以是中间件。接口描述包括：传输方式、带宽、数据结构、传输结构、传输频率、传输量、传输协议3数据结构数据结构包括：数据库表结构、其他数据结构等。4概念数据模型CDM关系数据库的逻辑设计模型，叫做概念数据模型。主要内容包括一张逻辑ER图及其相应的数据字典。5物理数据模型PDM关系数据库的物理设计模型，叫做物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典6视图在基表或其他视图之上建立的一张虚表，叫做视图，它具有物理表的许多性质，在数据处理和授权上很有用 概要设计说明书概要设计说明书 序号术语名称术语定义7角色数据库中享有某些特权操作的用户，叫做角色。角色的权利通过授权来实现8子系统具有相对独立功能的小系统叫做子系统。一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成9模块具有功能独立、能被调用的信息单元叫做模块。模块是结构化设计中的概念10内部接口软件系统内部各子系统之间、各部件之间、各模块之间接口，叫做内部接口。接口描述包括：调用方式、入口信息、出口信息等11相关文件相关文件是指当文件内容变更后，可能引起变更的其他文件。如需求分析报告、详细设计说明书、测试计划、用户手册12参考资料参考资料是指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则 概要设计说明书概要设计说明书 1 15 5参考资料参考资料 11用户需求报告用户需求报告 22软件开发合同软件开发合同 33数据库设计规范数据库设计规范 44命名规范命名规范1 16 6相关文档相关文档 11详细设计说明书详细设计说明书 2 2源程序清单源程序清单 33测试计划及报告测试计划及报告 44用户使用手册用户使用手册1 17 7版本更新记录版本更新记录 版本更新记录格式，如下表所示。版本更新记录格式，如下表所示。 概要设计说明书概要设计说明书 2 2总体设计总体设计2 21 1总体结构设计总体结构设计 软件系统的总体逻辑结构，按照不同的设软件系统的总体逻辑结构，按照不同的设计方法，有不同的总体逻辑结构。以结构化设计方法，有不同的总体逻辑结构。以结构化设计方法为主，画出系统总体结构图，列出系统计方法为主，画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能的功能模块清单编号、名称、功能，并尽可能描绘出功能模块之间的关系。若用面向对象的描绘出功能模块之间的关系。若用面向对象的RoseRose工具进行分析和设计，则遵照工具进行分析和设计，则遵照RoseRose的要求的要求进行。进行。 概要设计说明书概要设计说明书 2 22 2运行环境设计运行环境设计 硬件平台：硬件平台： (1)(1)服务器的最低配置要求服务器的最低配置要求 (2)(2)工作站的最低配置要求工作站的最低配置要求 (3)(3)外设的要求外设的要求 软件平台：软件平台： (1)(1)服务器操作系统服务器操作系统 (2)(2)数据库管理系统数据库管理系统 (3)(3)中间件中间件 (4)(4)客户端的操作系统客户端的操作系统 (5)(5)客户端的平台软件客户端的平台软件 网络平台：网络平台： (1)(1)通信协议通信协议 (2)(2)通信带宽通信带宽 概要设计说明书概要设计说明书 2 23 3子系统清单子系统清单子系统清单如表所示子系统清单如表所示子系统编号子系统英文名子系统功能简述子系统之间的关系SSlSS2SS3 概要设计说明书概要设计说明书 2 24 4功能模块清单功能模块清单功能模块清单如表所示功能模块清单如表所示 模块编号 模块英文名模块功能简述 模块的接口简述 M 11 M 12 M 21 M 2- 2 概要设计说明书概要设计说明书 3 3模块模块( (部件部件) )功能分配功能分配 具有功能独立、能被调用的信息单元叫做模块。具有功能独立、能被调用的信息单元叫做模块。 模块是结构化设计中的概念；模块是结构化设计中的概念； 部件是面向对象设计中的概念。部件是面向对象设计中的概念。 功能分配的目的，就是为了将具有相同功能的合并，从中功能分配的目的，就是为了将具有相同功能的合并，从中提取公用部分，按照构件或中间件的方式加以实现，作为本系提取公用部分，按照构件或中间件的方式加以实现，作为本系统的公用资源，甚至作为公用资从而充实到构件库或中间件库，统的公用资源，甚至作为公用资从而充实到构件库或中间件库，优化系统设计，加快开发速度，提高开发质量。优化系统设计，加快开发速度，提高开发质量。 概要设计说明书概要设计说明书 3 31 1专用模块功能分配专用模块功能分配专用模块功能分配如表所示专用模块功能分配如表所示专用模块编号模块英文名模块详细功能分配模块的接口标准Ml1Ml2M2-1M2-2 概要设计说明书概要设计说明书 3 32 2公用模块功能分配公用模块功能分配公用模块功能分，如表所示公用模块功能分，如表所示公用模块编号 模块英文名模块详细功能分配模块的接口标准G1G-2G-3 概要设计说明书概要设计说明书 4数据结构设计数据结构设计4 41 1数据库表之间关系说明数据库表之间关系说明 可以用可以用E-RE-R图表示，也可以用文字说明。图表示，也可以用文字说明。4 42 2数据库表的详细清单数据库表的详细清单 每个表的详细清单内容包括：表名、字段中文名、每个表的详细清单内容包括：表名、字段中文名、字段英文名、字段的类型、宽度、精度、主键字段英文名、字段的类型、宽度、精度、主键/ /外键、空否外键、空否、取值约束（默认值、最大值、最小值）、索引否。、取值约束（默认值、最大值、最小值）、索引否。 概要设计说明书概要设计说明书 4 43 3视图设计视图设计 视图设计与授权有关，视图设计中要给出视图的中文视图设计与授权有关，视图设计中要给出视图的中文名、英文名，视图中的中文列名、英文列名、类型、宽度、名、英文名，视图中的中文列名、英文列名、类型、宽度、精度，每一列的具体算法，对应的基本表名。精度，每一列的具体算法，对应的基本表名。4.44.4其他数据结构设计其他数据结构设计 描述系统的其他数据结构设计内容。描述系统的其他数据结构设计内容。 概要设计说明书概要设计说明书 5 5接口设计接口设计对应每一个接口，都要详细列出具体内容。对应每一个接口，都要详细列出具体内容。 (1)(1)接口名称接口名称 (2)(2)接口内容接口内容 (3)(3)接口设施接口设施 (4)(4)接口的数据结构接口的数据结构 (5)(5)接口的传输速率接口的传输速率(Mbps)(Mbps) (6) (6)接口带宽接口带宽 (7)(7)接口协议接口协议 概要设计说明书概要设计说明书 7 7设计检查列表设计检查列表 按照需求文档的功能、性能和接口表，设计出概要按照需求文档的功能、性能和接口表，设计出概要设计检查列表以检查要设计是否覆盖需求分析，没有覆设计检查列表以检查要设计是否覆盖需求分析，没有覆盖就是不符合项，并将检查结果列出。盖就是不符合项，并将检查结果列出。7 71 1功能设计检查列表功能设计检查列表如表所示。如表所示。编号功能名称使用部门使用岗位功能描述输入内容系统响应输出内容是否覆盖123 概要设计说明书概要设计说明书 7 72 2性能设计检查列表性能设计检查列表性能设计检查列表如表所示性能设计检查列表如表所示编号性能名称使用部门使用岗位性能描述输入内容系统响应输出内容是否覆盖123 概要设计说明书概要设计说明书 73接口设计检查列表接口设计检查列表接口设计检查列表如表所示接口设计检查列表如表所示 编号 接口名称 接口规范 接口标准 入口参数 出口参数 传输频率 是否覆盖 1 2 3