软件需求文档

Posted 夜航星675

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了软件需求文档相关的知识,希望对你有一定的参考价值。

智慧校园数据管理系统

软件需求规格文档

文件版本:1.2版本

文件状态:修改完成

文件作者:22组全体成员

完成日期:2023年3月16日

软件需求规格说明

a. 引言 2

a. 1目的

a. 2文档约定

a. 3预期的读者和阅读建议

a. 4产品的范围

a. 5参考文献

b. 综合描述 3

b.1产品的前景 3

b.2产品的功能 3

b.3用户类和特征 7

b.4运行环境 8

b.5设计和实现上的限制 8

b.6假设和依赖 8

c. 外部接口需求 8

c. 1用户界面 8

c. 2硬件接口 9

c.3软件接口 9

c.4通信接口 9

d.系统特性 10

d.1说明和优先级 10

d.2激励/响应序列 10

d.3功能需求 10

e.其它非功能需求 13

e.1性能需求 13

e.2安全设施需求 13

e.3安全性需求 1

e.4软件质量标准属性 14

e.5业务规则 14

e.6用户文档 14

a. 引言  

a.1目的 

本产品是一个基于Web的智慧校园数据管理系统旨在对高校业务范围内的所有类型数据进行集中梳理和管控,提供统一的数据接口管理,进行统一的数据分析和数据挖掘,以进一步提升高校数据质量和数据价值。通过对数据的全面监控和分析,该网站将为高校提供更全面、准确的数据分析结果和业务决策支持,帮助高校更好地理解自身业务和发掘潜在机会促进学校工作全方位融合创新构建智慧校园的新生态。

本文档将详细说明智慧校园网站的功能需求、非功能需求以及其他相关信息,以确保开发团队能够按照要求完成网站的设计和开发,并为利益相关者提供明确的期望和参考。

a.2文档约定 

本文档中的标题均使用小四号加粗,并按照层级关系进行编号正文采用小四号宋体。

若无特殊说明,本文档内的同一内容下的并列内容没有优先级先后关系。

a.3预期的读者和阅读建议 

本文档的预期读者包括但不限于:开发团队的软件工程师、架构师和测试工程师,以及利益相关者和决策者,如高校校长、信息化部门主管、业务管理人员和用户

在阅读本文档时,建议读者先对智慧校园网站的目标和愿景有一个整体的了解,再按照章节逐步深入了解各个方面的需求和约束条件。

对于开发团队的软件工程师、架构师和测试工程师等技术人员,建议在阅读文档前了解智慧校园网站的背景和目标,着重关注网站的功能和技术细节等方面的需求内容对于利益相关者和决策者,建议在阅读文档前深入了解智慧校园的整体情况,再着重关注网站的数据分析和数据挖掘能力等方面的需求内容。

a.4产品的范围 

作为一个基于Web的智慧校园数据管理系统,旨在对高校业务范围内的所有类型数据进行集中梳理和管控,包括但不限于教学信息管理系统、图书馆信息管理系统、学生活动信息系统、生活服务系统等,从全校层面统一进行数据质量监控,提供统一的数据接口管理。

本产品提供的主要功能包括数据采集、数据管理、数据分析、信息交互等模块,用户可以通过网页浏览器进行访问和使用。本产品的目标用户是高校的信息管理人员、高校教职工、学生、数据分析师等,目的有:实现师生员工身份、行动轨迹数字化管理,强化师生员工生活服务;帮助管理者更好地管理、分析和利用高校的各类数据,提升高校的数据质量和价值

a.5参考文献 

[1] IEEE 830-1998, 软件需求规格说明的 IEEE 推荐实践标准[S], 1998.

[2] Ian Sommerville.软件工程第十版)[M].机械工业出版社, 2017.

[3] Karl Wiegers、Joy Beatty.软件需求(第3版)[M].清华大学出版社,2016.

[4] Alistair Cockburn.编写有效用例[M].机械工业出版社, 2002.

[5]毋国庆、梁正平、袁梦霆、李勇华.软件需求工程实践(第2版)[M]. 机械工业出版社, 2019.

b. 综合描述

b.1产品的前景 

