软件工程团队作业--详细设计说明书

软件工程团队作业--详细设计说明书

队伍名称：洗衣做饭带孩子队
队长：郑欣 https://www.cnblogs.com/Cloria10086/
队员：魏思梦https://www.cnblogs.com/MiniDream/
          邓好https://www.cnblogs.com/DengHao-123/
          王艳静https://www.cnblogs.com/wangyanjing/
文本编辑者：全体组员

详细设计说明书

11引言

1.1编写目的

高校调查问卷管理系统的开发目的在于便于各高校甚至其他级别学校做各种问卷调查、投票以及这些问卷的填写信息、分析数据的管理，提供这样的平台既利于管理又利于信息的保护。本需求的编写目的在于研究高校调查问卷管理系统的开发途径和应对方法，为以后的开发工作提供可靠的依据；明确项目项目需求范围，实现需求描述的规格化、可跟踪性、可度量性和可测试性。在项目实施和项目交付验收过程中，均以该文档为唯一依据。该文档用于描述具体的系统设计方案细节，同时该文档也作为指导开发人员、测试人员进行系统开发以及测试的依据。

1.2适用范围

适用业务范围：

1.新产品研发项目
2.新业务开发型项目
3.产品升级项目
4.产品维护项

适用人员范围：

1.开发人员：负责该问卷调查管理系统开发的相关人员
2.测试人员：负责对该系统进行测试的相关人员
3.维护人员：负责对该系统后期进行修复和维护的相关人员

1.3参考资料

[1]明日科技，android开发从入门到精通.清华大学出版社，2017
[2]陈禹等，软件开发工具.北京：机械工业出版社，2014
[3]齐治昌等，软件工程（第4版）.高等教育出版社，2019
[4]王立福，软件工程.北京：机械工业出版社，2011
[5]Leszek A.Maciaszek,需求分析与系统设计.机械工业出版社，2019

2综合描述

2.1系统目标

本系统软件是高校调查问卷管理系统，该软件面向所有高校师生，甚至中小学，为其提供了更方便、简洁、安全且有趣的平台。方便用户在不同领域创建、填写问卷以及对问卷结果进行数据分析，便于达成调查目的、数据存储目的，利于后续工作的进行。

2.2系统概述

本系统名为高校问卷调查管理系统，服务于各大高校，是用于管理问卷调查从而获得学生和教师对其学校、专业、教学情况、教学资源配套、学校管理水平等的多方面评价，进而提高政府教育的针对性与有效性。
本系统的总体业务需求主要为：
1.系统能够设计出各种满足用户需求的问卷。
2.系统能够导入待问卷人员的相关信息。
3.系统能够以分享链接等方式发布问卷。
4.系统能够接收到待问卷者的问卷信息并加入系统对应的数据库中。
5.系统能够统计和分析用户所提交的数据、并且将统计结果以图表形式展示给用户。
本系统的主要功能需求为：
1.设计问卷：问卷发布者设计问卷问题等内容。
2.发布问卷：通过分享链接方式发布问卷。
3.提交问卷：待问卷者回答问卷问题并且保存。
统计并分析问卷：发布问卷者查看系统所展示的统计信

2.3运行环境

表1 开发与运行环境说明

类别	标准配置	最低配置
开发环境	Windows 10	Windows 7
	4G硬盘容量+256MB内存	4G硬盘容量+256MB内存
测试环境	Windows 10	Windows 7
	64硬盘容量+4G内存	64硬盘容量+4G内存
运行环境	MicrosoftVisualStudio	Code：：Blocks
	MicrosoftVisualC++	MicrosoftVisualC++
	Windows 10	Windows 7

2.4程序结构说明

下面是系统文件夹结构说明：

表2 系统文件夹结构

名称	备注（作用或意义）
根目录	前台程序文件
Admin	后台程序文件
Admin/help	功能的帮助文件
Admin/includes	后台公用文件和函数
Includes	前台公用文件和函数
Mobile	系统自带手机版程序
Mobile/templates	手机版模板文件
Temp	存放临时缓存文件
Wap	手机浏览程序
Wap/templates	页面模板

下面是前台程序文件说明：

表3 前台程序文件说明

