概要方案说明书组文档格式.docx
《概要方案说明书组文档格式.docx》由会员分享，可在线阅读，更多相关《概要方案说明书组文档格式.docx（40页珍藏版）》请在冰豆网上搜索。
全局变量名为euserName
局部变量：
变量名前加方法名的首字母<
1.3.4数据文件命名规则
数据文件命名采用系统名+_+文件类型，比如系统名为collegemanagement,则数据库文件命名为collegemanagement_database.mdf。
文件名全部采用小写。
1.3.5数据库表命名规则
数据库表命名规则，表名长度不能超过30个字符，表名中含有单词全部采用单数形式，单词首写字母要大写，多个单词间不用任何连接符号。
因库中有多个子系统，表名采用子系统名称+单词或多个单词前四个字母，子系统名是开发子系统的缩写，子系统名称全部采用小写英文字符,如bbsTitl,bbsForuType。
关连表命名规则为Re_表A_表B,Re是Relative的缩写，如：
Re_User_Arti,Re_User_Form。
1.3.6数据库字段命名规则
数据库字段命名规范，数据库字段名全部采用小写英文单词，单词之间用”_”隔开，命名规则是表别名+单词，如：
user_name,user_pwd。
表别名规则，取表名单词的前4个字母。
如果是关联表，表别名则取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（存放图形文件>
，flash<
存放Flash文件），style（存放CSS文件>
，scripts<
存放Javascript脚本），inc（存放include文件>
，link<
存放友情链接）,media（存放多媒体文件>
等。
1.3.10文件名命名规则
文件名称统一用小写的英文字母、数字和下划线的组合。
1、图片的命名原则名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质例如广告、标志、菜单、按钮等等。
放置在页面顶部的广告、装饰图案等长方形的图片取名：
banner
标志性的图片取名为：
logo
在页面上位置不固定并且带有链接的小图片我们取名为button
在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：
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，register_post.jsp,topic_lock.jsp
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].《用户使用手册》
1.7版本更新记录
版本更新记录格式，如下表所示。
表1_2版本更新记录
版本号
创建者
创建日期
维护者
维护日期
维护纪要
V1.0
刘皛，
2018.8.19
子系统清单，功能模块清单，模块功能分配，数据库表名清单，数据库表详细清单，视图设计，ER图<
教室、研究所）
陈鹤飞
子系统清单，功能模块清单，数据库表名清单，数据库表详细清单，ER图<
教师）
高建新
命名规则，子系统清单，功能模块清单，模块功能分配，数据库表名清单，数据库表详细清单，视图设计，ER图<
班级、整合），总体结构设计，运行环境设计
薄婧琛
概要设计目的，院、系部分的E_R图、数据库表名清单、数据库表的详细清单、视图设计
包阿如那
学生）
王静
E_R图<
课程）、课程子系统清单、课程功能模块清单、课程专用模块功能分配、课程信息表
宋云飞
ER图<
宿舍）
2018-8-20
2.4功能模块清单的整理
3.2公用模块功能分配
3.1专用模块功能分配
3.5课程信息表的修改
包阿如娜
2018.8.20
ER图修改<
学生）、功能模块清单<
学生）、模块功能分配<
学生）、学生成绩信息表部分分修改
教师）、功能模块清单<
教师）、模块功能分配<
教师）、教师信息表部分修改
刘皛
教室、研究所）、功能模块清单<
教室、研究所）、模块功能分配<
教室、研究所）、教室、研究所信息表部分修改，数据库表名清单修改
宿舍）、功能模块清单<
宿舍）、模块功能分配<
宿舍）、宿舍信息表部分分修改
学院、系）、功能模块清单<
学院、系）、模块功能分配<
学院、系）、学院、系信息表部分分修改
班级）、功能模块清单<
班级）、模块功能分配<
班级）、班级信息表部分分修改
2018．8.22
命名规则、模块功能分配修改（学生>
功能模块分配修改<
课程）、专用功能模块修改<
课程）、
专用模块院系部分修改，数据库表明清单及数据库表院系部分修改
专用模块班级部分修改，数据库表明清单及数据库表班级部分修改
数据库表明清单补充、数据库表详细清单补充
教师）、专用功能模块修改<
教师）、ER图修改
宿舍）、专用功能模块修改<
宿舍）、
2018-8-23
3-1-4课程功能模块分配修改
2018.8.23
专用功能模块院系部分修改
功能模块<
教师）修改，er图修改
数据库表名清单修改、数据库表详细清单修改、教室、研究所专用模块、公用模块修改
功能模块清单修改、整合，数据库表名清单修改整合、数据库表的详细设计修改整合
功能模块清单修改<
宿舍）、数据库表详细清单修改<
素和）
第2章总体设计
2.1总体结构设计
软件系统的总体逻辑结构，按照不同的设计方法，有不同的总体逻辑结构。
本指南以结构化设计方法为主，画出系统总体结构图，列出系统的功能模块清单编号、名称、功能，并尽可能描绘出功能模块之间的关系。
若用面向对象的Rose工具进行分析和设计，则遵照Rose的要求进行。
总体结构示意图，如图所示。
图2_1总体结构示意图
2.2运行环境设计
该软件系统的运行环境
硬件平台：
（1）服务器的最低配置要求
单路四核机架式服务器,处理器：
XeonX3220。
内存：
4GDDR2。
硬盘：
SATA2500G。
机构：
1U机架式
（2）工作站的最低配置要求
塔式。
CPU类型:
XeonE5504。
CPU频率:
2000MHz。
处理器描:
标配1个XeonE5504处理器。
内存:
4GDDR3REGECC。
硬盘:
制程工艺:
45纳M。
CPU核心:
四核<
Gainestown）。
主板芯片:
Intel5500；
FSB总线:
800MHz
（3）外设的要求
一般的键盘、鼠标、喷墨打印机
软件平台：
（1）服务器操作系统
Windows操作系统
（2）数据库管理系统
MysqL数据库
（3）中间件
无
（4）客户端操作系统
（5）客户端的平台软件
浏览器IE6以上
网络平台：
（6）通信协议
Tcp/Ip协议
（7）通信带宽
10M/s
2.3子系统清单
子系统清单，如表所示。
表2_1子系统清单
子系统编号
子系统英文名
子系统功能简述
子系统之间的关系
SS1
Classroommanagesubsystem
<
教室管理子系统）
教室基本信息的添加、教室信息的查询、教室信息的修改与删除、教室上课安排、教室设备设施信息、教室管理人员信息
学生子系统<
学生使用教室）
课程子系统<
教室内课程安排）
SS2
Institutemanagesubsystem
研究所管理子系统）
研究所基本信息的添加、研究所信息的查询、研究所信息的修改与删除
学院子系统<
从属关系）
教师子系统<
由老师进行工程研究）
SS3
Collegemanagesubsystem
学院管理子系统）
学院基本信息的查询、添加、修改和删除以及学院对系、教师和研究所的管理
研究所管理子系统<
学院管理研究所）教师管理子系统<
管理教师）系管理子系统<
学院管理系）
SS4
Departmentmanagesubsystem
系管理子系统）
系基本信息的查询、添加、修改和删除以及对课程的安排和班级的管理
学院管理子系统<
被学院管理）班级管理子系统<
系包含班级）课程管理子系统<
系安排课程）
SS5
Dormitorymanagesubsystem
宿舍管理子系统）
管理宿舍的基本信息，管理宿舍物品的基本信息
相对独立
SS6
Classmanagesubsystem
班级管理子系统）
班级基本信息的添加、班级信息的查询、班级信息的修改与删除
所属于系子系统
SS7
Teachermanagesubsystem
教师管理子系统）
对教师信息的基本操作和先关信息的存储
SS8
Studentmanagesubsystem
（学生管理系统>
学生信息管理，包括学生基本信息、成绩信息、诚信信息、综合测评信息的添加、修改、删除、查询
SS9
Coursemanagementsubsystem
课程管理子系统）
课程管理：
课程信息的录入、添加、修改、删除；
学生选课管理
与学生管理子系统产生选课表，与管理员产生排课表
2.4功能模块清单
功能模块清单，如表所示
表2-2功能模块清单<
学生信息管理子系统）
模块编号
模块英文名
模块功能简述
模块的接口简述
M1-1
SearchStudBasiInfo
查看学生基本信息、成绩、诚信信息、综合测评信息
输入：
学生学号
输出：
学生基本信息、成绩信息、综合测评信息
M1-2
AddStudBasiInfo
添加学生基本信息
学号及该生所有基本信息
学生基本信息列表
M1-3
AddStudCourInfo
添加学生课程信息
学号
添加后的学生课程信息、课表
M1-4
AddStudScorInfo
添加学生成绩信息
添加后的学生成绩信息
M1-6
UpdateStudBasiInfo1
修改学生姓名、出生年月、性别、民族、籍贯
显示修改后的信息
M1-7
UpdateStudBasiInfo2
修改学生家庭住址、电话、移动电话、电子邮箱
M1-8
UpdateStudBasiInfo3
修改学生院系、专业、班级
显示修改后的内容
M1-9
UpdateStudBasiInfo4
修改学生办学形式、入学时间
M1-10
UpdateStudBasiInfo5
修改学生政治面貌英语水平、计算机水平
M1-11
UpdateStudBasiInfo6
修改学生毕业时间
M1-12
UpdateStudScorInfo
修改学生成绩
表2-2-2班级管理子系统功能模块清单
M2-1
AddClasBasiInfo
添加班级信息
班级信息
班级基本信息
M2-2
UpdateClasBasiInfo
修改班级信息
班级名称对相应内容进行修改
M2-3
DeleteClasBasiInfo
删除班级信息
班级名称对相应内容进行删除
M2-4
SearchClasBasiInfo
查询班级信息
班级名称
表2-2-3住宿管理子系统功能模块清单
M3-1
SearchDormBasiInfo
查询住宿信息
学号、宿舍号、楼号、工作人员编号
与之对应相关关信息
M3-2
UpdateDormBasiInfo
修改住宿信息
修改的各方面信息
M3-3
AddDormBasiInfo
添加住宿信息
M3-4
DeleteDormBasicInfo
删除住宿信息
表2-2-4课程管理子系统功能模块清单
M4-1
AddCourBasicInfo
添加课程基本信息
输入:
课程编号，课程名，学时，学分，任课教师，开设学院，教材，类别
录入成功
M4-2
DeleteCourBasiInfo
删除课程信息
课程编号或者课程名
选择需删除的课程信息的工程
M4-3
UpdateCourBasicInfo
修改课程信息
选择需修改的课程信息的工程
M4-4
SearchCourBasicInfo
查看课程信息
所有的课程信息或者选择要看的信息
M4-5
SelectCour
选择学生需修课程
所选择课程的信息
表2-2-5教师管理子系统功能模块清单
M5-1
AddTeacBasicInfo
增加教师信息
教师的编号，基本信息。
输出:
信息存储成功或失败
M5-2
DeleteTeacBasiInfo
删除教师信息
教师编号:
教师信息删除成功或失败
M5-3
UpdateTeacBasiInfo
修改教师信息
教师编号；
输出要修改的信息修改内容
M5-4
SearchTeacBasiInfo
查询教师信息
教师编号：
教师信息
表2-2-6研究所管理子系统功能模块清单
M6-1
AddInstBasiInfo
添加研究所基本信息
研究所名称或编号进行相应信息添加
研究所基本信息
M6-2
SearchInstBacsInfo
查询研究所信息
研究所名称或编号
M6-3
UpdateInstBacsInfo
修改研究所信息
研究所名称或编号进行相应信息修改
M6-4
DeleteInstBacsInfo
删除研究所信息
研究所名称或编号进行相应信息删除
表2-2-7教室管理子系统功能模块清单
M7-1
AddClroBasiInfo
添加教室信息
教室信息
教室基本信息、教室编号
M7-2
UpdateClroBasiInfo
修改教室信息
教室编号对相应内容进行修改
教室基本信息
M7-3
DeleteClroBasinfo
删除教室信息
教室编号对相应内容进行删除
M7-4
SearchClroBasiInfo
查询教室信息
教室编号
M7-5
ArrangementClroCour
安排教室课程
教室课程安排
表2-2-8系管理子系统功能模块清单
M8-1
SearchDepaBasiInfo
查询系基本信息
可以查询系编号、系名称、系主任、教授人数、副教授人数、讲师人数、助教人数、系简介以及班级数
M8-2
AddDepaBasiInfo
添加系基本信息
可以添加系编号、系名称、系主任、教授人数、副教授人数、讲师人数、助教人数、系简介以及班级数
M8-3
DeleteDepaBasiInfo
删除系基本信息
可以删除系编号、系名称、系主任、教授人数、副教授人数、讲师人数、助教人数、系简介以及班级数
M8-4
升级会员 