随着信息化时代的不断深入,高校面临着越来越多的数据管理和分析需求。然而,由于高校内部的数据来源多样、数据类型繁多、数据格式不一,以及数据管理和分析人员的分散等问题,高校的数据管理和分析工作往往存在着一些难点和挑战。为了更好地解决这些问题,提高高校数据管理和分析的效率和质量,我们推出一款基于Web的智慧校园数据管理系统。本产品对高校的所有类型数据进行集中梳理和管控,从全校层面统一进行数据质量监控,提供统一的数据接口管理,进行统一的数据分析和数据挖掘,进一步提升高校数据质量和数据价值,全面促进学校工作全方位融合创新,构建智慧校园的新生态。

b.2 产品的功能

如图为全体功能分区:

如图为学生功能分区:

如图为教师家长功能区

 

 b.3用户类和特征

相较于互联网产品,教育类产品的用户通常有着明确的“教师”与“学生”身份的划分。智慧教育产品,则更是将教育管理者、教师、学生、家长,甚至第三方的服务商等角色放入不同的垂直场景中,构成了多样的产品用户群。

 1.教育管理者

严格上来说“教育管理者”这个词并不够准确。但在通常意义上我们指代的主要是两种角色身份——教务主管与教学副校长。这一类用户的主要特点有:

1年龄段在35~50岁之间;

2或许有着多年的教育经验积累,但通常并不会直接参与到教学情景当中;

3保证学校的教学质量、促进学校教学活动的正常进行是他们的核心职责;

(4)通常面临着各式各样的事务型工作;

5对教育信息化产品有持续的、多方面的接触。

大部分的产品功能对这类用户来说都是大同小异的,所以他们比较可能关注到过去的电教化产品无法满足的一些功能点(如课堂图片下发、实时数据、课后作业等)。甚至也会毫不留情地谈到一些印象里更加良好的产品来进行对比。

2.教师

首先明确,教师是与医生、工程师、程序员一样,是对专业技能要求非常高的一种职业。教师的主要工作是教育学生(包含专业课与德育、美育等),除过我们经常讨论的备课、上课、作业、测试、家校沟通等场景外,教师群体会把大多数时间花费在课程设计上面。对大多数的教师而言,能够让学生清晰地掌握基本知识才是最基本的,而教学中采用的一切方式、资源和工具,均需要能够为整个教学过程进行服务。

教师用户个体的授课风格以及对授课方式、授课资源的选择主要受到学科特点的影响。单就常见的授课课件内容来看,文科教师比较偏向与图文展示、音频与可注释的内容;相对的,理科教师偏向于公示、习题、示意图及实验动画的展示。

对于智慧教育行业而言,教师角色永远都是需要重点关注的对象。原因有两点:

1对于智慧教学主场景而言,教师用户的产品使用程度是最深的;

2对于围绕智慧课堂建立的各个教学活动场景中,教师用户不仅是功能的使用者,也是维系其他用户的重要的数据枢纽。

3.学生

学生用户在整个智慧教育的场景中均是产品的被动使用者。这类用户的主要特点有:

1注意力转移快,在课堂环境中需要引导和管控;

2对学习资源缺少辨识能力,使用度低;

3普遍对学习工具的使用缺少主观能动性;

4对电子设备的熟悉程度较高,优于教师用户;

5有较强的群体意识,心理层面倾向于被认同。

此外,在当前较为成熟的智慧教育体系中,对于学生用户所提供的服务常常不是以学生的角度出发的所以我们会在系统里加入校园生活服务(如:校园卡,数字图书馆等)。

4.家长

家长用户同样是一个泛指概念,准确上说应当用于指代那些能够陪伴孩子并监督其课后学习过程的家长。因此这类用户极有可能包含着一部分对数字产品的使用仅限于电视的高龄人群。但我们还是尝试着归纳一下这类人的特点:

1关注学生学习成绩及学校表现;

2缺少辅导学生学习的能力、对学习资源缺少辨识能力;

3希望学生能够在学校得到老师的关注;

4普遍没有充足时间关注学生。

通常情况下家长用户不会作为智慧教育产品的主要用户,但我们仍然会出于数据闭环的考虑,为家长用户提供App或小程序来满足家校互通部分的需求。

b.4 运行环境

本平台的运行环境主要为ios/iPadOS 微信客户端、android 微信客户端、Windows PC 微信客户端、Mac 微信客户端。

