软件工程团队作业--详细设计成果物
队伍名称:头顶凉飕飕队
队长:刘岩昆 https://www.cnblogs.com/liuyankun/
队员:章璐 https://www.cnblogs.com/zhanglu0/
刘佳迎 https://www.cnblogs.com/jiayingc/
李双双 https://www.cnblogs.com/warriorlss/
文本编辑者:刘岩昆,章璐,刘佳迎
详细设计说明书
1 引言(章璐)
1.1 编写目的
本详细设计说明书是针对高校调查问卷管理系统编写。目的是对该项目进行详细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试做准备。
本详细设计说明书的预读人群为项目负责人、项目开发人员、软件维护人员、技术管理人员,测试人员、客户(政府教育管理方面的工作人员等),以及跟该项目相关的其他竞争人员和无关人员。
1.2 适用范围
本文档的适用范围为有使用问卷管理系统需求的政府部门、社会团体、各大高校,有意图开发相关软件的软件公司或团队,有相关需求的其他人士。
1.3 参考资料
《SQL Server实用教程》(第二版)·郑阿奇著·电子工业出版社·2005
《SQL Server 2008实例教程》·何定华 崔晓军著·清华大学出版社·2012.3
《软件工程基础教程》·潘广贞 杨剑著·国防工业出版社·2013.10.1
《Python Web开发实战》·董伟明著·电子工业出版社·2016.9
《Django企业开发实战》·胡阳著·人民邮电出版社·2019.2
《Python编程:从入门到实践》·Eric Matthes 著·袁国忠译·人民邮电出版社·2016.7
2 综合描述(刘佳迎)
2.1 系统目标
本系统可以帮助政府通过发布问卷的方式获得信息,在对问卷结果进行统计并进行分析后可以通过信息的反馈,进行信息的初步筛选与分析,能够及时反应当前高校情况,为管理手段和政策方针提供依据。
本系统在达到客户的基本要求之上,开发者通过与客户进行交谈提出自己的意见,同时根据客户的需求进一步完善此系统。待系统完成后,开发者对系统的页面布局,系统使用的流畅度等方面通过测试寻找问题并进行优化。交与客户审查后再根据客户的想法进行协商,在自己的能力范围内完善系统,使客户满意。
2.2 系统概述
该系统的开发是为了帮助政府从高校老师和学生处收集其对于学校专业、教学情况、教学资源配套、学校管理水平等多方面评价的信息,通过对反馈的信息的筛选与分析,能及时反映出当前高校情况,为管理手段和政策方针提供依据,提高政府教育管理的针对性与有效性。
该系统应该具有如下功能:
1、根据调查内容和性质的不同可定义成不同的项目,在每个项目下可定义问卷。
2、设计问卷,调查问卷可进行问卷题目编辑,题型包含单选题和填空题两种类型。
3、待问卷人员导入,包括学生和教师两种角色,通过excel模板导入待问卷人员信息,学生包括 学号、姓名、所属学校、专业、班级、性别、手机号、电子邮箱。教师包括教师号、姓名、所 属院校、性别、手机号码、电子邮箱。
4、发布问卷,通过系统将问卷发布到待问卷人员,可通过短信和邮件两种方式获得问卷链接地址。
5、问卷被提交后,结果被记录。
6、系统对问卷结果进行统计并进行分析,可查看总体参与人数,答题选项比例、不同学生、不同 学校、不同年级、不同专业、不同院校级别、不同性别的答题报表或图表分析。
2.3 运行环境
本系统采用B/S架构,所有界面使用WEB界面。系统可实现5000名用户同时访问网站并不影响性能。
B/S架构:
B/S架构(Browser/Server,浏览器/服务器模式)将系统功能实现的核心部分集中到服务器上,简化了系统的开发、维护和使用。其客户端不需要安装专门的软件,只需要浏览器即可,浏览器通过Web服务器与数据库进行交互,可以在不同平台下工作。
PyCharm:
PyCharm是一种Python IDE,带有一整套可以帮助用户在使用Python语言开发时提高其效率的工具,比如调试、语法高亮、Project管理、代码跳转、智能提示、自动完成、单元测试、版本控制。此外,该IDE提供了一些高级功能,以用于支持Django框架下的专业Web开发。
MySQL数据库:
MySQL是一种开放源代码的关系型数据库管理系统(RDBMS),使用最常用的数据库管理语言--结构化查询语言(SQL)进行数据库管理。
Apache Tomcat:
Apache是普通服务器,本身只支持普通网页。不过可以通过插件支持php,还可以与Tomcat连通(单向Apache连接Tomcat,通过Apache可以访问Tomcat资源。反之不然)。Apache只支持静态网页,像php,cgi,jsp等动态网页就需要Tomcat来处理。
Tomcat是由Apache软件基金会下属的Jakarta项目开发的一个Servlet容器,按照Sun Microsystems公司提供的技术规范,实现了对Servlet和JavaServer Page(JSP)的支持,并提供了作为Web服务器的一些特有功能,如Tomcat管理和控制平台、安全域管理和Tomcat阀等。由于Tomcat本身也内含了一个HTTP服务器,它也可以被视作一个单独的Web服务器。但是,不能将 Tomcat 和 Apache Web 服务器混淆,Apache Web Server 是一个用 C 语言实现的 HTTP web server;这两个 HTTP web server 不是捆绑在一起的。Apache Tomcat 包含了一个配置管理工具,也可以通过编辑 XML 格式的配置文件来进行配置
Windows 10操作系统:
Windows 10是美国微软公司开发的跨平台、跨设备的封闭性操作系统,于2015年7月29日正式发布,是微软发布的最后一个独立Windows版本。
Windows 10操作系统在易用性和安全性方面有了极大的提升,除了针对云服务、智能移动设备、自然人机交互等新技术进行融合外,还对固态硬盘、生物识别、高分辨率屏幕等硬件进行了优化完善与支持。
2.4 程序结构说明
本系统是高校调查问卷管理系统,分为登录模块、问卷填写管理模块、问卷统计管理模块、问卷主题管理模块、问卷题目管理模块、题目选择项管理模块、系统配置管理模块。根据任务目标将总体结构图从问卷调查系统开始划分,分为用户和管理员两个部分。普通用户:注册后具有用户名、密码信息,登录系统后可以填写问卷、查看问卷统计信息,其中,问卷统计分别可以用表格和图形查看。管理员:有唯一的用户名和密码,可以创建问卷主题、题目、选项并发布问卷。其中,问卷信息管理具有增加,删除,修改和查询四个基本操作。详细情况如图2.1所示。
图2.1 系统层次图
3 系统详细设计(刘岩昆)
3.1 模块1详细设计
3.1.1 模块一职责与功能描述
在管理员详细交互模型中,管理员首先需要在登录界面登录,在确认身份正确后可进入管理员的操作界面,在操作界面内可以对问卷进行增加、修改、删除、统计、查询的操作,还可以对用户的资料进行管理。问卷设计者将设计好的问卷发给管理员进行审核,审核未通过后将继续修改、增加、删除问卷,修改完毕以后再次提交给管理员进行审核。审核通过后管理员则将最终问卷交给行政部门相关人员进行审核,未通过则继续修改,审核通过以后就可以进行发布问卷,用户填写完毕以后,管理员进行整理问卷并且查询统计问卷的结果。
管理员职责:行政机关审核、需求分析,并且写入数据库、设计问卷、发布问卷(可以加、修改、删除、统计、查询)、回收问卷、数据收集整理。
3.1.2模块一交互模型
图3.1管理员详细交互模型
3.1.3模块一设计类图
图3.2 管理员设计类图
3.1.4模块一设计类说明
表3.1 管理员
类名 |
管理员 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
发布问卷并且登录系统进行题目的查询以及整理的工作 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
账号 |
字符型 |
0000000000 |
QQ、微信 |
||||
密码 |
字符型 |
666666 |
QQ、微信 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
管理员审核 |
登录系统成功 |
xxxx |
管理员审核问卷设计者设计的问卷 |
||||
递交最终问卷 |
登录系统成功 |
xxxx |
向行政部门递交最终的问卷 |
||||
发布问卷 |
登录系统成功 |
xxxx |
发布审核后最终的问卷 |
||||
整理问卷 |
登录系统成功 |
xxxx |
用户填写问卷后整理出问卷的数据 |
||||
查询问卷 |
登录系统成功 |
xxxx |
查询问卷数据 |
||||
统计问卷结果 |
登录系统成功 |
xxxx |
对调查数据进行统计得出结果 |
表3.2问卷设计者
类名 |
问卷设计者 |
所属包 |
问卷 |
||||
继承 |
管理员 |
||||||
实现 |
能够登录系统进行题目的增删改查 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
学校 |
字符型 |
xx学校 |
QQ、微信 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
命题 |
满足用户需求 |
xxxx |
按需求对空白问卷进行命题 |
||||
添加问卷 |
满足用户需求 |
xxxx |
按需求添加一个新的空白问卷 |
||||
修改问卷 |
满足用户需求 |
xxxx |
按需求对已完成或未审核通过的问卷进行修改 |
||||
删除问卷 |
满足用户需求 |
xxxx |
按需求将添加的问卷删除 |
||||
提交审核 |
满足用户需求 |
xxxx |
将问卷提交给行政人员审核 |
表3.3行政人员
类名 |
行政人员 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
能够对已命题的问卷进行审核 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
部门 |
字符型 |
xx部门 |
QQ、微信 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
审核 |
管理员递交问卷 |
xxxx |
审核问卷内容是否符合要求 |
表3.4 用户
类名 |
用户 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
使用该系统的参与者被称为用户,包括教师和学生,拥有登录的权限 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
账号 |
字符型 |
0000000000 |
QQ、微信 |
||||
密码 |
字符型 |
666666 |
QQ、微信 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
登录系统 |
打开软件 |
xxxx |
用户输入账号和对应的密码,系统查找是否存在改用户,存在则跳到系统的首页;否则,提示用户不存在或密码错误 |
||||
填写问卷 |
登录成功 |
xxxx |
用户进行问卷填写 |
3.2 模块二详细设计
3.2.1 模块二职责与功能描述
在用户的交互模型中,用户同样需要先在登录界面登录,在确认身份正确后可进入用户的操作界面,在用户操作界面内可以选择填写问卷,查看问卷结果,相应的系统会显示出操作的结果,另外,用户还可以填写个人信息以及查看个人信息,同样的系统会显示操作结果。
用户职责:用户登录、身份信息验证、填写问卷、提交问卷、查询问卷结果、填写个人信息、查看个人信息。
3.2.2 模块二交互模型
图3.3 用户详细交互模型
3.2.3 模块二设计类图
图3.4 用户设计类图
3.2.4 模块二设计类说明
表3.5 教师
类名 |
教师 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
教师填写问卷 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
教师号 |
字符型 |
0000000000 |
xx学校平台 |
||||
姓名 |
字符型 |
666666 |
xx学校平台 |
||||
所属院校 |
字符型 |
xx学院 |
xx学校平台 |
||||
性别 |
字符型 |
不明 |
xx学校平台 |
||||
手机号码 |
整数型 |
00000000000 |
xx学校平台 |
||||
电子邮箱 |
字符型 |
xxxxxxxxxxxx |
xx学校平台 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
填写问卷 |
登录成功 |
xxxx |
教师进行问卷填写 |
||||
查看填写结果 |
问卷填完并提交 |
xxxx |
查看填写结果 |
||||
填写个人信息 |
登录成功 |
xxxx |
填写教师个人信息 |
||||
查看个人信息 |
登录成功 |
xxxx |
查看教师个人信息 |
表3.6 学生
类名 |
学生 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
学生填写问卷 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
学号 |
整数型 |
0000000000 |
xx学校平台 |
||||
姓名 |
字符型 |
666666 |
xx学校平台 |
||||
所属学校 |
字符型 |
xx学校 |
xx学校平台 |
||||
专业 |
字符型 |
xx专业 |
xx学校平台 |
||||
班级 |
字符型 |
xx班级 |
xx学校平台 |
||||
性别 |
字符型 |
不明 |
xx学校平台 |
||||
手机号码 |
整数型 |
00000000000 |
xx学校平台 |
||||
电子邮箱 |
字符型 |
xxxxxxxxxxxx |
xx学校平台 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
填写问卷 |
登录成功 |
xxxx |
学生进行问卷填写 |
||||
查看填写结果 |
问卷填完并提交 |
xxxx |
查看填写结果 |
||||
填写个人信息 |
登录成功 |
xxxx |
填写学生个人信息 |
||||
查看个人信息 |
登录成功 |
xxxx |
查看学生个人信息 |
表3.7 问卷
类名 |
问卷 |
所属包 |
问卷 |
||||
继承 |
无 |
||||||
实现 |
满足用户需求 |
||||||
属性 |
|||||||
名称 |
类型 |
默认值 |
Pub/Prv/Pro |
||||
问题 |
字符型 |
xxxxx |
学校生活 |
||||
选项 |
字符型 |
ABCD |
学校生活 |
||||
数量 |
字符型 |
50 |
学校生活 |
||||
事件 |
|||||||
名称 |
条件 |
参数 |
目的 |
||||
统计信息 |
用户填写完问卷并提交 |
xxxx |
统计数据并分析趋势 |