名称	备注（作用或意义）
Api.jsp Api	统一接口文件
Comment.jsp	提交用户评论
Flow.jsp	问卷填写流程
Index.jsp	首页文件
Respond.jsp	提交响应界面
Search.jsp	搜索页面
User,jsp	用户个人主页
Includes/cls_sql_executor.jsp	sql语句执行类
Includes/cls_smtp.jsp	smtp邮件类
Includes/lib.debug.jsp	调试
Includes/lib_base.jsp	基础函数库
Includes/lib_code.jsp	加密解密类
Includes/lib_common.jsp	公用函数库
Includes/lib_indert.jsp	动态内容函数库
Includes/cls_sms.jsp	短信模块的模型
Includes/cls_captcha.jsp	验证码图片
Includes/cls_error.jsp	用户低级错误处理类
Includes/cls_image,jsp	后台对上传文件的处理类
Js/calendar.js	调用日历js
Js/commmon.js	公共函数js
Js/global.js	金局js
Js/index.js	首页js
Js/left_time.js	剩余时间js
Js/region.js	城市js
Js/university.js	大学js
Js/writting_flow.js	填写流程js
Js/showdiv.js	创建显示层js
Js/user.js	会员信息js

下面是后台程序文件说明：

表4 后台程序文件说明

名称	备注（作用或意义
Admin/account_log.java	账户变动记录
Admin/ads.java	广告管理程序
Admin/agency.java	办事处管理
Admin/ads.java	广告管理程序
Admin/attention_list.java	关注管理
Admin/attribute.java	属性规格管理
Admin/catagory.java	问卷分类管理程序
Admin/cloud.java	云服务接口
Admin/convert.java	转换程序
Admin/cron.java	计划任务
Admin/database.java	数据库管理
Admin/email_list.java	邮件列表管理
Admin/filecheck.java	文件校验
Admin/friend_link.java	友情链接管理
Admin/get_password.java	找回管理原密码
Admin/help.java	帮助信息接口
Admin/index.java	控制台首页
Admin/licence.java	程序说明
Admin/message.java	管理员留言程序
Admin/navigator.java	自定义导航栏管理
Admin/picture_batch.java	图片批量处理程序
Admin/privilege.java	管理员信息及权限管理
Admin/question_type.java	问题类型管理
Admin/questionnaires.java	问卷管理
Admin/questionnaires_batch.java	问卷批量管理
Admin/questionnaires_export.java	问卷数据导出
Admin/questionnaires_import.java	问卷模板导入
Admin/role.java	角色管理信息
Admin/search_log.java	查询记录
Admin/sms.java	短信模块
Admin/template.java	模块管理程序
Admin/users.java	用户管理
Admin/includes/inc_menu.java	管理中心菜单
Admin/includes/inc_priv.java	权限对照

下面是数据库表汇总：
表5 数据库表汇总

名称	备注（作用或意义）
Primary_administractor	一级管理员信息的数据表
secondary_administractor	二级管理员信息的数据表
questionare	问卷的数据表
filler	问卷填写者的数据表
question	问题信息的数据表
Mutiple_choice_item	选择题信息的数据表
Relation_design	关系设计表
Relation_include	关系包含表

下面是初始化文件整合：

表6 初始化文件整合

名称	备注（作用或意义）
Configuration.ini	布局配置文件
Questionaire.ini	系统的金局配置文件

下面是多媒体资源文件：

表7 多媒体资源文件

名称	备注（作用或意义）
Logo.jpg	系统图标文件
User_guide.mp4	用户指南视频

3系统详细设计

3.1设计问卷模块详细设计

3.1.1模块职责与功能描述

1.职责:
设计人员在登录界面输入用户名和密码登录，系统判定用户身份后跳转到设计问卷界面，创建问卷后输入问题点击保存来完成新问卷的创建。或点击已有问卷进行更改问题，点击保存后问卷数据会传送到数据库中，并根据需求发布问卷，同时返回“发布成功”字样，用户点击跳转回设计界面，点击退出登录退出系统，结束。
2.功能：
为用户提供问卷设计界面以便于用户的问卷设计操作。通过get_name()，get_password()等调用方法，实现系统的登录功能，包括用户输入用户名和密码登录和用户身份的判断（教师，学生，管理人员，设计人员等）。通过userID用户界面接口，实现显示用户需求界面，包括登录界面、用户身份信息界面、返回信息提示界面（登录成功/登录失败）。

3.1.2模块交互模型

图1 模块一交互模型

3.1.3模块设计类图

图2 模块一设计类图

3.1.4设计类说明

表8 设计类说明一

类名	设计问卷	所属包	c
继承	null
实现	null