b.5设计和实现上的限制

  1. 人员因素:因开发人员变更造成的软件交付时间变动;
  2. 需求因素:因客户需求变更造成的软件交付时间和功能变动;
  3. 政策与法律因素:客户提出的与政策法律相悖的需求不被考虑;
  4. 时间限制:交付时间的设定会对产品开发造成一定影响;
  5. 成本限制:成本上限的设定会对产品开发造成一定影响;
  6. 安全考虑:出于信息安全考虑我们可能不得不使用更加繁琐的方法而非简单的方法来完成部分功能。

b.6假设和依赖

  1. 政策支持:本产品的正常运作与使用依赖于政策的支持,若政策出现相关变动我们的产品可能因此不得不对原有功能进行修改;
  2. 信息支持:本产品的正常使用依赖于用户信息的正确录入,若用户因自身信息错误造成无法正常使用产品的情况,本产品不负有责任;
  3. 硬件支持:本产品的运行依赖于硬件系统的正常工作;
  4. 网络支持:本产品只能在网络系统正常的情况下运行;

c.外部接口需求

c.1用户界面

  • 登录和注册功能:用户应该能够注册一个帐户,以便能够访问应用程序或网站的其他功能。
  • 个人资料管理:用户应该能够编辑和更新其个人资料信息,例如姓名、电子邮件地址、联系方式等。
  • 密码管理:用户应该能够更改其密码和重置密码,以保护其帐户免受未经授权的访问。
  • 通知和消息:用户应该能够接收和查看通知和消息,例如新的任务、提醒和其他重要信息。
  • 数据分析和报告:如果应用程序或网站涉及到学术成果、学生表现或其他数据集,用户可能需要能够访问数据分析和报告,以便监控自己的表现。
  • 交互和社交:用户应该能够与其他用户进7行交互和社交,例如与同学、老师或其他相关人员进行聊天、讨论和协作。
  • 个性化设置:用户应该能够自定义应用程序或网站的设置,例如主题、语言和其他外观和感觉方面的参数。
  • 帮助和支持:用户应该能够找到有关应用程序或网站的帮助和支持信息,例如常见问题解答、用户手册和其他相关文档。

c.2硬件接口:

  • 位置接口:用于上课签到。
  • 照相机接口:用于扫码,上传照片。
  • 麦克接口:用于语音留言。
  • 指纹接口:用于验证用户,以简单登录或简单支付。
  • 电子门禁接口:学校需要安装电子门禁系统,以便管理人员可以控制学校各个区域的进出,确保学校安全。
  • 物联网设备接口:学校可以部署物联网设备,例如温度传感器、空气质量传感器等,以便管理人员可以实时监控学校环境状况并进行相应的调整。

c.3软件接口

  • 微信接口: 用于打开小程序,和支付。
  • 无线网络接口:学校需要为学生和教师提供无线网络接入点,以便他们可以在校园内使用自己的电子设备上网。
  • 智能教室接口:智能教室需要连接多媒体设备和教学软件,以便教师可以更好地控制课堂内容和学生参与。
  • 自助服务终端接口:学校需要在校园内设置自助服务终端,例如自助售卖机、自助借还书机等,以方便学生和教师的日常生活。

c.4通信接口:

  • 数据库接口:用于与学校信息系统或其他数据库进行通信,以获取或存储数据。
  • 网络接口:用于与互联网进行通信,以便应用程序或网站可以访问互联网上的其他资源。
  • 移动应用接口:用于与移动设备上的应用程序进行通信,例如通过手机应用程序查看课表和成绩。
  • 通知接口:用于向学生、教师和其他相关方发送通知和消息,例如短信、电子邮件和推送通知。
  • 教学工具接口:用于与课堂教学工具进行通信,例如白板、教学软件和在线课程平台。
  • 支付接口:用于在线支付学费、图书馆罚款等费用。
  • 社交媒体接口:用于与社交媒体平台进行通信,以便学生和教师可以共享和讨论学术信息和资源。
  • 数据分析接口:用于与数据分析工具进行通信,以便对学生表现、学术成果和其他相关数据进行分析和报告。


d.系统特性

一、数据存储与查询

