《概要设计说明书》编写参考指南

《《概要设计说明书》编写参考指南》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、《概要设计说明书》编写参考指南1．导言本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。1．1目的本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。1．2范围本文档用于软件设计阶段的概要设计，它的上游是《需求分析规格书》，下游是《详细设计说明书》，并为《详细设计说明书》提供测试的依据。软件概要设计的范围是：软件系统总体结构设计、全局数据库和数据结构设计、外部接

2、口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖《需求规格说明书》中的功能点列表、性能点列表、接口列表。1．3命名规则变量对象命名规则：申明全局变量、局部变量对象的命名规则。数据库对象命名规则：申明数据库表名、字段名、索引名、视图名等对象的命名规则。1．4术语定义术语定义或解释一般用表格形式给出，如表1所示。表1术语定义或解释表序号术语名称术语定义1总体结构软件系统的总体逻辑结构。为—树形的功能模块结构图。2外部接口本软件系统与其他软件系统之间的接口，接口设施可以是中间件。接口描述包括：传输方式、

3、带宽、数据结构、传输频率、传输量、传输协议3数据结构数据结构包括：数据库表的结构、其他数据结构等4概念数据模型CDM关系数据库的逻辑设计模型，叫做概念数据模型；主要内容包括—张逻辑E-R图及其相应的数据字典5物理数据模型PDM关系数据库的物理设计模型，叫做物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典6视图在基表或其他视图之上建立的一张虚表，叫做视图，它具有物理表的许多性质，在数据处理和授权上很有用7角色数据库中享有某些特权操作的用户，叫做角色。角色的权利通过授权来实现8子系统具有相对独立功能的小系统叫做子系

4、统；一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成9模块具有功能独立、能被调用的信息单元叫做模块。10内部接口软件系统内部各子系统之间、各部件之间、各模板之间的接口，叫做内部接口。接口描述包括：调用方式、入口信息、出口信息等11相关文件指当本文件内容变更后，可能引起变更的其他文件。如需求分析报告、计细设计说明书、测试计划、用户手册12参考资料指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则1．5参考资科[l]需求规格说明书[2]软件开发合同[3]数据库设计规范[4]命名规范1．6相

5、关文档[1]《详细设计说明书》[2]源程序清单[3]测试计划及报告[4]《用户使用手册》1．7版本更新记录版本更新记录格式，如表2所示。表2版本更新记录版本号创建者创建日期维护者维护日期维护纪要2．总体设计2.1总体结构设计软件系统的总体逻辑结构，按照不同的设计方法，有不同的总体逻辑结构。对于结构化设计方法，画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能描绘出功能能模块之间的关系。总体结构示意图，如图1所示（也可画成竖向的）图1总体结构示意图2．2运行环境设计该软件系统的运行环境：硬件平台：（1）服务

6、器的最低配置要求（2）工作站的最低配置要求（3）外设的要求软件平台：（1）服务器操作系统（2）数据库管理系统（3）中间件（4）客户端的操作系统（5）客户端的平台软件网络平台：（1）通信协议（2）通信带宽2．3子系统清单子系统清单，如表3所示表3子系统清单子系统编号子系统英文名子系统功能简述子系统之间的关系SS1SS2SS32．4功能模块清单功能模块清单，如表4所示表4功能模块清单模块编号模块英文名模块功能简述模块的接口简述M1-1M1-2M2-13．模块功能分配具有功能独立，能被调用的信息单元叫做模块。模块是结构化设计中的

7、概念，模块功能分配的目的，就是为了将具有相同功能的模块合并，从中提取公用模块，形成公用部件，按照构件或中间件的方式加以实现，作为本系统的公用资源，甚至作为公司级组织的公用资源，从而充实公司级的构件库或中间件库，优化系统设计，加快开发速度，提高开发质量。3．1专用模块功能分配专用模块功能分配，如表5所示。表5专用模块功能分配专业模块编号模块英文名模块详细功能分配模块的接口标准M1-1M1-2M2-13．2公用模块功能分配公用模块功能分配，如表6所示：表6公用模块功能分配公用模块编号模块英文名模块详细功能分配模块的接口标准G-

8、1G-2G-34．数据结构设计4．1数据库表名清单数据库表名清单，如表7所示表7数据库表名清单序号中文表名英文表名表功能说明1234．2数据库表之间关系说明可以用E-R图表示，也可以用文字说明。4．3数据库表的详细清单每个表的详细清单内容包括：表名、字段中文名、字段英文名、字段的类型、宽度、精度、主键/