概要方案设计书说明书——第五组.docVIP

XXXX公司 高校管理系统 概要设计说明书 文件编号：XXX – GYSJSM – 002 生效日期： 版本号： 修改状态： 密级： 总页数：25 正文：系统概要设计 附录： 编制： 日期：2011年8月19ri 修改： 日期： 批准： 日期： 目录 第1章 导言 1 1.1 目的 1 1.2 范围 1 1.3 命名规则 1 1.4 术语定义 3 1.5 参考资料 3 1.6 相关文档 3 1.7 版本更新记录 4 第2章 总体设计 8 2.1 总体结构设计 8 2.2 运行环境设计 9 2.3 子系统清单 10 2.4 功能模块清单 11 第3章 模块（部件）功能分配 16 3.1 专用模块功能分配 16 3.2 公用模块功能分配 20 第4章 数据结构设计 21 4.1 数据库表名清单 21 4.2 数据库表之间关系说明 22 4.3 数据库表的详细清单 26 4.4 视图设计 34 4.5 其他数据结构设计 36 第5章 接口设计 37 第6章 其他设计 37 第7章 设计检查列表 38 7.1 功能设计检查列表 38 7.2 性能设计检查列表 38 7.3 接口设计检查列表 38 导言 本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。 目的 本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。 通过此次的文档编写，我们能够熟练掌握概要设计的文档编写以及要注意得格式，规范文档的内容。此外，在协作上要更一层次得提高，增加沟通能力，增强团结意识。使项目组成员可以深刻理解软件设计的步骤，感受项目开发的过程，为今后的软件开发打下基础，同时，也使我们更加深刻的认识到需求文档的重要性，它是今后软件开发的根本依据，也是用户需求的规范化表述，对后续进一步开发设计具有重要作用。与此同时，我们还要认识到团队合作的重要性，一个人无法完成一个项目，只有频繁沟通，互相理解才能很好地完成我们的任务。在项目进行的过程中，还要注意规范化和统一化，这样设计人员才能遵循统一的概要设计书写规范，从而节省制作文档的时间，降低系统实现的难度，做到系统设计资料的规范性与全面性。 范围 本文档用于软件设计阶段的概要设计，它的上游（依据的基线）是《需要分析规格书》，它的下游是《详细设计说明书》，并为《详细设计说明书》提供测试的依据。 软件概要设计的范围是：软件系统总体结构设计、全局数据库和数据结构设计、外部接口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖《需求规格说明书》中的功能点列表、性能点列表、接口列表。 命名规则 1.3.1 模块命名规则：本系统的模块命名规则为每个单词头一个字母大写。 1.3.2函数(方法)命名规则 函数(方法)命名采用“动作+属性” 的方法。并且，动作以小写字母开始，属性以大写字母开始。常用的动作有：is、get、set、add、 update、del等。 例如：getName、setName、isSysManager、saveXXX、delXXX等。 1.3.3变量命名规则 构成名称的一个英文单词小写，之后的单词的第一个字母大写。例：userName 全局变量： 变量名前加类名的首字母（小写） 例：类名为EmpOnServiceimpl 的类 全局变量名为 euserName 局部变量：变量名前加方法名的首字母（小写） 1.3.4数据　　数据文件命名采用系统名+_+文件类型，比如系统名为ollegemanagement,则数据库文件命名为collegemanagement_database.mdf文件名全部采用小写。1.3.数据库表命名，表名长度不能超过30个字符，表名中含有单词全部采用单数形式，单词首写字母要大写，多个单词间不用任何连接符号。库中有多个系统，表名采用系统名称+单词或多个单词，系统名是开发系统的缩写，系统名称全部采用小写英文字符,如bbsTitl,bbsForuType。关连表命名规则为Re_表A_表B,Re是Relative的缩写，如： Re_User_Arti, Re_User_Form。数据库字段命名规范，数据库字段名全部采用小写英文单词，单词之间用”_”隔开，命名规则是表别名+单词，如：user_name,user_pwd。表别名规则，取单词的前 4 个字母Re_Arti, Re_User_Form，表别名为reau。 1.3.7视图命名规则　　视图名采用规则View_表A_表B_表C,View表示视图。这个视图由几个表产生就用”_”连接几个表的名，如果表过多可以将表名适当简化，但一定要列出所有表名。