d.1 说明和优先级

  • 优先级高,身份信息数据是其他功能模块良好运作的基础,为系统功能权限的授予提供了安全性保障。

d.2 激励/响应序列

  • (1) 用户输入账号 (工号/学号或绑定的手机号) 和密码后点击登录进行身份认证。
  • (2) 登录成功后,跳转至"个人信息"界面,该页面将展示用户的全部个人信息。
  • (3) 学生用户进入"教师信息查询"界面,输入教师姓名或工号点击"查询",将展示指定教师的相关信息以及负责的课题和活动。

d.3 功能需求

(1)登录认证:进行身份认证。

(2)个人基本信息:展示姓名、性别、生日、政治面貌、往期荣誉等信息

      • 面向学生:学号、行政班级。
      • 面向教师:职务及职称、所授班级(是否担任班主任)。

(3)教师信息查询:提供教师姓名、所属学院、联系方式(邮箱、电话)、相关课题和活动的查询功能。

二、校园卡系统

  • d.1 说明和优先级
  • 优先级高,校园卡是校内用户的身份凭证,使用频次高,作用范围广,与校园卡相关的门禁和消费功能模块满足了校内用户在生活层面上的最主要需求。
  • d.2 激励/响应序列
  • (1) 在"门禁"界面中展示着本人校园卡的授权记录 (出入校园、特殊场所) 列表。
  • (2) 进入"消费"界面,将看到"余额信息","充值"、"流水"、"挂失/解挂"、"证件遗失查询"等服务模块。
  • d.3 功能需求
  1. 门禁:提供了校园出入授权、特殊场所出入授权、授权时间管理的功能。
  2. 消费:提供校园卡充值、挂失/解挂、消费记录查询、证件遗失查询的功能。
  • 场地预约
  1. 说明和优先级
  • 优先级低,该系统涉及到教学日程之外的场地管理,可满足校内一部分群体对公共场地预约的需求。
  1. 激励/响应序列
  • (1) 进入"场地预约"界面,输入场地名称、管理单位或日期后点击查询,将展示筛选后的场地信息列表。
  • (2) 每一列表项都包含着容纳人数、设施、具体地址和预约状况等具体信息。
  • (3) 点击某一场地进入该场地的预约界面,点击"预约",填写时段、理由、联系电话等信息后即可提交申请。
  • (4) 进入 “我的预约” 界面可查看场地申请状况。
  1. 功能需求
  • 提供了图书馆、体育馆、社区、教室和会议室/报告厅场地的预约功能。图书馆预约模块中,包括了资料借阅和归还功能(线上借阅登记、归还登记、借阅状态查询和归还通知)。
  • 生活服务系统
  1. 1 说明和优先级
  • 优先级中,该系统涵盖了校园生活的几个最主要方面,提供了便捷的后勤信息查询服务和意见反馈渠道,为校内群体的生活质量提供了保障。
  1. 激励/响应序列
  • (1) 进入"校园网服务"界面,可以看到个人的网络套餐和剩余流量信息。 点击 "产品续费",选择特定的校园网套餐和续费金额,然后点击“确认”完成缴费。
  • (2) 进入"班车服务"界面,点击“班车信息”可以查询班次信息;选择指定的班次,完成购票后可在“我的订单”中看到购票信息。
  • (3) 进入"后勤服务"界面,在“后勤报修”模块中可以选择“立即报修”发起报修申请,或点击“我的报修”查询报修进度,在维修完成后可以点击“维修管理”进行维修评价;在“食堂服务”模块中,可以通过点击“意见反馈”填写意见,并能在“历史反馈”中查看提交记录和意见回复。
  •   (4) 学生用户可进入“洗衣服务”模块,点击“订单管理”查询所有洗衣订单状况,点击“自助服务”可以预约洗衣机设备或扫码启动设备,点击“服务中心”可以进行设备报修和意见反馈。
  1. 功能需求
    1. 校园网:提供充值缴费和网络信息查询功能。
    2. 班车:提供班车信息查询与预约功能。
    3. 后勤:提供后勤信息查询和意见反馈功能。
      • 面向学生:提供洗衣订单查询、取消和申诉功能。
  1. 说明和优先级
  • 优先级高,教学系统是智慧校园的核心系统之一,对学生的学习事务安排提供了完整的支持,学生能够便捷地借助该系统来接收班级群组通知、观看课程直播、查询课程/成绩、提交作业……,极大地提高了教学环节的质量和效率。
  1. 激励/响应序列
  • (1) 进入"群组和通知"界面,可以看到自己加入的班级群组,点击进入特定群组,能够接收到教师发送的通知消息和文件。
  • (2) 进入"课程"界面,能够看到“课程直播/回看”“课程表”“作业”“考试”“考勤”“请假销假”服务模块。
  1. 功能需求

