软件项目管理概要设计说明书培训资料.docVIP

1 概要设计说明书 1．导言 1.1 目的 本文档的目旨在推动软件工程的规范化，对本系统的业务流程、软件架构、功能模块设计、数据库设计、接口设计等做了分析和说明，使设计人员遵循统一的软件设计规范，降低系统实现的风险，做到系统设计文档的规范性与全面性，以利于整个系统的实现、测试、维护等。 1.2 范围 本文档用于软件设计阶段的概要设计，它的依据的基线是《需求分析规格书》，它的下游是《详细设计说明书》，并为《详细设计说明书》提供测试的依据。 软件概要设计的范围是：软件系统业务流程分析、总体结构设计、全局数据库和数据结构设计、外部接口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖《需求规格说明书》中的功能点列表、性能点列表。 1.3 命名规则 1.3.1 变量对象命名规则： 1、局部变量：采用驼峰式命名规则，第一单词全小写，其他单词首字母大写。例如：userName。 2、全局变量：首字母为大写的P，后面与局部变量的命名一致。例如：PuserName。 3、函数名：。采用驼峰式命名规则，第一单词全小写，其他单词首字母大写例如：addUser()。 4、常量：所有字母均要小写。例如：name。 5、类：首字母为大写的C，其他的单词首字母都大写。例如：CUser。 6、对象：与局部变量命名规则一致。例如：userOne。 1.3.2数据库对象命名规则： 1、数据库表名：采用驼峰式命名规则。例如：cpInfo。 2、字段名：表名首字母小写加下划线加相应单词小写。若表名首字母相同的，则在字段名的前两个字母为表名的前两个字母小写。例如：u_name。 3、索引名：“index_”加相应的名称。例如：index_name。 4、视图名：首字母为大写的V，后面加相应的名称。例如：Vpest。 1.4 术语定义 术语定义如表1所示。 表1 术语定义表 序 号 术 语 名 称 术 语 定 义 1 总体结构 软件系统的总体逻辑结构。按照不同的设计方法，有不同的总体逻辑结构。若采用面向功能或面向数据的设计方法，则总体逻辑结构为一树形的功能模块结构图。若采用面向对象或面向部件（构件）的设计方法，则总体逻辑结构为部件（构件）的组装图 2 外部接口 本软件系统与其他软件系统之间的接口，接口设施可以是中间件。接口描述包括：传输方式、带宽、数据结构、传输频率、传输量、传输协议 3 数据结构 数据结构包括：数据库表的结构、其他数据结构等 4 概念数据 模型CDM 关系数据库的逻辑设计模型，叫做概念数据模型。主要内容包括一张逻辑E-R图及其相应的数据字典 5 物理数据 模型PDM 关系数据库的物理设计模型，叫做物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典 6 视图 在基表或其他视图之上建立的一张虚表，叫做视图，它具有物理表的许多性质，在数据处理和授权上很有用 7 角色 数据库中享有某些特权操作的用户，叫做角色。角色的权利通过授权来实现 8 子系统 具有相对独立功能的小系统叫做子系统。一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成 9 模块 具有功能独立、能被调用的信息单元叫做模块。模块是结构化设计中的概念 10 内部接口 软件系统内部各子系统之间、各部件之间、各模板之间的接口，叫做内部接口。接口描述包括：调用方式、入口信息、出口信息等 11 相关文件 相关文件是指当本文件内容变更后，可能引起变更的其他文件。如需求分析报告、详细设计说明书、测试计划、用户手册 12 参考资料 参考资料是指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则 1.5 参考资料 [1] 用户需求报告 [2] 软件开发合同 [3] 数据库设计规范 [4] 命名规范 1.6 相关文档 [1] 《详细设计说明书》 [2] 源程序清单 [3] 测试计划及报告 [4] 《用户使用手册》 2．业务流程分析 2.1 业务流程分析 依据前面的需求分析说明书，我们从整个系统中提取了普通用户和管理员两实体（操作员）。从用户和管理员两个角度对本系统的业务流程进行分析说明，绘制出如图1所示的业务流程图。 图 1 业务流程图图中符号说明： 图中符号说明：1、图中红色实绩箭头为系统管理员所拥有的操作。 2、图中蓝色虚线箭头为普通用户不可操作，但要沿箭头方向传送数据。 3、图中黑色虚线方框表示需要人工处理过程。 2.1.1系统的计算模式 依据用户的要求和整个系统的特征，我们这个系统采用B/S的计算模式，如图2所示。 图 2 柑橘虫害专家系统计算模式 2.1.2 用户操作流程 首先，用户要先注册登录，或以游客的身份登录本网站。登录后可以进行浏览本站内的信息、柑橘虫害诊断、浏览用户的留言信息、发表或回复留言、修改用户的基本信息（游客不拥有