《[计算机]概要设计说明书——第五组》由会员分享，可在线阅读，更多相关《[计算机]概要设计说明书——第五组（41页珍藏版）》请在金锄头文库上搜索。
1、XXXX公司高校管理系统概要设计说明书文件编号：XXX GYSJSM 002生效日期：版本号：修改状态：密级：总页数：25正文：系统概要设计附录：编制：日期：2011年8月19ri修改：日期：批准：日期：目录第1章导言11.1目的11.2范围11.3命名规则11.4术语定义31.5参考资料31.6相关文档31.7版本更新记录4第2章总体设计82.1总体结构设计82.2运行环境设计92.3子系统清单102.4功能模块清单11第3章模块（部件）功能分配163.1专用模块功能分配163.2公用模块功能分配20第4章数据结构设计214.1数据库表名清单214.2数据库表之间关系说明224.3数据库表的
2、详细清单264.4视图设计344.5其他数据结构设计36第5章接口设计37第6章其他设计37第7章设计检查列表387.1功能设计检查列表387.2性能设计检查列表387.3接口设计检查列表38I第1章 导言本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。1.1 目的本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。通过此次的文档编写，我们能够熟练掌握概要设计的文档编写以及要注意得格式，规范文档的内容。此外，在协作上要更一层次得提
3、高，增加沟通能力，增强团结意识。使项目组成员可以深刻理解软件设计的步骤，感受项目开发的过程，为今后的软件开发打下基础，同时，也使我们更加深刻的认识到需求文档的重要性，它是今后软件开发的根本依据，也是用户需求的规范化表述，对后续进一步开发设计具有重要作用。与此同时，我们还要认识到团队合作的重要性，一个人无法完成一个项目，只有频繁沟通，互相理解才能很好地完成我们的任务。在项目进行的过程中，还要注意规范化和统一化，这样设计人员才能遵循统一的概要设计书写规范，从而节省制作文档的时间，降低系统实现的难度，做到系统设计资料的规范性与全面性。1.2 范围本文档用于软件设计阶段的概要设计，它的上游（依据的基线
4、）是需要分析规格书，它的下游是详细设计说明书，并为详细设计说明书提供测试的依据。软件概要设计的范围是：软件系统总体结构设计、全局数据库和数据结构设计、外部接口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖需求规格说明书中的功能点列表、性能点列表、接口列表。1.3 命名规则1.3.1 模块命名规则：本系统的模块命名规则为每个单词头一个字母大写。1.3.2函数(方法)命名规则函数(方法)命名采用“动作+属性” 的方法。并且，动作以小写字母开始，属性以大写字母开始。常用的动作有：is、get、set、add、 update、del等。例如：getName、setName、i
5、sSysManager、saveXXX、delXXX等。1.3.3变量命名规则构成名称的一个英文单词小写，之后的单词的第一个字母大写。例：userName全局变量： 变量名前加类名的首字母（小写）例：类名为EmpOnServiceimpl 的类全局变量名为 euserName局部变量：变量名前加方法名的首字母（小写）1.3.4数据文件命名规则数据文件命名采用系统名+_+文件类型，比如系统名为collegemanagement,则数据库文件命名为collegemanagement_database.mdf。文件名全部采用小写。1.3.5数据库表命名规则数据库表命名规则，表名长度不能超过30个字符
6、，表名中含有单词全部采用单数形式，单词首写字母要大写，多个单词间不用任何连接符号。因库中有多个子系统，表名采用子系统名称+单词或多个单词前四个字母，子系统名是开发子系统的缩写，子系统名称全部采用小写英文字符,如bbsTitl,bbsForuType。关连表命名规则为Re_表A_表B,Re是Relative的缩写，如： Re_User_Arti, Re_User_Form。1.3.6数据库字段命名规则数据库字段命名规范，数据库字段名全部采用小写英文单词，单词之间用”_”隔开，命名规则是表别名+单词，如：user_name,user_pwd。表别名规则，取表名单词的前 4 个字母。如果是关联表，表
7、别名则取re+表A首字母+表B首字母；例如Re_Arti, Re_User_Form，表别名为reau。 1.3.7视图命名规则视图名采用规则View_表A_表B_表C,View表示视图。这个视图由几个表产生就用”_”连接几个表的名，如果表过多可以将表名适当简化，但一定要列出所有表名。1.3.8存储过程命名规则存储过程命名规则P_表名_存取过程名(缩写)，比如P_User_Del，P_ArticleType_AddData。1.3.9文件夹名命名规则 文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件
8、)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include 文件)，link（存放友情链接）,media(存放多媒体文件)等。1.3.10文件名命名规则文件名称统一用小写的英文字母、数字和下划线的组合。 1、图片的命名原则名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名： banner 标志性的图片取名为： logo在页面上位置不固定并且带有链接的小图片我们取名为 button 在页面上某一个位置连续出现，性质相同的链
9、接栏目的图片我们取名： menu 装饰用的照片我们取名： pic 不带链接表示标题的图片我们取名： title 例如： banner_sohu.gif 、banner_sina.gif、 menu_aboutus.gif 、 menu_job.gif、 title_news.gif、 logo_police.gif、 logo_national.gif 、 pic_people.jpg 。2、动态语言文件命名规则性质_描述，描述可以有多个单词，用”_”隔开，性质一般是该页面得概要。1.3.11控件命名方法控件名简写+英文描述，英文描述首字母大写：register_form.jsp，regist
10、er_post.jsp,topic_lock.jsp1.4 术语定义术语定义或解释一般用表格形式给出，如下表所示。表1_1术语定义或解释表序号术语名称术语定义1总体结构软件系统的总体逻辑结构。按照不同的设计方法，有不同的总体逻辑结构。若采用面向功能或面向数据的设计方法，则总体逻辑结构为一树形的功能模块结构图。若采用面向对象或面向部件（构件）的设计方法，则总体逻辑结构为部件（构件）的组装图。2外部接口本软件系统与其他逻辑系统之间的接口，接口设施可以是中间件。接口描述包括：传输方式、带宽、数据结构、传输频率、传输量、传输协议。3数据结构数据结构包括：数据库表的结构、其他数据结构等。4概念数据模型C
11、DM关系数据库的逻辑设计模型，叫做概念数据模型。主要内容包括一线逻辑E_R图及其相应的数据字典。5物理数据模型PDM关系数据库的物理设计模型，叫做物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典6视图在基表或其他视图之上建立的一张虚表，叫做视图，它具有物理表的许多性质，在数据处理和授权上很有用。7角色数据库中享有某些特权操作的用户，叫做角色。角色的权利通过授权来实现。8子系统具有相对独立功能的小系统叫做子系统。一个大的软件系统可以划分为多个子系统，每个子系统可由多个模块或多个部件组成。9模块具有功能独立、能被调用的信息单元叫做模块。模块是结构化设计中的概念。10内部接口软件系统内部
12、各子系统之间、各部件之间、各模板之间的接口，叫做内部接口。接口描述包括：调用方式、入口信息、出口信息等。11相关文件相关文件是指当本文件内容变更后，可能引起变更的其他文件。如需求分析报告、详细设计说明书、测试计划、用户手册。12参考资料参考资料是指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则1.5 参考资料1. 用户需求报告2. 软件开发合同3. 数据库设计规范4. 命名规范1.6 相关文档1. 详细设计说明书2. 源程序清单3. 测试计划及报告4. 用户使用手册1.7 版本更新记录版本更新记录格式，如下表所示。表1_2版本更新记录版本号创建者创建日期维护者维护日期维护纪要V1
13、.0刘皛，2011.8.19子系统清单，功能模块清单，模块功能分配，数据库表名清单，数据库表详细清单，视图设计，ER图（教室、研究所）陈鹤飞2011.8.19子系统清单，功能模块清单，数据库表名清单，数据库表详细清单， ER图（教师）高建新2011.8.19命名规则，子系统清单，功能模块清单，模块功能分配，数据库表名清单，数据库表详细清单，视图设计，ER图（班级、整合），总体结构设计，运行环境设计薄婧琛2011.8.19概要设计目的，院、系部分的E_R图、数据库表名清单、数据库表的详细清单、视图设计包阿如那2011.8.19子系统清单，功能模块清单，数据库表名清单，数据库表详细清单， ER图（
14、学生）王静2011.8.19E_R图（课程）、课程子系统清单、课程功能模块清单、课程专用模块功能分配、课程信息表宋云飞2011.8.19ER图（宿舍）王静2011-8-202.4 功能模块清单的整理 3.2 公用模块功能分配3.1 专用模块功能分配3.5 课程信息表的修改包阿如娜2011.8.20ER图修改（学生）、功能模块清单（学生）、模块功能分配（学生）、学生成绩信息表部分分修改陈鹤飞2011.8.20ER图修改（教师）、功能模块清单（教师）、模块功能分配（教师）、教师信息表部分修改刘皛2011.8.20ER图修改（教室、研究所）、功能模块清单（教室、研究所）、模块功能分配（教室、研究所）、教室、研究所信息表部分修改，数据库表名清单修改宋云飞2011.8.20ER图修改（宿舍）、功能模块清单（宿舍）、模块功能分配（宿舍）、宿舍信息表部分分修改薄婧琛2011.8.20ER图修改（学院、系）、功能模块清单（学院、系）、模块功能分配（学院、系）、学院、系信息表部分分修改高建新2011.8.20ER图修改（班级）、功能模
