软件需求规格介绍说明手册(案例)

\\PAGE软件开发方向“成绩管理系统”软件需求规约安博教育集团二零零八年十月修订历史记录日期版本说明作者2008-10-120.8未评审的初稿吴子敬目录TOC\o"1-3"\h\z\uHYPERLINK\l"_Toc211595521"1引言PAGEREF_Toc211595521\h5HYPERLINK\l"_Toc211595522"1.1目的PAGEREF_Toc211595522\h5HYPERLINK\l"_Toc211595523"1.2文档格式PAGEREF_Toc211595523\h5HYPERLINK\l"_Toc211595524"1.3预期的读者和阅读建议PAGEREF_Toc211595524\h5HYPERLINK\l"_Toc211595525"1.4范围PAGEREF_Toc211595525\h6HYPERLINK\l"_Toc211595526"1.5术语PAGEREF_Toc211595526\h6HYPERLINK\l"_Toc211595527"1.6参考文献PAGEREF_Toc211595527\h6HYPERLINK\l"_Toc211595528"2系统概述PAGEREF_Toc211595528\h6HYPERLINK\l"_Toc211595529"2.1概述PAGEREF_Toc211595529\h6HYPERLINK\l"_Toc211595530"2.2功能PAGEREF_Toc211595530\h7HYPERLINK\l"_Toc211595531"2.3运行环境PAGEREF_Toc211595531\h8HYPERLINK\l"_Toc211595532"2.4假设与依赖PAGEREF_Toc211595532\h8HYPERLINK\l"_Toc211595533"3系统特性PAGEREF_Toc211595533\h9HYPERLINK\l"_Toc211595534"3.1系统角色PAGEREF_Toc211595534\h9HYPERLINK\l"_Toc211595535"3.2学生管理PAGEREF_Toc211595535\h9HYPERLINK\l"_Toc211595536"3.2.1增加学生信息PAGEREF_Toc211595536\h9HYPERLINK\l"_Toc211595537"3.2.2修改学生信息PAGEREF_Toc211595537\h9HYPERLINK\l"_Toc211595538"3.2.3删除学生信息PAGEREF_Toc211595538\h9HYPERLINK\l"_Toc211595539"3.2.4导入学生信息PAGEREF_Toc211595539\h9HYPERLINK\l"_Toc211595540"3.3教师管理PAGEREF_Toc211595540\h10HYPERLINK\l"_Toc211595541"3.3.1增加教师信息PAGEREF_Toc211595541\h10HYPERLINK\l"_Toc211595542"3.3.2修改教师信息PAGEREF_Toc211595542\h10HYPERLINK\l"_Toc211595543"3.3.3删除教师信息PAGEREF_Toc211595543\h10HYPERLINK\l"_Toc211595544"3.3.4导入教师信息PAGEREF_Toc211595544\h10HYPERLINK\l"_Toc211595545"3.4课程管理PAGEREF_Toc211595545\h11HYPERLINK\l"_Toc211595546"3.4.1增加课程基本信息PAGEREF_Toc211595546\h11HYPERLINK\l"_Toc211595547"3.4.2修改课程基本信息PAGEREF_Toc211595547\h11HYPERLINK\l"_Toc211595548"3.4.3删除课程基本信息PAGEREF_Toc211595548\h11HYPERLINK\l"_Toc211595549"3.4.4维护课程学生信息PAGEREF_Toc211595549\h11HYPERLINK\l"_Toc211595550"3.5成绩查询PAGEREF_Toc211595550\h12HYPERLINK\l"_Toc211595551"3.5.1学生查询成绩PAGEREF_Toc211595551\h12HYPERLINK\l"_Toc211595552"3.5.2教师查询成绩PAGEREF_Toc211595552\h12HYPERLINK\l"_Toc211595553"3.6成绩分析与统计PAGEREF_Toc211595553\h12HYPERLINK\l"_Toc211595554"3.6.1考试成绩表PAGEREF_Toc211595554\h12HYPERLINK\l"_Toc211595555"3.6.2班级各科平均成绩表PAGEREF_Toc211595555\h12HYPERLINK\l"_Toc211595556"3.6.3成绩排名表PAGEREF_Toc211595556\h13HYPERLINK\l"_Toc211595557"3.7系统维护PAGEREF_Toc211595557\h13HYPERLINK\l"_Toc211595558"3.7.1数据字典维护PAGEREF_Toc211595558\h13HYPERLINK\l"_Toc211595559"4非功能性需求PAGEREF_Toc211595559\h13HYPERLINK\l"_Toc211595560"4.1性能需求PAGEREF_Toc211595560\h13HYPERLINK\l"_Toc211595561"4.2安全性需求PAGEREF_Toc211595561\h13HYPERLINK\l"_Toc211595562"4.3可用性需求PAGEREF_Toc211595562\h14HYPERLINK\l"_Toc211595563"4.4用户文档PAGEREF_Toc211595563\h14HYPERLINK\l"_Toc211595564"4.5其它需求PAGEREF_Toc211595564\h15HYPERLINK\l"_Toc211595565"5外部接口需求PAGEREF_Toc211595565\h15HYPERLINK\l"_Toc211595566"5.1用户接口PAGEREF_Toc211595566\h15HYPERLINK\l"_Toc211595567"5.2硬件接口PAGEREF_Toc211595567\h15HYPERLINK\l"_Toc211595568"5.3软件接口PAGEREF_Toc211595568\h15HYPERLINK\l"_Toc211595569"5.4通信接口PAGEREF_Toc211595569\h151引言1.1目的该文档首先给出了整个系统的整体网络结构和功能结构的概貌，试图从总体架构上给出整个系统的轮廓，然后又对功能需求、性能需求和其它非功能性需求进行了详细的描述。其中对功能需求的描述采用了UML的用例模型方式，主要描述了每一用例的基本事件流，若有备选事件流则描述，否则则省略。而且还给出了非常直观的用例图。这些文字和图形都为了本文档能详细准确地描述用户的需求，同时也为用户更容易地理解这些需求的描述创造了条件。该文档详尽说明了这一软件产品的需求和规格，这些规格说明是进行的基础，也是编写测试用例和进行系统测试的主要依据。同时，该文档也是用户确定软件功能需求的主要依据。1.2文档格式本文档按以下要求和约定进行书写：（1）页面的左边距为2.5cm，右边距为2.0cm，装订线靠左，行距为最小值20磅。（2）标最多分三级，分别为黑体小三、黑体四号、黑体小四，标题均加粗。（3）正文字体为宋体小四号，无特殊情况下，字体颜色均采用黑色。（4）出现序号的段落不采用自动编号功能而采用人工编号，各级别的序号依次为（1）、1）、a)等，特殊情况另作规定。1.3预期的读者和阅读建议本文档的主要内容共分4部分：综合描述、系统特性、和非功能性需求和外部接口描述。综合描述部分主要对系统的整体结构进行了大致的介绍；系统特性部分对系统的功能需求进行了详细描述，是本文的主要部分；非功能性需求部分对非功能需求进行了详细的描述；外部接口需求部分对用户界面、软件接口、硬件接口和通讯接口等进行了描述。本文档面向多种读者对象：（1）项目经理：项目经理可以根据该文档了解预期产品的功能，并据此进行系统设计、项目管理。（2）设计员：对需求进行分析，并设计出系统，包括数据库的设计。（3）程序员：配合《设计报告》，了解系统功能，编写《用户手册》。（4）测试员：根据本文档编写测试用例，并对软件产品进行功能性测试和非功能性测试。（5）销售人员：了解预期产品的功能和性能。（6）用户：了解预期产品的功能和性能，并与分析人员一起对整个需求进行讨论和协商。（7）其他人员：如部门领导、公司领导等可以据此了解产品的功能和性能。在阅读本文档时，首先要了解产品的功能概貌，然后可以根据自身的需要对每一功能进行适当的了解。1.4范围该产品是在积累了丰富业务经验的基础上进行开发的，在需求上，充分考虑了具体用户的实际情况。本产品将主要适用于江苏省各高级中学的成绩管理，主要完成学生成绩录入、批量导入、学生成绩分析与统计等业务，也可作为学校学生与教务管理系统的一个子模块。1.5术语1.6参考文献2系统概述2.1概述高级中学对学生的考核主要还是对学生各科成绩的考核，考试类别多、课程多，而且要随高考制度的变化不断地改变，学生多，工作量大，尤其对学生成绩的分析（如排名）统计要及时，所以成绩管理一直是学校管理中的一个重要子系统。好的管理系统可以简少老师在成绩管理上的工作量，学生可以及时查询学习成绩，学校可以快速获得考试结果，掌握教学情况，改进教学活动。增加学生信息2.2功能修改学生信息学生档案管理删除学生信息导入学生信息删除教师信息修改教师信息增加教师信息教师信息管理导入教师信息成绩管理系统修改学生成绩录入学生成绩管理课程学生管理课程基本信息课程管理成绩维护考试成绩表各科平均成绩表学生成绩分析统计期末考试成绩排名表学生查询成绩成绩查询教师查询成绩系统管理图一成绩管理系统功能2.3运行环境该系统为B/S三层结构，它的运行环境分客户端、应用服务器端和数据库服务器端三部分。以下是系统的软件环境。（1）客户端操作系统：Windows2000Professional/XP或更新版本。浏览器：IE6以上，其它常见浏览器如FireFox。（2）应用服务器端操作系统：Windows2000Server或更新版本。应用服务器：Tomcat5.5或更新版本。数据库访问：JDBC。（3）数据库服务器端操作系统：Windows2000Server或更新版本。数据库系统：SQLServer2000或更新版本。2.4假设与依赖本项目是否能够成功实施，主要取决于以下的条件：（1）苏州中学能够积极地与安博配合，为了项目的开发和实施，在必要时对现有的业务流程进行合理的调整。（2）苏州中学为安博的调研、开发和实施过程提供必要的工作环境和系统运行环境，这些环境有助于安博开展工作。（3）苏州中学为安博提供完整的功能和性能需求资料，以便于安博对其进行分析，从而形成完善的软件需求。（4）苏州中学为软件系统的运行提供必要的且能够满足系统运行条件的硬件环境和通讯环境，不合适的硬件环境和通讯环境将会影响系统的性能。（5）安博掌握先进的能够适用于该项目的技术，这是系统的性能是否优化和项目能否成功的保证。（6）苏州中学与安博具有相对稳定的项目团队，不稳定的团队将影响项目的进度和质量。3系统特性3.1系统角色本系统主要用于学校的以下几类人员：（1）系统管理员，完成系统管理与维护，例如，维护学生、教师及数据字典等的维护。图二用例图一（2）教师，维护课程与成绩，查询所教课程的所有学生的成绩。（3）学生则可查询自已的成绩。图三用例图二3.2学生管理3.2.1增加学生信息使用者：学校有学生管理功能角色的用户。目的：单个添加学生基本信息。基本事件流：1、用户进入增加单个学生界面，本用例开始；2、系统显示学生信息输入界面，用户输入学生姓名、学号、性别、出身日期、入学日期、班级、政治面貌、籍贯。3、用户确认输入信息，系统检查学号是否唯一，若唯一，则增加学生信息，本用例结束。否则，提示用户重新输入。3.2.2修改学生信息3.2.3删除学生信息3.2.4导入学生信息使用者：学校有学生管理功能角色的用户目的：批量导入学生信息，也可以将其他系统中学生信息按照规定的格式导入本系统。基本事件流：1、用户进入批量导入学生界面，本用例开始；2、系统显示导入文件类型、格式说明、并提供导入的模板文件下载。3、用户按照导入文件格式要求填写或生成对应文件，然后将文件上传，点击确定。4、系统检查文件的合理性，如果文件格式有误或有数据冲突，给出详细提示列表（错误所在行、错误原因），用户修改文件后再上传，如果上传文件合理，系统将学生信息导入系统。5、本用例结束。3.3教师管理使用者：学校有教师管理功能角色的用户目的：单个添加教师基本信息。基本事件流：1、用户进入增加单个教师界面，本用例开始；2、系统显示教师信息输入界面，用户输入教师姓名、工号、性别、出身日期、工作开始日期、职务、政治面貌、籍贯。3、用户确认输入信息，系统检查工号是否唯一，若唯一，则增加教师信息，本用例结束。否则，提示用户重新输入。3.3.1增加教师信息3.3.2修改教师信息3.3.3删除教师信息3.3.4导入教师信息使用者：学校有教师管理功能角色的用户目的：批量导入教师信息，可以将其他系统中教师信息按照规定的格式导入本系统。基本事件流：1、用户进入批量导入教师界面，本用例开始；2、系统显示导入文件类型、格式说明、并提供导入的模板文件，供下载。3、用户按照导入文件格式要求填写或生成对应文件，然后将文件上传，点击确定。4、系统检查文件的合理性，如果文件格式有误码或有数据冲突，给出详细提示列表（错误所在行、错误原因），用户修改文件后再上传，如果上传文件合理，系统将教师信息导入系统。5、本用例结束。3.4课程管理3.4.1增加课程基本信息使用者：教师或学校有课程管理角色的用户目的：创建新课程。基本事件流：1、用户进入创建新课程页面，本用例开始；2、系统显示创建课程页面，用户输入课程名称、学期、开始日期、结束日期，并选择任课教师。3、用户确认创建课程，系统保存新创建的课程。本用例结束。3.4.2修改课程基本信息3.4.3删除课程基本信息3.4.4维护课程学生信息使用者：教师或学校有课程管理角色的用户。目的：将学生加入已创建的课程。基本事件流：1、用户维护课程学生信息界面，本用例开始；2、系统显示课程列表，用户选择要加入学生的课程，系统显示该课程已存在的学生；3、用户选择加入新学生，系统显示学生列表，用户可通过搜索列表显示班级下的学生，用户选择要加入课程的学生4、系统将所选学生加入前面选定的课程，本用例结束。3.5成绩查询3.5.1学生查询成绩3.5.2教师查询成绩3.6成绩分析与统计3.6.1考试成绩表某学期某次考试的单个班级的考试成绩表2000-2001学年第二学期高一（1）班期末考试成绩表　　　　　学号姓名政治语文数学物理化学历史地理体育劳技总分排名年级排名位比类别毕业学校1张三7182885664747260717170938013.33A+十六中2李四8762825774708690807276026010.00B吴江青云中学3王五808768576878788986797701101.67A+吴江盛泽中学4赵六63705561856659587889684515025.00B-昆山一中5钱七77845862705868676288694412020.00A+太仓一中3.6.2班级各科平均成绩表某学期某次考试单个年级的各科平均成绩表2000-2001学年第二学期高一各班期末考试各科平均成绩表班级名称政治语文英语数学物理化学历史地理高一（1）班82.240480.542881.833280.24581.809880.523981.708883.2053高一（2）班83.32980.395281.965983.550484.450584.196781.737181.0116高一（3）班80.203881.323180.311484.608681.64981.095983.67883.1304高一（4）班82.187580.010684.764381.6482.122782.933480.233982.7959高一（5）班84.613784.411984.885980.769981.800184.649780.28680.10053.6.3年级成绩排名表某学期某次考试单个年级的年级排名表2000-2001学年第二学期高一年级期末考试成绩排名表排名总分姓名班级名称毕业学校类别位比政治语文英语数学物理化学历史地理1770王五高一（2）班吴江盛泽中学A+0.1780876857687878892760李四高一（1）班吴江青云中学B0.3387628257747086903709张三高一（3）班十六中A+0.5071828856647472604694钱七高一（8）班太仓一中A+0.6777845862705868675684赵六高一（9）班昆山一中B-0.8363705561856659583.7系统维护3.7.1数据字典维护4非功能性需求4.1性能需求（1）客户端一般响应时间（除报表统计、数据导入）不超过1秒。（2）报表统计时间不超过30秒。（3）支持2000名学生信息的一次性导入，导入时间不超过300秒。（4）支持5000名用户（高级中学可达到的规模）并发使用，并保证性能不受影响。4.2安全性需求（1）权限控制根据不同用户角色，设置相应权限，用户的重要操作都做相应的日志记录以备查看，没有权限的用户禁止使用系统。学生只可查看自已的学习成绩，教师只可查看所教课程的学生成绩（2）重要数据加密本系统对一些重要的数据按一定的算法进行加密，如用户口令、重要参数等。（3）数据备份允许用户进行数据的备份和恢复，以弥补数据的破坏和丢失。（4）记录日志本系统应该能够记录系统运行时所发生的所有错误，包括本机错误和网络错误。这些错误记录便于查找错误的原因。日志同时记录用户的关键性操作信息。4.3可用性需求（1）方便操作，操作流程合理尽量从用户角度出发，以方便使用本产品。如：新增学生信息时，敲入回车键光标的自动跳转、输入法的自动转换，信息检索时输入汉语简拼快速检索到结果等。可以通过快速键方便用户录入信息，所有操作可仅通过键盘完成。（2）支持没有计算机使用经验、计算机使用经验较少及有较多计算机使用经验的用户均能方便地使用本系统。（3）控制必录入项本系统能够对必须录入的项目进行控制，使用户能够确保信息录入的完整。同时对必录入项进行有效的统一的提示。（4）容错能力系统具有一定的容错和抗干扰能力，在非硬件故障或非通讯故障时，系统能够保证正常运行，并有足够的提示信息帮助用户有效正确地完成任务。（5）操作完成时有统一的提示信息例如删除操作时，系统可提示警示框“您确认删除记录吗？操作不可恢复！”，用户点击确认后，系统才执行删除操作，删除后可直接返回相关页面。（6）用户可自定义为了满足业务的不断变化，一些重要的参数应该可以灵活设置。（7）联机帮助与操作指南。4.4用户文档同本软件一起发行的用户文档包括：（1）安装手册：word格式文件。（2）用户手册：Word格式文件。（3）在线帮助：HTMLHelp格式文件，联机式。4.5其它需求（1）支持多浏览器。（2）系统安装方便，易于维护。5外部接口需求5.1用户接口本系统采用B/S架构，所有界面使用WEB风格，用户界面的具体细节将在概要设计文档中描述。5.2硬件接口服务器端建议使用专用服务器。5.3软件接口无特殊需求。5.4通信接口无特殊需求。