软件产品开发文档(规格说明书)

1 例 软件产品开发文档 一 一 需求规格说明书需求规格说明书 1 引言 1 1 编写目的 在软件项目开发过程的初期 用户对自身的需求也仅仅有一个模糊的概念需求分析的 目的就是把这个概念具体化 并在用户和开发人员之间达成共识 包括对用户需求的全面 了解 和分析 筛选 明确所要开发的软件项目的职责界限 并进行可行性研究和指定资源 进 度预算等 1 2 项目背景 本项目的委托单位为安徽农业大学教务处 开发单位为自由软件开发室 主管部门为 自由软件开发室的项目经理部 随着高等教育的改革和高校的不断扩招 传统的教学管理 方式已远远不能满足高等教育的发展 高等教育的发展也使传统的教学管理方式日益被淘 汰 这样以来 一批精明的软件开发商开发了基于局部网络 校园网 和数据库的应用系 统 大多情况下 这些系统是以客户机 服务器结构的分布式系统 它的核心教学管理系统 和数据库放置在学校的中心计算机上 用户接口端的应用程序分别配置在图书馆 专业系 和学生宿舍的客户机上 2 任务概述 2 1 目标 成绩管理系统实现以下功能 学生成绩管理 系统 成绩管理档 案 管 理课程管理系 统 管 理 成 绩 录 入 成 绩 查 询 院 系 专 业 设 置 课 程 设 置 选 课 管 理 院 系 专 业 查 询 院 系 专 业 查 询 院 系 专 业 查 询 口 令 更 改 重 新 登 录 操 作 员 管 理 数 据 备 份 数 据 恢 复 退 出 系 统 按 学 生 查 询 按 学 生 查 询 2 2 2 运行环境 1 软件环境 Windows 操作系统 Windows 95 98 Me 或 Windows NT4 0 2000 XP 2 硬件环境 最低配置 CPU 奔腾 100MHz 以上 内存 32MB 显卡 标准 VGA 16 色显示模式 建议配置 CPU 奔腾 166 MMX 以上 内存 64MB 以上 显卡 标准 VGA 24 位真彩色 其它 鼠标 3 语言支持 支持简体中文 繁体中文 英语 日语四种语言文字 其中英语可以在所有语言 Windows 平台上工作 将来会支持更多语言 2 3 条件与限制 2 3 1 常见问题 1 在将本项目软件编译生成可执行文件后 安装时应注意操作 防止死机 2 为了确保您正常的安装与使用 强烈建议您在安装学生管理系统软件前重启系 统后再安装 3 在 Windows95 98 NT 系统下安装学生管理系统时时 有时会出现 PBVM80 DLL 和 LIBJCC DLL 不存在 请检查安装路径或重新启动 的提示 产生这个问题 是由于您系统中的此文件版本过低 只要按照提示 重新启动计算机就可以了 4 本系统软件在未生成可执行文件前如果随意改变数据库的路径 再运行时便出 现数据库连接失败的情况 鉴于这一点 也可以说数据库的操作和管理是 PowerBuilder 应用程序的核心 数据库管理在应用程序开发的初级阶段是非 常关键的 经过不断摸索和研究 我们会渐渐地掌握 PowerBuilder 内置的桌 面管理系统 Adaptive Server Anywhere 简称 ASA 能够非常方便的建立 删除 和连接等一系列操作 3 数据描述 3 1 数据库描述 本系统利用 PowerBuilder 内置的桌面管理系统 Adaptive Server Anywhere 简称 ASA 建 立一个 score 数据库 其中包括 8 个数据表 分别是 院系表 department 专业表 major 教师档案表 teacher 学生档案表 student 课程设置表 course 学生 选课表 course sel 学生成绩表 score 操作员档案表 operator 3 2 数据字典 3 2 1 院系表 department 主键 department id 字段名字段名字段类型字段宽度 院系代码 Department idchar6 院系名称 Department namechar40 3 2 2 专业表 major 主键 major id 3 字段名字段名字段类型字段宽度 专业代码 Major idchar6 专业名称 Major namechar40 所属院系代码 Department idchar6 所属院系名称 Department namechar40 3 2 3 教师档案表 student 主键 student id 字段名字段名字段类型字段宽度 教师编号 Teacher idchar6 教师名称 Teacher namechar8 所属院系代码 Department idchar40 所属院系名称 Department namechar40 3 2 4 学生档案表 student 主键 student id 字段名字段名字段类型字段宽度 学号 Student idchar10 姓名 Student namechar12 性别 sexchar2 出生日期 Birthdaydate 格式 mm dd yyyy 民族 Nationchar10 政治面貌 Backgroundchar40 职务 Dutychar10 院系 Department namechar40 专业 Major namechar40 班级 Classchar4 籍贯 Hometownchar20 联系地址 Addresschar30 电话 Telephonechar20 状态 Statuschar6 不及格门数 Falurechar2 备注 Remarkchar30 3 2 5 课程设置表 course 主键 course id 字段名字段名字段类型字段宽度 课程代码 Course idchar10 课程名称 Course namechar40 学时 Periodnumeric4 0 学分 Creditnumeric2 0 类别 Kindchar6 教师编号 Teacher idchar6 教师姓名 Teacher namechar8 开课单位 Give unitchar40 开课时间 Give timechar6 选课范围 Limitchar20 内容简介 Contentchar40 备注 Remarkchar30 4 3 2 6 学生选课表 course sel 主键 student id 字段名字段名字段类型字段宽度 学号 Student idchar10 姓名 Student namechar8 课程代码 Course idchar10 课程名称 Course namechar40 学分 Creditnumeric2 0 3 2 7 学生成绩表 score 主键 student id 字段名字段名字段类型字段宽度 学号 Student idchar10 姓名 Student namechar8 课程代码 Course idchar10 课程名称 Course namechar40 学分 Creditnumeric2 0 成绩 Scorenumeric5 0 3 2 8 操作员档案表 operator 主键 operator id 字段名字段名字段类型字段宽度 操作员编号 Operator idchar4 操作员姓名 Operaor namechar8 密码 Passwordchar12 权限 Permissionchar20 4 功能需求 4 1 功能划分 本学生管理系统软件可以分成四大功能 1 学生的成绩管理 2 学生的档案管理 3 学生的课程管理 4 系统管理 4 2 功能描述 1 学生的成绩管理主要是管理员对学生成绩的查询 录入 打印 更新 删除 并 提交数据库保存 2 学生的档案管理是对学生个人档案进行查询 更新 删除以及对院系专业进行查 询 打印 更新等操作 3 学生的课程管理是对学生的选课信息 课程的设置进行的操作 4 系统管理主要包括管理员的管理 数据的备份与恢复等操作 5 运行需求 5 1 用户界面 学生管理系统的进入首先必须经过一个用户登录界面 要求用户输入编号和密码 经 系统验证是合法用户方可以进入系统主界面 系统的主界面是以最大方式打开的 并且有 较为优美的图片作为背景 使用户有一种舒畅的心情主界面以菜单的形式出现在用户面前 并且为了方便用户 主界面还有方便响应的图形工具栏 5 根据权限的不同 进入主界面后即可对学生成绩管理的各个模块进行操作 学生成绩管理系统的报表格式选用的是普通型的 可分为报表头 表体和页码三部分 报表的打印时间是以系统的时间为准 7 其它需求 本系统的安全性较好 在进入系统时必须输入操作员编号和密码 这两项必须都正确 方可进入系统 并且本系统设置一个操作员在进入系统后可以对数据进行更改 其他的用 户只可以进行查询 浏览 打印等操作 二 二 系统设计说明书系统设计说明书 1 数据流图 顶层数据流图 学生 成绩管理 系统 教学 管理 人员 学 生 系统时钟 成绩管理要求 成绩查询 学生情况 成绩录入 成绩报表 成绩档案等查询 成绩等情况 系统当前日期 7 1 有效性 检验 2 处理要 求 3 处理查 询 成绩管理要求 查询要求 非法的成绩管理要求 当前日期 无效输入 有效的查询要求 非法操作 退出系统 学生情况 选课情况 查询报表 0 层数据流图 2 1 要求类 型处理 2 2 成绩 录入 2 3 查询成 绩 2 4 修改成绩 密码等 2 5 选课 录入 成绩库 成绩管理要求 当前日期 成绩管理 选课 查询 选课 选课卡 一层数据流图 课程库 8 3 1 查询类 别处理 3 2 成绩 查询 3 3 分类 统计 3 4 按学号 统计 查询要求 学生档案库 统计要求 查询学生选课情况 查询学生情况 学生情况 选课统计报表 学生成绩库 课程库 一层数据流图 选课库 2 系统软件主要界面设计及有关功能说明 1 系统登录界面 用户必须正确输入编号和口令才能进入主界面 当用户输入系统中操 作员数据库中的编号然后按回车键 操作员姓名的文本框会自动显示其姓名 否则将出现 没找到 的提示 本系统只有一个教学管理员 编号为 1 口令为 0 而有许多一般用户 他们只能进行查询 打印 修改口令等操作 2 系统主界面 若是教学管理人员 他可以对系统进行所有的操作 若是一般的用户 进入主界面 可以看到主界面一部分是不可用的 3 实现对学生成绩的录入的界面 同时实现对学生成绩进行修改 删除 打印的功能 9 4 学生档案录入界面 完成对学生档案的添加 修改 保存及打印成绩报表等操作 5 实现对学生档案的录入的界面 同时实现对学生成绩进行修改 删除 打印的功能 6 实现对学生院系 专业的修改的界面 10 7 功能 完成学生院系专业的查询和打印 8 实现对学生课程的添加和修改的界面 12 9 实现对学生所选课程的添加 修改和保存的界面 同时选课可以有按学生和按科目两 种 10 操作员管理界面 功能 完成对操作员的信息进行管理的操作 11 成绩查询界面 完成对学生的成绩进行查询 可以根据学生查询和课程查询 按学 生查询是可以显示所查学生的平均成绩 最高成绩 并且不及格的学生成绩是用红色显示 出来的 13 12 学生档案的查询 完成对学生档案的查询 三 测试计划三 测试计划 1 任务概述 1 1 测试目标 以最少的时间和人力系统去找出软件潜在的各种错误和缺陷 1 2 运行环境 1 软件环境 Windows 操作系统 Windows 95 98 Me 或 Windows NT4 0 2000 XP 并装有 PowerBuilder8 0 装有打印机等外部设备 2 硬件环境 最低配置 CPU 奔腾 100MHz 以上 内存 32MB 显卡 标准 VGA 16 色显示模式 建议配置 CPU 奔腾 166 MMX 以上 内存 64MB 以上 显卡 标准 VGA 24 位真彩色 其它 鼠标 3 语言支持 支持简体中文 繁体中文 英语 日语四种语言文字 其中英语可以在所有语言 Windows 平台上工作 将来会支持更多语言 14 2 测试计划 2 1 测试方案 2 1 1 白盒测试 测试用例设计 利用条件组合覆盖 可以将系统划为四大功能模块如下图 从图中可以看出若干个分支 对于每一个判断 要求所有的可能条件的取值的组合都 必须取到 2 1 2 黑盒测试 测试用例设计 因果图测试 下面是关于用户登录等的因果图 1 打开登录界面 21 等待用户输入 2 输入编号22 提示没有找到 3 输入密码23 提示密码错误 4 编号错误24 提示请重新输入 5 编号密码都错误25 输入正确的编号 和密码 原因 6 输入都正确 结果 26 成功进入系统 打开登录界面 21 等待用户输入 入正确编号 22 提示没有找到 输入正确密码 E 23 提示密码错误 编号错误 24 提示请重新输入 编号密码都错误 25 输入正确的编号和密码 输入都正确 26 成功进入系统 3 测试工作总体流程图 学生成绩管理系统 系统管理 成绩管理 档案管理 课程管理 登录 合法 用户 操作操作 员库员库 操作 退出 添加 删除 修 改等操作 添加 删除 查 询等操作 添加 删除 修 改等操作 数据备份 恢复 口令更改等操作 正 确 密 码 错 误 16 四 测试分析报告四 测试分析报告 1 测试计划执行情况 一个成功测试的标准可以表示为缺陷在上述优先级上所应体现的分布方式 例如 对 于一个成功的测试标准来说 可能不存在优先级为 1 的打开的缺陷 而且优先级为 2 的 打开的缺陷要少于 5 个 例如下面的缺陷分布图 很明显该图显示的情况没有达到标准 请注意 该图需要通过过滤器才能只显示需要 的打开的缺陷 17 缺陷状态与严重性 缺陷严重性报告显示每种严重性级别的缺陷个数 例如致命错误 未执行主要功能 次要错误等严重性级别 缺陷状态与在实施模型中的位置 缺陷起源报告显示缺陷在实施模型元素上的分布情况 缺陷龄期报告 缺陷龄期分析提供了有关测试有效性和缺陷排除活动的良好反馈 例如 如果大部分 龄期较长的 未解决的缺陷处于有待确认的状态 则可能表明没有充足的资源应用于再次 测试工作 缺陷趋势报告 趋势报告确定缺陷率并提供了一个出色的测试状态视图 在测试生命周期中 缺陷趋 势遵循着一种比较好预测的模式 在生命周期的初期 缺陷率增长很快 在达到顶峰后 就随时间以较慢的速率下降 要发现问题 可以根据这一趋势复审项目时间表 例如 在四个星期的生命周期中 如果缺陷率在第三个星期中仍然增长 则项目很明显没有按时间表进行 这一简单的趋势分析假定 缺陷是立即关闭的 且在随后的工作版本中对修复进行测 试 这样关闭缺陷的速率应该遵循与打开缺陷的速率相同的增减趋势 如果情况并非如此 则表明缺陷解决流程发生了问题 缺陷修复所需的资源或再次测试和确认修复所需的资源 可能不足 2 评价测试的主要评测方法 18 动态监测 动态监测通常以柱状图或曲线图的形式提供实时显示 报告 该报告用于在测试执行过 程中 通过显示当前的情况 状态以及测试脚本正在执行的进度来监测或评估性能测试执 行情况 例如 在以上柱状图中 有 80 个测试脚本正在执行相同的用例 图中显示 有 14 个测试脚本处于空闲状态 12 个处于查询状态 34 个处于 SQL 执行状态 4 个处于 SQL 连接状态 16 个处于其他状态 随着测试的进行 我们将看到各状态脚本的数量会 发生变化 显示的输出将是正常执行且正在执行中的典型测试执行 但是 如果在测试执 行过程中 测试脚本始终保持一种状态或没有显示任何变化 则表明测试执行发生问题或 者需要实施或执行其他性能评测 响应时间 吞吐量报告 正如其名称的含义一样 响应时间 吞吐量报告评测并计算与时间和 或吞吐量 处理的 事务数 相关的性能行为 这些报告通常用曲线图显示 响应时间 或事务数 y 轴上 而事件数在 x 轴上 19 除了显示实际的性能行为外 它在计算并显示统计信息方面也很实用 如显示数据值 的平均偏差和标准偏差 当性能行为可以接受时 或性能监测表明存在可能的瓶颈时 如当测试脚本保持给定 状态的时间过长 追踪报告可能是最有价值的报告 追踪和配置文件报告显示低级信息 该信息包括主角与测试对象之间的消息 执行流 数据访问以及函数和系统调用 该报告反映的趋势显示 在项目开始时 发现和打开新缺陷的速率很快 但随着时间 推移 该速率不断降低 打开的缺陷的趋势与新缺陷的趋势相似 但稍微滞后一些 关闭 的缺陷的趋势随着打开的缺陷的修复和核实而不断增长 这些趋势描述的是成功的工作 五 程序维护手册五 程序维护手册 1 引言 1 1 编写目的 本系统维护手册适用于系统管理员和一般用户 1 2 项目背景 项目提出者 安徽农业大学教务处 开发者 自由软件开发室 用户 安徽农业大学教务处成绩管理员和一般学生 只可以查询 场所 假定在学校的计算中心有功能强大的工作站机器 在各系 各部门 图书馆 学生宿舍都有台式 PC 机 学校的全部计算机已经连网 那么本项目软件将采用客户机 服 务器结构建立 学生成绩管理系统的应用服务器和数据库服务器设置在学校计算中心的工 作站 学生 教师和教学管理人员可以在各系 各部门 图书馆 学生宿舍的台式机上使 用学生成绩管理系统 2 系统说明 2 1 系统用途 1 完成数据的录入和修改 并提交数据库保存 其中包括 院系及专业设置 课程 20 设置 学生档案 学生成绩 选课记录以及操作员档案等 2 实现信息查询 如学生成绩查询 学生档案查询等 3 信息具有一定的安全性 如只有一定的权限 才能进行数据的录入和修改 故需 要对操作员的权限进行设置 并设置密码 4 具有数据备份和数据恢复的功能 2 2 安全保密 本系统的安全性较好 在进入系统时必须输入操作员编号和密码 这两项必须都正确 方可进入系统 并且本系统设置一个操作员在进入系统后可以对数据进行更改 其他的用 户只可以进行查询 浏览 打印等操作 3 操作环境 3 1 设备 在学校的计算中心有功能强大的工作站机器 在各系 各部门