(1)群组和通知:提供了加入班级、接收通知和文件的功能。

(2)课程模块

      • 课程直播和回看;
      • 个人周次课程表和全校课程表的查询;
      • 作业提交和回顾即批阅情况查询;
      • 考试场地/时间和考试成绩查询与申诉;
      • 考勤查询和请假销假。
  1. 说明和优先级
  • 优先级低,该系统提供了完整竞赛/活动信息的查询/报名渠道,同时为学生搭建了一个规范的竞赛组队平台。
  1. 激励/响应序列
  • (1) 进入“竞赛”界面,输入赛事、类型或日期点击"查询",将展示筛选后的赛事信息列表,选择指定的赛事后会跳转到报名页面。
  • (2) 在“竞赛”界面的“组队系统”服务模块中可以点击创建队伍,也可以申请加入已有的队伍,在队伍列表中可点击进入到队伍的详情页面。
  • (3) 进入“活动”界面,输入类型或日期等信息点击查询,将展示筛选后的活动信息,在活动列表中,点击进入某一活动的详情页,能够看到该活动的举办人、日程安排等信息,点击“报名”可申请加入活动。
  1. 功能需求
    1. 竞赛模块:提供赛事查询报名和组队功能。
    2. 活动模块:涉及校方活动、学生组织活动和学生自发活动。
  1. 说明和优先级
  • 优先级高,该系统与面向学生的教学系统相对,在各个功能模块上与学生端建立联系,教师能够通过该系统发布课程大纲/视频、统计学生作业/成绩信息等,同时该系统也包含了德育评价和家校联络平台,为高效高质量的教学管理提供了支撑。
  1. 激励/响应序列
  • (1) 进入“群组和通知”界面,点击指定群组可发布通知和文件。
  • (2) 进入课程管理界面,能够看到“课程直播/回看”“课程表”“作业”“考试”服务模块。
  • (3) 进入"考勤记录"界面,选择课次后点击"查询",将展示该课次的学生考勤信息。
  • (4) 进入“请假销假”界面,将展示班级学生的全部请假销假信息,点击“申请审核”可以处理待审核的请/销假申请,所有记录默认将被留档并可“归档”服务模块中查询。
  1. 功能需求

(1)课程管理模块

      • 课程直播和回看:课程大纲、课件和视频发布;
      • 课程表:发布课程变动通知,支持班主任查看全班课程表,任课老师查看周次课程表;
      • 作业:作业发布和批阅,查看作业提交情况,作业留档;
      • 考试:考试时间场地安排和查询,支持任课老师进行课程成绩记录、统计(班级总体成绩和各教学班对比)、留档(个人成绩及考卷)和申诉处理,支持班主任进行班级成绩记录和统计(个人历次考试成绩及班级整体成绩)。

(2)考勤记录模块:学生考勤信息管理和统计。

(3)请假销假模块:请/销假申请处理和留档。

(4)其他:德育评价平台和家校联络平台。

d.1 说明和优先级

  • 优先级低,聚合了学生、教师信息查询,经信息登记认证后的家长可以查看学生的平时表现、考试成绩和综合评价。

d.2 激励/响应序列

  • (1) 家长进入"信息登记"界面,填写完登记信息后点击"提交"按钮等待审核通过。
  • (2) 完成信息登记,可以进入“学生信息”界面,将展示学生的个人信息,以及学生的平时表现、考试成绩和综合评价。
  • (3) 进入"教师信息查询"界面,输入指定教师姓名后点击"查询",将展示该教师的信息。

d.3 功能需求

(1)个人信息:家长信息登记、学生信息查询、教师信息查询。

(2)教学信息:学生平时表现、考试成绩和综合评价。

