软件需求说明书

1、第八组软件需求说明书南大实训管理系统目录1引言21.1编写目的21.2背景21.3定义21.4参考资料32任务概述32.1目标32.2用户的特点32.3假定和约束43需求规定43.1对功能的需求43.2系统模块划分53.3各子模块的功能描述63.3.1审查考核模块63.3.2文件管理模块123.3.3站内通信模块163.3.4用户管理模块214运行环境规定274.1硬件环境274.2软件环境284.3接口284.4控制281引言1.1编写目的根据校方和企业方的要求，编写项目需求说明书。本说明书目的是确定系统开发的范围，反映出系统的结构，为开发人员、维护人员、需求人员间提供共同的协议而创立基础对

2、软件功能的实现进行描述，作为开发人员进行设计和编码的基础。作为开发人员和需求人员之间的共同文档，为双方的互相了解提供基础。1.2背景自实训完成毕业设计这一方案的实施以来，实训已经成为了考研学生完成毕业设计的最佳方案。然而随着合作企业的越来越多，以及参与实训的学生数目的增长，管理实训这个过程变得繁琐。目前实训主要包括技能训练，确定选题，完成选题这三个部分。但是学生所擅长的领域各有不同，编码偏好也有所不同。学院之内就分有八个方向，如果让所有的学生都跟随一个企业，用同一种方式来进行实训是不妥当的。技能训练这一环节也会变得非常复杂，因为不同的学生需要不同的技术训练。简单的用一种训练模式只会导致学生学不

3、到想要学的或者学的都是已经掌握的知识。之后的选题环节不同的企业和不同的学生选题方向非常多变，该如何才能做到高效的进行实训选题是当前的一个很棘手的问题。所以我们需要多个企业，多个方向来给学生进行选择，这个就牵涉到一个管理的问题。如何让企业指导与学生的学习变得井井有条是当务之急。然而学生在大四阶段也会进入一个事情很多的状态，请假情况越来越多，也有一些学生对实训不够重视，擅自旷课或者实训期间偷懒。项目完成各个阶段产生的文档，代码该如何进行整合，汇总以及项目产物的保存是否安全。种种情况都有着不确定的因素，这个必然导致实训效率的降低。如何解决这一难题，并实现多元化，快捷化，准确化管理实训成为了校方与企业

4、甚至学生的困扰。现实背景要求我们必须引进先进的管理方法与技术，借助信息化工具，加大管理精度并且改良管理模式，才能顺利完成实训这一过程，提高学校的教学质量。由此产生了实训管理系统这一个解决方案。该系统提供一个全面的信息管理功能，通过系统可以比较容易地获得所需的关于组织体系、实训进程、人员状况等静态数据，也可以方便地获得各种动态信息来进行趋势预测与未来规划。同时系统内部实现了资源的共享与保存，以确保项目不会因为个人的工作失误而功亏一篑。a 系统名称：南大实训管理系统；b 任务提出者:中软国际南大项目开发组；开发者:南大实训管理系统开发组；用户:参加南大实训的学生，校方老师，公司方指导教师以及系统管

5、理员；开发中心:南京大学费彝民楼508；c 本系统需要网络运营商的支持；1.3定义校方：南京大学软件学院企业方：负责实训的企业老师B/S：Browser/Server结构，即浏览器/服务器结构MySQL：MySQL是一个小型关系型数据库管理系统Tomcat：Tomcat是一个轻量级应用服务器，在中小型系统和并发访问用户不是很多的场合下被普遍使用MyEclipse：MyEclipse是一个十分优秀的用于开发Java、J2EE的Eclipse插件集合，支持十分广泛1.4参考资料a GB8567-2006计算机软件文档编制规范；b 软件设计文档国家标准_GB856788；2任务概述2.1目标本系统是

6、一个基于B/S网络架构的管理系统，应用范围是参与南大实训的学生，校方、公司方的老师以及系统管理员。该产品的目标是为老师提供一个迅捷、高效的管理手段，以减少人工记录的繁琐与耗时。能够准确地获取学生的出勤情况，同时为老师和学生都提供了一个良好的沟通与交流的平台，能让老师及时观察目进度并提出意见，老师之间也能够互相沟通。能够方便学生的文档提交与资源共享，确学生的项保学生在实训期间最大化利用资源与时间。本系统是一款独立的软件系统。2.2用户的特点用户特点本项目的最终产品主要有4种用户人群1. 学生用户：是使用本系统学生模块的所有学生，该部分人员的操作水平为初、中级,可以通过web使用所需的功能。2.

