院系新生报到管理系统概要详细设计说明书.docx
《院系新生报到管理系统概要详细设计说明书.docx》由会员分享,可在线阅读,更多相关《院系新生报到管理系统概要详细设计说明书.docx(28页珍藏版)》请在冰豆网上搜索。
院系新生报到管理系统概要详细设计说明书
本页仅作为文档封面,使用时可以删除Thisdocumentisforreferenceonly-rar21year.March
院系新生报到管理系统概要详细设计说明书(总23页)
专业:
软件工程
姓名:
何圣平
学号:
20
班级:
网络工程一班
在班序号:
05
新生报到管理系统
概要详细设计说明书
本报告说明确定软件系统的总体结构、数据结构、及其它全局性的考虑,所设计的系统应覆盖既定的软件需求,经过评审通过后,本说明是后续实现的根据。
本报告由以下表格组成:
概要设计说明书目录
文档序号
1.引言
S1.
2.总体设计
S2.
.需求规定
.
.运行环境
.
.基本设计概念和处理流程
.
.概要设计模块结构图与描述表
.
3.接口设计
S3.
4.运行设计
S4.
5.系统数据结构设计
S5.
6.系统出错处理设计
S6.
7.程序系统结果图
S7
8.程序设计说明
S8
本说明书由设计人员根据软件需求说明书制定,由主程序员和程序员实施,供测试人员及维护人员参考。
系统分析员:
_______________________
(签名)
日期:
2013年12月17日
主文档名称
概要设计说明书
主文档编号
S
子文档名称
1.引言
子文档序号
S1.
编者
何圣平
编写日期
2013年12月17日
1)编写目的
在系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对系统的需求做了详细的阐述,这些用户需求已经在上一阶段的调研中获得,并在需求规定说明书中得到详尽的叙述与阐明。
本阶段在系统的需求分析基础上,对系统做概要设计。
主要解决实现该系统需求的程序模块设计问题,包括如何把该系统划分成若干模块、决定各模块之间的接口、模块间传递的消息,以及数据结构,模块结构的设计等。
在一下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。
在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在对系统所做的模块结构设计的基础上,对系统进行详细设计。
在以后的软件测试已经软件维护阶段也可以参照此说明书,以便了解在概要设计过程中所完成的各模块设计结构,或者修改时找出在本阶段设计的不足与错误。
(2)项目背景
开发软件名称:
新生报到管理系统
项目任务提出者:
某高校
项目开发者:
某计算机学院
用户:
某高校
(3)符合、缩略语和定义
FRMS:
新生报道管理系统
B/S:
Brower/Server浏览器/服务器
(4)参考资料
《新生报道管理系统可行性分析报告》.编
《新生报道管理系统需求分析报告》.编
《新生报道管理系统委托开发合同》.顺旭软件公司
《软件工程导论》.张海藩.清华大学出版社
《实用软件工程》.郑人杰等.清华大学出版社.
《软件文档写作》。
潘孝铭辛明海.高等教育出版社
主文档名称
概要设计说明书
主文档编号
S
子文档名称
2.总体设计
子文档序号
S2.
编者
何圣平
编写日期
2013年12月17日
主文档名称
概要设计说明书
主文档编号
S
子文档名称
.需求规定
子文档序号
.
编者
何圣平
编写日期
2013年12月17日
(1)性能
相应时间:
每笔事务处理响应时间少于3~5s(不含统计分析,报表生成类的输出);当数据录入操作时应无等待时间。
数据可靠性:
在应用系统投入运行的5年生命周期内数据不得丢失;一旦数据转为历史记录后任何人不得更改。
(2)程序正确性
应用系统试用期结束后,程序运行过程中不允许出现程序逻辑算法错误。
程序系统在运行过程中,由于操作错误或者输入/输出数据溢出时,不应该死机而应提示故障原因,然后以正常出口退出当前操作环境。
(3)系统安全
非授权用户不得进入程序系统。
无修改权限的用户不得修改数据,更新以及执行处理操作。
主文档名称
概要设计说明书
主文档编号
S
子文档名称
.运行环境
子文档序号
.
编者
何圣平
编写日期
2013年12月17日
硬件环境
PII或更高档微机
运行内存要求:
10MB
安装所需硬盘:
100M
打印机:
选择经济使用的即可
软件环境
服务器端:
Windowssever2003企业版
客户端:
任何安装了浏览器的pc机
数据库:
SQLserver2005
开发工具:
visualstudio.NET2005,Dreamweavercs3
主文档名称
概要设计说明书
主文档编号
S
子文档名称
.基本设计概念和处理流程
子文档序号
.
编者
何圣平
编写日期
2013年12月17日
1.学生信息的增、删、改、查功能:
逻辑处理思路:
主文档名称
概要设计说明书
主文档编号
S
子文档名称
.概要设计模块结构图与描述表
子文档序号
.
编者
何圣平
编写日期
2013年12月17日
(1)、用户信息验证模块
用户信息验证系统模块结构图
模块描述表:
模块名称
信息判断1
模块代码
启动条件
用户打开系统运行
输入
功能
输出
1、学生登陆名
2、登陆密码
在该模块中系统对学生所输入的用户名和密码进行验证
1、登陆成功
2、密码或用户名错误
模块名称
信息判断2
模块代码
启动条件
用户打开系统运行
输入
功能
输出
1、工作人员登录名
2、登陆密码
在该模块中系统对学生所输入的用户名和密码进行验证
1、登陆成功
2、密码或用户名错误
功能需求--模块关系表:
学生用户
工作人员
登陆权限
√
√
查询功能
√
√
录入功能
√
更新功能
√
(2)、新生信息录入模块
模块结构图:
新生信息录入模块结构图
模块描述表:
模块名称
新生姓名
模块代码
启动条件
用户输入新生姓名
输入
功能
输出
用户输入新生姓名
该模块将用户输入的新生姓名保存到新生数据库中
无
模块名称
学费缴纳
模块代码
启动条件
用户点击录入学费缴纳情况
输入
功能
输出
用户选择新生学费缴纳情况
该模块将用户选择的新生学费缴纳情况保存到新生数据库中
无
模块名称
档案缴纳
模块代码
启动条件
用户点击录入档案缴纳情况
输入
功能
输出
用户选择新生档案缴纳情况
该模块将用户选择的档案缴纳保存到新生数据库中
无
模块名称
组织关系
模块代码
启动条件
用户点击录入新生组织关系
输入
功能
输出
用户选择新生组织关系
该模块将用户选择的新生组织关系保存到新生数据库中
无
模块名称
宿舍分配
模块代码
启动条件
用户点击录入宿舍分配情况
输入
功能
输出
用户选择新生宿舍分配
该模块将用户选择的新生宿舍情况保存到新生数据库中
无
(3)、新生信息查询
模块描述表:
模块名称
查询新生姓名
模块代码
启动条件
输入
功能
输出
所要查询新生的姓名
在该模块中用户可输入所要查询新生的姓名
无
模块名称
新生姓名判断
模块代码
启动条件
输入新生姓名,ENTER键
输入
功能
输出
新生姓名
将所输入的内容与信息库中的内容进行比对
验证成功/验证失败
模块名称
显示新生所有信息
模块代码
启动条件
姓名验证成功
输入
功能
输出
无
调用信息库中的信息给予显示
所查询新生的所有信息
(4)、新生信息更改
模块描述表:
模块名称
更改新生姓名
模块代码
启动条件
输入
功能
输出
所要更改新生的姓名
在该模块中用户可输入所要查询新生的姓名
无
模块名称
新生姓名判断
模块代码
启动条件
输入新生姓名,ENTER键
输入
功能
输出
新生姓名
将所输入的内容与信息库中的内容进行比对
验证成功/验证失败
模块名称
信息更新
模块代码
启动条件
姓名验证成功
输入
功能
输出
更新信息类型
用户选择更新什么信息
无
模块名称
宿舍分配更新
模块代码
启动条件
用户选择该操作
输入
功能
输出
宿舍分配信息
更新原有宿舍分配信息
无
模块名称
学费缴纳更新
模块代码
启动条件
用户选择该操作
输入
功能
输出
学费缴纳信息
更新原有学费缴纳信息
无
模块名称
档案缴纳更新
模块代码
启动条件
用户选择该操作
输入
功能
输出
档案缴纳信息
更新原有档案缴纳信息
无
模块名称
组织关系更新
模块代码
启动条件
用户选择该操作
输入
功能
输出
组织关系信息
更新原有组织关系信息
无
模块名称
信息删除
模块代码
启动条件
姓名验证成功
输入
功能
输出
无
删除该新生所有信息
无
主文档名称
概要设计说明书
主文档编号
S
子文档名称
3.接口设计
子文档序号
S3.
编者
何圣平
编写日期
2013年12月17日
(1)外部接口
用户界面,采用非常流行的web图形用户界面。
软件接口,客户端运行于任何安装有浏览器的pc机上,
服务器端,需要sqlserver2005与.NETFreamwork支持。
硬件接口:
支持一般的x86系列微机。
(2)内部接口
由浏览器输入网址,进入系统登陆模块。
退出系统模块,执行完毕返回操作系统。
系统菜单模块,由登陆模块调用,接收系统功能相应消息,启动宿舍管理、报到管理、缴费管理、报表等模块。
宿舍管理模块,由系统菜单模块调用,执行宿舍查询、宿舍分配等功能。
报到管理模块,由系统菜单模块调用,执行档案收取登记,组织关系收取登记等功能
缴费管理模块,由系统菜单模块调用,执行缴费查询,缴费登记等功能
报表模块,由系统菜单模块调用,执行新生宿舍报表,缴费报表,组织关系报表,档案报表等功能。
主文档名称
概要设计说明书
主文档编号
S
子文档名称
4.运行设计
子文档序号
S4.
编者
何圣平
编写日期
2013年12月17日
(1)运行模块的组合
客户机程序在有输入时启动接收数据模块,通过各模块之间的调用,读入并对输入进行格式化。
在接收数据模块得到充分的数据时,将调用网络传输模块,将数据通过网络送到服务器,并等待接收服务器返回的信息。
接收到返回信息后随即调用数据输出模块,对信息进行处理,产生相应的输出。
服务器程序的接收网络数据模块必须始终处于活动状态。
接收到数据后,调用数据处理、查询模块对数据库进行访问,完成后调用网络发送模块,将信息返回客户机。
(2)运行控制
运行控制将严格安装各模块间函数调用关系来实现。
在网络方面,客户机在发送数据后,等待服务器的确认收到信号,收到后,再次等待服务器发送回到数据,然后对数据进行确认。
服务器在接收到发送信号,在对数据处理、访问数据库后,将返回信息送回客户机,并等待确认。
(1)运行时间
在软件需求分析中,对运行时间的要求为必须对作出的操作有较快的反应。
网络硬件对运行时间有最大的影响,当网络负载量大时,操作反应将受到很大的影响。
所以采用宽带网络,实现客户机与服务器间的连接,以减少网络传输上的开销。
其次是服务器的性能,这将影响数据库访问时间即操作时间的长短,加大客户机操作的等待时间,所以必须使用高性能的服务器。
主文档名称
概要设计说明书
主文档编号
S
子文档名称
5.系统数据结构设计
子文档序号
S5.
编者
何圣平
编写日期
2013年12月17日
数据结构图:
数据结构描述表为:
结构名称
新生信息表
结构类型
记录
数据项组成
序号
名称
标识符
类型
长度
备注
1
新生姓名
Name
char
6
2
学号
Number
char
18
结构名称
宿舍分配表
结构类型
记录
数据项组成
序号
名称
标识符
类型
长度
备注
1
宿舍分配情况
Sus
char
6
结构名称
组织关系表表
结构类型
记录
数据项组成
序号
名称
标识符
类型
长度
备注
1
组织关系情况
Zuz
char
6
结构名称
学费缴纳表
结构类型
记录
数据项组成
序号
名称
标识符
类型
长度
备注
1
学费缴纳情况
Xuef
char
6
结构名称
档案缴纳表
结构类型
记录
数据项组成
序号
名称
标识符
类型
长度
备注
1
档案缴纳情况
Dangan
char
6
主文档名称
概要设计说明书
主文档编号
S
子文档名称
6.系统出错处理设计
子文档序号
S6.
编者
何圣平
编写日期
2013年12月17日
(1)出错处理设计
A、出错输出信息,程序在运行时,主要会出现两种错误:
1.由于输入信息无法满足要求时产生的错误,称为软错误。
2.由于其它问题,如,网络传输超时等产生的问题,称为硬错误。
对于软错误,须在操作成功判断模块及输入数据验证模块进行数据分析,判断错误类型,在生成相应的错误提示语句,送到输出模块中。
对于硬件错误,可在出错的相应模块中输出简单的出错语句,并将程序重置,返回出入阶段。
出错信息必须给出相应的出错原因。
B、出错出理对策。
所有的客户机及服务器都必须安装不间断电源以防止停电或电压不
稳定造成数据丢失的损失。
若诊断电时,客户机上将不会有太大的影响,服务器断电后的恢复过程可采用SQLSERVER2000的日志文件,对其进行回滚处理,对数据进行恢复。
在网络传输方面,可考虑建立一条成本较低的后备网络,以保证当网络断路时数据的通信。
在硬件方面要选择较可靠、稳定的服务器机种,保证系统运行时的可靠性。
(1)安全保密设计
在用户登录系统时进行身份验证,只允许合法用户进入系统。
(2)维护设计
维护方面主要为服务器上的数据库数据进行维护立刻使用SQLSERVER2000的数据库维护功能机制。
必须按照软件铲平设计规范的步骤进行开发,并充分考虑软件可维护性,详细编写个阶段的文档资料。
主文档名称
详细设计说明书
主文档编号
S
子文档名称
7.程序系统结果图
子文档序号
S7.
编者
何圣平
编写日期
2013年12月17日
程序模块名称
标识符
程序设计说明编号
实现文档编号
01登陆
User_LogeIn
02注册
User_register
03床位分配
User_chuangwei
04学生信息录入
User_add
05学生信息查询
User_check
06学生信息修改
User_update
06生成报表
User_print
系统登陆:
功能说明:
用户输入网址,来到登陆界面,输入用户名与密码进行
登陆。
用户名与密码有误时提醒用户重新输入,并清除用户的错误输
入数据,如果用户按取消,说明用户自己意识到输入有误,故系统也
要实现清空用户名与密码栏。
登陆的界面下图
(2)注册
功能说明
如果用户想进行系统,侧必须先登录。
如过用户还没有该系统的用户好。
则需要先注册,注册后用户要记得自己的用户名和密码,以便以后可以登录该系统。
用户界面如下图
(3)学生信息录入
功能说明:
当有新生报到时,点击‘报到管理’按钮,系统将进入报到
管理界面,工作人员输入学生报到的录取通知书号,点击查询按钮,
系统显示该学生的基本信息,并提供辅导员,班级等信息,方便帮助
学生找到老师与班级。
这个界面适合几个部门共同使用,档案收取的
部门进入该界面后,输入学生通知书号,在‘报到管理’栏的“高
中档案缴纳”处点击单选框‘是’,登记学生已经缴纳档案,同理,
组织关系处也采用类似操作,在组织关系缴纳后面勾选‘是’。
界面如下图
(4)学生信息查询
用户可以查看自己的信息,操作如下,首先用户需要登入,进入学生信息查询模块
输入该用户的学好,点击确定后,将会显示该学生的详细信息
界面如下图
主文档名称
详细设计说明书
主文档编号
S
子文档名称
3.程序设计说明
子文档序号
S8
编者
何圣平
编写日期
2013年12月17日
(1)程序的架构
本系统后台采用三层架构。
用MVC设计模式。
即采用展现层,控制层,实体层分开,展现层我们采用jsp,
(2)命名规则
1,包名:
我们全部用系统action处理
系统实体类
系统业务处理接口
系统数据处理接口
系统数据处理实现
系统业务处理实现
系统处理网络包
系统工具包
2.类名:
取名要和其功能对应。
要做到见名知其意思,首先第一个字母要大写,如果有是两个或是多个单词构成的类名则每个单词的第一字母要大写中间不能有空格;
例如:
User
UserLoginAction
等等
(2)接口:
1.业务逻辑接口
Publicvoidadd(Useruser);
Publicvoiddelete(intnuber);
PublicUsergetUser(intnumber);
Publicbooleanupdate(intnumber)
PublicListgetUsers();
2.数据处理层接口
Publicvoidcheck(Useruser);
Publicvoidsave(Useruser);
Publicvoiddelete(Useruser);
PublicUsergetUser(intnumber);
PublicUserupdate(Useruser);
PublicListgetUsers();
(3)页面的展现
我们采用css和javascript技术