2.家校联络系统

d.1 说明和优先级

  • 优先级低,为家校联络提供了便捷的渠道。

d.2 激励/响应序列

  • 进入“联系”界面,将展示班主任、辅导员以及任课老师的电话和邮箱等联络方式。

d.3 功能需求

  • 提供了联络班主任、辅导员或任课老师的功能。

e.其它非功能需求

这部分列举出了所有非功能需求,而不是外部接口需求和限制。

e.1性能需求

  1. 响应时间:产品应保证执行的90%的操作在5秒内作出响应,99%的操作在10秒内完成响应;
  2. 并发限制:本产品应当保证至少5000用户同时使用而不崩溃,若系统崩溃应在收到反馈的半小时内完成修复工作;
  3. 用户数量:本产品应当至少能够支撑十万名用户注册使用;
  4. 数据存储:本产品应当保证能够正常存储所有用户的基本信息及其产生的海量数据;
  5. 稳定性:本产品应当保证每周至多3小时不可使用,并固定更新维护时间,在后期尽量避免大规模更新。

e.2安全设施需求

  1. 访问管理:非注册用户禁止访问除宣传部分外的系统,教师、学生只能访问本人所属系统;
  2. 修改权限:非拥有管理员密钥成员不得修改除发帖和本人身份信息外的内容,管理员修改信息会留下修改日志以防违规操作;
  3. 信息保密系统:本产品承诺保护用户隐私信息,不违规使用;
  4. 防火墙系统:本产品应实现防火墙功能,防止恶意访问和入侵行为;
  5. 预防重大灾害备份系统:为防止重大灾害破坏本产品物理器件,本产品会定期对重要信息进行备份操作;
  6. 系统更新:本产品会定期进行系统更新防止出现漏洞。

e.3安全性需求

  1. 隐私安全:本产品承诺不会非法使用用户信息;
  2. 密码系统:支持密码不定期更换,初始密码不被允许二次使用,不会存储用户密码;
  3. 防火墙系统:使用专业的第三方安全技术;

e.4软件质量标准属性

  1. 性能与可靠性:见e.1部分;
  2. 可用性:保证每周至多三小时不可用,保证出现系统问题半小时内完成维护更新;
  3. 健壮性:保证出现错误输入等情况能够识别并避免崩溃;
  4. 安全性:见e.3部分;
  5. 可修改性:本产品保证代码清晰明确可读性强,易于修改更新;
  6. 可变性:本产品保证留有充足余量和结构,支持后期添加功能进行更新;
  7. 易用性:本产品特别设有新手教程和成就系统部分,手把手指导用户软件各项功能使用方法,并支持随时回顾;
  8. 功能性:本产品涵盖校园生活中大部分环境场景需要的内容,是您可靠的“线上学校”;
  9. 互操作性:本产品支持与微信,支付宝等多种常用软件进行系统交互;

e.5业务规则

1只有用户本人可以修改本人个人基本信息,并自行保证信息真实性,否则一切后果由用户本人承担;

2只有注册用户才能享受本软件为此类用户提供的对应服务,恶意攻击系统者将被注销用户资格;

(3)本软件含有文字识别系统,发布违规内容将被禁止;

(4)本产品不承担用户违规使用造成的法律后果,并保有追究相关用户法律责任的权利;

(5)对于大型活动信息,请发布者反复确定其合理合法性,若遭大量用户举报,本产品保有禁止您再次发布类似信息的权利;

(6)请使用者仔细甄别任何与消费相关的信息,若您在本平台遭遇其它组织或个人诈骗,本产品概不负责;

e.6用户文档 

  1. 用户手册:您可以在本产品中查阅相关信息;
  2. 在线帮助:我们会在“我的”中留有“在线帮助”系统,若有需要可与客服人员进行联系;
  3. 教程:本产品有详尽的教程系统和相配套的成就系统;

以上是关于软件需求文档的主要内容,如果未能解决你的问题,请参考以下文章

怎么分析《软件需求文档》

软件需求与分析

软件工程文档设计中的基本要求:关于每个文档究竟该写什么

如何进行软件测试需求分析(两图一文档)

收到的软件需求说明书是哪一类的

《需求工程-软件建模与分析之读书笔记之三》