7、公司方指导教师用户：是使用本系统企业方模块的所有指导教师，该部分人员的操作水平为中级,可以通过web使用所需的功能。3. 校方老师用户：是使用本系统校方模块的所有教师，该部分人员的操作水平为中级,可以通过web使用所需的功能。4. 系统维护人员：是后台系统维护的人员，事先得到过专业的培训，具有较高的专业水平。2.3假定和约束1. 技术约束：采用B/S网络框架，采用MySQL数据库2. 性能约束：用户进行操作的时候能够及时响应，没有明显的延时。系统运行稳定，能够长时间连续运行。3. 软件环境数据库：MySQL中间件：tomcat6.0及以上JDK：6.0版本及以上4. 时间约束:项目前期准备、需

8、求分析和体系结构设计的时间约为20天，编码阶段的时间为1个月，后期测试与集成的时间为3周。5. 人力约束:项目组成员人数为4人，非特殊情况，不做变动。6. 经费约束：无开发经费。3需求规定 3.1对功能的需求模块输入处理输出用户管理（登录）用户名、密码验证是否匹配显示主界面（添加）用户基本信息验证信息，添加到数据库成功提示（查询）用户名搜索数据库用户基本信息修改信息内容覆盖原先用户信息成功提示文件管理文件名搜索数据库符合条件的文件列表备注添加到数据库无审查考核周报月报评语添加到相应的周报月报列表无从指纹签到器读入添加至相应的数据库成功提示违章图片上传至服务器成功提示违章信息添加至相应违章图片列

9、表无项目文件评语添加到相应的文件列表无毕业论文评语添加到相应的论文列表无站内通信对话信息传输至对方并保存在服务器对话信息选中的联系人调出对应聊天记录聊天记录公告信息上传至服务器无3.2系统模块划分3.3各子模块的功能描述3.3.1审查考核模块功能描述：1. 企业方登录后可以查看和记录学生的考勤信息2. 企业方登录后可以查看和记录学生的违章信息3. 企业方登录后可以对学生项目文件进行批阅4. 校方登录后可以对工作周报、月报进行批阅5. 校方登录后可以查看学生的考勤信息6. 校方登录后可以查看学生的违章信息7. 校方登录后可以对学生的论文进行批阅用例编号：1.1 用例名：记录学生考勤信息执行者：企

10、业方用户前置条件：用户已登录，选择一个学生后置条件： 系统更新至数据库 基本路径：1. 企业方用户登录系统2. 企业方用户在学生列表中选择一个学生3. 企业方用户修改学生的考勤信息字段列表：学生编号用例编号：1.2 用例名：企业方查看学生考勤信息执行者：企业方用户前置条件：用户已登录，选择一个学生后置条件： 无基本路径：1. 企业方用户登录系统2. 企业方用户在学生列表中选择一个学生3. 系统显示学生的考勤信息字段列表：学生编号用例编号：1.3 用例名： 记录学生违章信息执行者：企业方用户前置条件：用户已登录，选择一个学生后置条件： 更新至数据库基本路径：1. 企业方用户登录系统2. 企业方用

11、户在学生列表中选择一个学生3. 企业方用户修改学生的违章信息字段列表：学生编号用例编号：1.4 用例名：企业方查看学生违章信息执行者：企业方用户前置条件：用户已登录，选择一个学生后置条件：无基本路径：1. 企业方用户登录系统2. 企业方用户在学生列表中选择一个学生3. 系统显示学生的违章信息字段列表：学生编号用例编号：1.5 用例名：企业方批阅项目文档执行者：企业方用户前置条件：用户已登录，选择一个项目文档后置条件： 更新至数据库基本路径：1. 企业方用户登录系统2. 企业方用户在项目文档列表中选择一个项目文档3. 企业方用户查看项目文档4. 企业方用户对项目文档进行批阅字段列表：项目编号用例