属性
名称	类型	默认值	Pub/Prv/Pro
name	string	###	Prv
phonenumber	int	12345	Prv
email	string	###	Prv
id	string	###	Prv
password	string	###	Prv

方法
名称	参数	返回值	异常	描述
get_name()	null	string	0	null
get_phonenumber()	null	int	0	null
get_email()	null	string	0	null
get_id()	null	string	0	null
get_password()	null	string	0	null

事件
名称	条件	参数	目的
id	int	null	null
password	11位	null	null

3.2 填写问卷模块详细设计

3.2.1模块职责与功能描述

1.职责:
问卷填写人员在登录界面输入用户名和密码登录，系统判定用户身份后跳转到填写问卷界面，填写问卷回答后点击保存后问卷数据会传送到数据库中，同时返回“保存成功”字样，用户点击跳转回个人信息界面，点击退出登录退出系统，结束。
2.功能：
该模块主要功能是针对问卷填写人员，使填写人员实现查看问卷内容，填写问卷信息，提交问卷答案的功能。

3.2.2 模块交互模型

图3 模块二交互模型

3.2.3 模块设计类图

图4 模块二设计类图

3.2.4设计类说明

表9 设计类说明二

类名	填写问卷	所属包	c
继承	null
实现	null

属性
名称	类型	默认值	Pub/Prv/Pro
name	string	###	Prv
phonenumber	int	12345123456	Prv
email	string	###	Prv
university	string ###	Prv
grade	int	123	Prv
sex	string	###	Prv

方法
名称	参数	返回值	异常	描述
get_name()	null	string	0	null
get_phonenumber()	null	int	0	null
get_email()	null	string	0	null
get_university()	null	string	0	null
get_grade()	null	int	0	null
get_sex()	null	string	0	null

事件
名称	条件	参数	目的
university	string	null	null
grade	1/2/3/4	null	null
sex	男/女	null	null

3.3 统计问卷模块详细设计

3.3.1模块职责与功能描述

1.职责:
问卷填写人员在登录界面输入用户名和密码登录，系统判定用户身份后跳转到问卷数据统计人员界面。统计人员对填写人员填写的问卷答案进行审核，审核后导出审核成功的问卷答案，将问卷答案导出到数据库中并传到统计平台，用户点击跳转回数据统计人员界面，点击退出登录退出系统，结束。
2.功能：
该模块功能主要针对问卷统计人员，其可以掌握问卷的回答及填写人员信息，在认证统计人员身份后即可对已回答的问卷进行统计。

3.3.2 模块交互模型

图5 模块三交互模型

3.3.3 模块设计类图

图6 模块三设计类图

3.3.4设计类说明

表10 设计类说明三

类名	统计问卷	所属包	c
继承	null
实现	null

属性
名称	类型	默认值	Pub/Prv/Pro
level	string	null	Prv

方法|
---|---|---|---|---
名称 |参数 |返回值 |异常 |描述
get_level() |null |string| 0| null
set_level() |level |null |0 |null

事件
名称	条件	参数	目的
analysis	问卷信息存在	result,QuesList	分析问卷填写信息
Resultsgragh	问卷分析成功	size,quesData,colour	展示问卷分析结果

3.4 模块4详细设计

3.4.1模块职责与功能描述

1.职责:
问卷管理人员在登录界面输入用户名和密码登录，系统判定用户身份后跳转到问卷系统管理界面。管理人员通过查找找到待修改的问卷，若需要进行问题的修改，则通过查找到待修改问题来进行问题的题面修改或删除该问题；若需要进行问卷的删除，则在找到问卷后直接点击删除按钮删除该问卷，操作结束后点击退出登录退出系统，结束。
2.功能:
该模块功能主要针对问卷管理人员，其可以掌握问卷的创建及修改，在认证管理员身份后即可对已创建的问卷进行修改。

3.4.2 模块交互模型

图7 模块四交互模型

3.4.3 模块设计类图

图8 模块四设计类图

3.4.4设计类说明

表11 设计类说明四

类名	修改问卷	所属包	c
继承	null
实现	null

属性
名称	类型	默认值	Pub/Prv/Pro
department	String	null	Prv

方法
名称	参数	返回值	异常	描述
get_department()	null	string	0	null
set_department()	department	null	0	null

事件
名称	条件	参数	目的
rewrite	问卷存在	QestionnaireID	对已存在问卷进行修改
delete	问卷存在	QestionnaireID	删除已存在问卷