12、编号：1.6 用例名：校方查看学生考勤信息执行者：校方用户前置条件：用户已登录，选择一个学生后置条件：无基本路径：1. 校方用户登录系统2. 校方用户在学生列表中选择一个学生3. 系统显示学生的考勤信息字段列表：学生编号用例编号：1.7 用例名：校方查看学生违章信息执行者：校方用户前置条件：用户已登录，选择一个学生后置条件：无基本路径：1. 校方用户登录系统2. 校方用户在学生列表中选择一个学生3. 系统显示学生的违章信息字段列表：学生编号用例编号：1.8 用例名：校方批阅工作周报月报执行者：校方用户前置条件：用户已登录，选择一个工作周报或者月报后置条件： 更新至数据库基本路径：1. 校方用户

13、登录系统2. 校方用户在周报月报列表中选择一个周报或者月报3. 校方用户查看周报或者月报4. 校方用户对周报月报进行批阅字段列表：周报ID用例编号：1.9 用例名：校方批阅学生论文执行者：校方用户前置条件：用户已登录，选择一个学生论文后置条件： 更新至数据库基本路径：1. 校方用户登录系统2. 校方用户在论文列表中选择一个学生论文3. 校方用户查看学生论文4. 校方用户对学生论文进行批阅字段列表：论文编号3.3.2文件管理模块功能描述：1. 文件上传：已登录的学员以及企业方指导教师能够根据权限上传文件到目标文件夹。2. 文件下载：已登录的学员，企业方指导教师以及校方能够根据权限下载所需的文件。

14、3. 数据导出：已登录的学员，企业方指导教师以及校方能够根据权限从数据库导出数据并形成excel文件并下载4. 文件搜索：已登录的学员，企业方指导教师以及校方能够根据权限搜索所需要的文件。5. 文件删除：已登录的管理员能够根据权限删除不需要的文件。6. 添加备注：已登录的学员以及指导教师能够根据权限对上传的文件添加备注。用例图：用例编号：2.1用例名：文件上传执行者：企业方指导教师，学生前置条件：用户已登录，已经选择要上传的文件后置条件：用户成功上传文件基本路径：1. 用户点击浏览按钮2. 用户选择要上传的文件，点击确定3. 用户点击文件上传按钮4. 文件上传成功，返回成功信息字段列表：文件存

15、储路径，文件存储时间，文件名称，用户名用例编号：2.2 用例名：文件下载 执行者：企业方指导教师，学生，校方前置条件：用户已登录，已经选择要下载的文件后置条件：用户成功下载文件基本路径：1. 用户选择要下载的文件2. 用户点击下载按钮3. 用户选择存储路径，点击确定4. 文件下载成功，返回成功信息字段列表：文件存储路径，文件名称，用户名用例编号：2.3用例名：文件搜索 执行者：企业方指导教师，学生，校方前置条件：用户已登录，已经输入要搜索的文件名后置条件：用户成功搜索到文件基本路径：1. 用户在搜索栏输入要搜索的文件名2. 用户点击搜索按钮3. 搜索成功，显示搜索到的文件字段列表：文件存储路径

16、，文件名称，用户名用例编号：2.4用例名：数据导出 执行者：企业方指导教师，学生，校方前置条件：用户已登录，在要导出的数据页面点击导出按钮后置条件：生成excel文件存储要导出的数据，用户成功下载excel文件基本路径：1. 用户进入要导出的数据页面2. 用户点击导出按钮3. 得到excel文件，用户成功下载excel文件字段列表：文件名称，用户名，数据页面用例编号：2.5用例名：文件删除 执行者：管理员前置条件：用户已登录，已经选择要删除的文件后置条件：用户成功删除文件基本路径：1. 用户选择要删除的文件2. 用户点击删除按钮3. 弹出确定询问，点击确定4. 文件删除成功，返回成功信息字段列

17、表：文件存储路径，文件名称，用户名用例编号：2.6用例名：添加备注 执行者：企业方指导教师，学生，校方前置条件：用户已登录，已经选择要添加备注的文件后置条件：用户成功添加备注基本路径：1. 用户选择要添加备注的文件2. 用户点击添加备注按钮3. 弹出备注添加框，用户添加备注，点击确定4. 添加备注成功，返回成功信息字段列表：文件名称，用户名3.3.3站内通信模块功能描述：1. 用户可以与自己的联系人进行即时聊天，如果对方不在线可以用留言的方式告知联系人。2. 用户之间能进行文件传输。3. 用户的聊天记录将被保存至服务器，并可以随时查看。4. 用户可以在自己的联系人里面建立起一个多人讨论组以进行

18、多人会话。5. 企业方可以通过站内公告的方式告知学生信息。用例编号：3.1 用例名：站内对话执行者：企业方用户、校方用户、学生用户前置条件： 用户登录系统，选择联系人后置条件： 更新数据库基本路径：1 用户登录，进入联系人界面2 用户选择一个联系人3 发送信息 字段列表：用户ID，联系人ID用例编号：3.2 用例名：站内留言执行者：企业方用户、校方用户、学生用户前置条件： 用户登录系统，选择联系人，并且该联系人离线后置条件： 更新数据库基本路径：1 用户登录，进入联系人界面2 用户选择一个联系人3 发送信息 字段列表：用户ID，联系人ID用例编号：3.3 用例名：站内文件传输执行者：企业方用户

19、、校方用户、学生用户前置条件： 用户登录系统，选择联系人后置条件： 无基本路径：1 用户登录，进入联系人界面2 用户选择一个联系人3 传输文件字段列表：用户ID，联系人ID用例编号：3.4 用例名：聊天记录查看执行者：企业方用户、校方用户、学生用户前置条件： 用户登录系统，选择联系人后置条件： 无基本路径：1 用户登录，进入联系人界面2 用户选择一个联系人3 查看聊天记录字段列表：用户ID，联系人ID用例编号：3.5 用例名：建立讨论组执行者：企业方用户、校方用户、学生用户前置条件： 用户登录系统，选择联系人后置条件： 无基本路径：1 用户登录，进入联系人界面2 用户选择多个联系人3 建立讨论

20、组4 发起会话字段列表：用户ID，联系人ID用例编号：3.6 用例名：企业方发布公告执行者：企业方用户前置条件： 企业方用户登录系统后置条件： 更新数据库基本路径：1 企业方用户登录2 输入公告信息3 发布公告字段列表：用户ID 公告ID用例编号：3.7 用例名：学生查看公告执行者：学生用户前置条件： 学生用户登录系统后置条件： 无基本路径：1 学生用户登录2 查看公告信息3 选中公告具体查看字段列表：用户ID 公告ID3.3.4用户管理模块功能描述：1 管理员进行用户的添加，添加学生信息，校方信息，企业方信息2 用户自己可以自己的信息进行完善3 用户权限管理，分一般用户（学生，校方，企业方）

21、，管理员4 管理员查询用户，删除用户。5 管理员对学生用户分组分班6 校方对企业方、学生进行查询，7 企业方对学生进行查询用例图：用例编号：4.1 用例名：用户添加执行者： 管理员用户前置条件：管理员进入添加界面后置条件： 管理员添加成功基本路径： 1. 管理员填写基本信息2. 系统把用户信息存入数据库扩展： 因为用户名已经存在会导致注册失败字段列表： 用户ID、学号用例编号：4.2 用例名：用户登录执行者： 所有用户前置条件： 管理员已经添加用户信息后置条件： 用户已经登录基本路径：1 用户填写用户名和密码并且选择相应的角色（校方，企业方，学生，管理员）2 系统验证用户名和密码，角色是否匹配

22、3 用户登陆成功4 如果用户忘记密码，可以点忘记密码按钮，将自动跳转到管理员的联系方式扩展：1 因为用户名或密码填写失误导致登录失败2 用户可以选择是否记住密码3 如果忘记密码，可以按，忘记密码按钮字段列表： 用户ID用例编号：4.3 用例名：用户修改信息执行者：所有用户前置条件：用户已经登录后置条件：用户信息已更新基本路径 ：1 用户进入个人信息页面2 用户修改个人信息3 系统保存信息字段列表：用户ID用例编号：4.4 用例名：用户注销执行者 ：所有用户前置条件：用户已经登录后置条件：该用户名暂时不可用基本路径 ：1 用户进入注销页面2 用户输入密码，确认注销3 系统冻结用户名扩展：注销以后可以再次激活字段列表：用户名ID、密码用例编号：4.5 用例名：管理员登录执行者 ：管理员用户前置条件：无后置条件：管理员已经登录基本路径 1 管理员输入ID和密码2 系统验证ID和密码3 管理员登陆成功扩展管理员没有注册，登录是在PC平台上。字段列表管理员ID、管理员密码用例编号：4.6 用例名：管理员查询和删除用户执行者 ：管理员用户前置条件：管理员已经登录后置条件：已显示