软件产品开发文档规格说明指导书.doc

例：软件产品开发文档
一、 需求规格说明书
1.引言
1.1编写目标
在软件项目开发过程早期，用户对本身需求也仅仅有一个模糊概念需求分析目标就是把这个概念具体化，并在用户和开发人员之间达成共识，包含对用户需求全方面了解
和分析、筛选，明确所要开发软件项目标职责界限、并进行可行性研究和指定资源、进度预算等。
1.2项目背景
本项目标委托单位为安徽农业大学教务处，开发单位为自由软件开发室，主管部门为自由软件开发室项目经理部。伴随高等教育改革和高校不停扩招，传统教学管理方法已远远不能满足高等教育发展，高等教育发展也使传统教学管理方法日益被淘汰，这么以来，一批精明软件开发商开发了基于局部网络（校园网）和数据库应用系统。大多情况下，这些系统是以用户机/服务器结构分布式系统，它关键教学管理系统和数据库放置在学校中心计算机上，用户接口端应用程序分别配置在图书馆、专业系、和学生宿舍用户机上.
2.任务概述
2.1目标
成绩管理系统实现以下功效：

学生成绩管理系统

档 案 管 理
成绩管理
系 统 管 理
课程管理

退出系统

数据恢复

数据备份
操作员管理

重新登录

口令更改
院系专业查询

成绩查询

成绩录入
院系专业查询
院系专业查询
院系专业设置

选课管理

课程设置
按学生查询
按学生查询

2.2 运行环境
（1） 软件环境
Windows操作系统：Windows 95/98/Me或Windows NT4.0//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_id
char
6
院系名称
Department_name
char
40
3.2.2专业表（major）主键：major_id
字段名
字段名
字段类型
字段宽度
专业代码
Major_id
char
6
专业名称
Major_name
char
40
所属院系代码
Department_id
char
6
所属院系名称
Department_name
char
40
3.2.3老师档案表（student）主键：student_id
字段名
字段名
字段类型
字段宽度
老师编号
Teacher_id
char
6
老师名称
Teacher_name
char
8
所属院系代码
Department_id
char
40
所属院系名称
Department_name
char
40
3.2.4学生档案表（student）主键：student_id
字段名
字段名
字段类型
字段宽度
学号
Student_id
char
10
姓名
Student_name
char
12
性别
sex
char
2
出生日期
Birthday
date
格式:mm/dd/yyyy
民族
Nation
char
10
政治面貌
Background
char
40
职务
Duty
char
10
院系
Department_name
char
40
专业
Major_name
char
40
班级
Class
char
4
籍贯
Hometown
char
20
联络地址
Address
char
30
电话
Telephone
char
20
状态
Status
char
6
不及格门数
Falure
char
2
备注
Remark
char
30
3.2.5课程设置表（course）主键：course_id
字段名
字段名
字段类型
字段宽度
课程代码
Course_id
char
10
课程名称
Course_name
char
40
课时
Period
numeric
4,0
学分
Credit
numeric
2,0
类别
Kind
char
6
老师编号
Teacher_id
char
6
老师姓名
Teacher_name
char
8
开课单位
Give_unit
char
40
开课时间
Give_time
char
6
选课范围
Limit
char
20
内容介绍
Content
char
40
备注
Remark
char
30

3.2.6学生选课表（course_sel）主键：student_id
字段名
字段名
字段类型
字段宽度
学号
Student_id
char
10
姓名
Student_name
char
8
课程代码
Course_id
char
10
课程名称
Course_name
char
40
学分
Credit
numeric
2,0
3.2.7学生成绩表（score）主键：student_id
字段名
字段名
字段类型
字段宽度
学号
Student_id
char
10
姓名
Student_name
char
8
课程代码
Course_id
char
10
课程名称
Course_name
char
40
学分
Credit
numeric
2,0
成绩
Score
numeric
5,0
3.2.8操作员档案表（operator）主键：operator_id
字段名
字段名
字段类型
字段宽度
操作员编号
Operator_id
char
4
操作员姓名
Operaor_name
char
8
密码
Password
char
12
权限
Permission
char
20

4.功效需求
4.1功效划分
本学生管理系统软件能够分成四大功效：
（1）学生成绩管理
（2）学生档案管理
（3）学生课程管理
（4）系统管理
4.2功效描述
（1）学生成绩管理关键是管理员对学生成绩查询、录入、打印、更新、删除、并提交数据库保留。
（2）学生档案管理是对学生个人档案进行查询、更新、删除和对院系专业进行查询、打印、更新等操作。
（3）学生课程管理是对学生选课信息、课程设置进行操作。
（4）系统管理关键包含管理员管理、数据备份和恢复等操作。
5.运行需求
5.1用户界面
学生管理系统进入首先必需经过一个用户登录界面，要求用户输入编号和密码，经系统验证是正当用户方能够进入系统主界面，系统主界面是以最大方法打开，而且有较为优美图片作为背景，使用户有一个舒畅心情主界面以菜单形式出现在用户面前，而且为了方便用户，主界面还有方便响应图形工具栏。
依据权限不一样，进入主界面后即可对学生成绩管理各个模块进行操作。
学生成绩管理系统报表格式选择是一般型，可分为报表头，表体和页码三部分，报表打印时间是以系统时间为准。
7.其它需求
本系统安全性很好，在进入系统时必需输入操作员编号和密码，这两项必需全部正确，方可进入系统，而且本系统设置一个操作员在进入系统后能够对数据进行更改，其它用户只能够进行查询、浏览、打印等操作。
二、 系统设计说明书
1.数据流图
成绩管理要求
学 生

教学管理人员
成绩档案等查询

成绩等情况
成绩查询

学生
成绩管理系统

成绩录入

成绩报表

系统目前日期

学生情况
系统时钟

顶层数据流图

2.系统软件关键界面设计及相关功效说明
（1）系统登录界面。用户必需正确输入编号和口令才能进入主界面，当用户输入系统中操作员数据库中编号然后按回车键，操作员姓名文本框会自动显示其姓名，不然将出现“没找到”提醒。本系统只有一个教学管理员，编号为1，口令为0，而有很多通常见户，她们只能进行查询、打印、修改口令等操作。

（2）系统主界面。若是教学管理人员，她能够对系统进行全部操作，若是通常用户，进入主界面 ，能够看到主界面一部分是不可用。

（3）实现对学生成绩录入界面，同时实现对学生成绩进行修改、删除、打印功效。

（4）学生档案录入界面。完成对学生档案添加、修改、保留及打印成绩报表等操作 。

（5）实现对学生档案录入界面。同时实现对学生成绩进行修改、删除、打印功效

（6）实现对学生院系、专业修改界面

（7）功效：完成学生院系专业查询和打印。

（8）实现对学生课程添加和修改界面。

（9）实现对学生所选课程添加、修改和保留界面。同时选课能够有按学生和按科目两种。

（10）操作员管理界面。功效：完成对操作员信息进行管理操作。

（11）成绩查询界面。完成对学生成绩进行查询，能够依据学生查询和课程查询。按学生查询是能够显示所查学生平均成绩、最高成绩，而且不及格学生成绩是用红色显示出来。

（12）学生档案查询。完成对学生档案查询。

三、测试计划
1． 任务概述
1. 1测试目标
以最少时间和人力系统去找出软件潜在多种错误和缺点。
1. 2运行环境
（1） 软件环境
Windows操作系统：Windows 95/98/Me或Windows NT4.0//XP，并装有PowerBuilder8.0,装有打印机等外部设备。
（2）硬件环境
最低配置：
· CPU：飞跃100MHz以上
· 内存：32MB
· 显卡：标准VGA，16色显示模式
提议配置：
· CPU：飞跃166 MMX以上
· 内存：64MB以上
· 显卡：标准VGA，24位真彩色
· 其它：鼠标
（3）语言支持
支持简体汉字、繁体汉字、英语、日语四种语言文字，其中英语能够在全部语言Windows平台上工作。未来会支持更多语言。

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.测试工作总体步骤图

四、测试分析汇报
1. 测试计划实施情况
一个成功测试标准能够表示为缺点在上述优先级上所应表现分布方法。比如，对于一个成功测试标准来说，可能不存在优先级为 1 打开缺点，而且优先级为 2 打开缺点要少于 5 个。例以下面缺点分布图：

很显著该图显示情况没有达成标准。请注意，该图需要经过过滤器才能只显示需要打开缺点。
缺点状态和严重性
　　缺点严重性汇报显示每种严重性等级缺点个数，比如致命错误、未实施关键功效、次要错误等严重性等级。
缺点状态和在实施模型中位置
　　缺点起源汇报显示缺点在实施模型元素上分布情况。
缺点龄期汇报
　　缺点龄期分析提供了相关测试有效性和缺点排除活动良好反馈。比如，假如大部分龄期较长、未处理缺点处于有待确定状态，则可能表明没有充足资源应用于再次测试工作。
缺点趋势汇报
　　趋势汇报确定缺点率并提供了一个出色测试状态视图。在测试生命周期中，缺点趋势遵照着一个比很好估计模式。在生命周期早期，缺点率增加很快。在达成顶峰后，就随时间以较慢速率下降。

要发觉问题，能够依据这一趋势复审项目时间表。比如，在四个星期生命周期中，假如缺点率在第三个星期中仍然增加，则项目很显著没有按时间表进行。
　　这一简单趋势分析假定：缺点是立即关闭，且在随即工作版本中对修复进行测试，这么关闭缺点速率应该遵照和打开缺点速率相同增减趋势。假如情况并非如此，则表明缺点处理步骤发生了问题；缺点修复所需资源或再次测试和确定修复所需资源可能不足。

2. 评价测试关键评测方法
动态监测
　　动态监测通常以柱状图或曲线图形式提供实时显示/汇报。该汇报用于在测试实施过程中，经过显示目前情况、状态和测试脚本正在实施进度来监测或评定性能测试实施情况。

比如，在以上柱状图中，有 80 个测试脚本正在实施相同用例。图中显示，有 14 个测试脚本处于空闲状态，12 个处于查询状态，34 个处于 SQL 实施状态，4 个处于 SQL 连接状态，16 个处于其它状态。伴随测试进行，我们将看到各状态脚本数量会发生改变。显示输出将是正常实施且正在实施中经典测试实施。不过，假如在测试实施过程中，测试脚本一直保持一个状态或没有显示任何改变，则表明测试实施发生问题或需要实施或实施其它性能评测。
响应时间/吞吐量汇报
　　正如其名称含义一样，响应时间/吞吐量汇报评测并计算和时间和/或吞吐量（处理事务数）相关性能行为。这些汇报通常见曲线图显示，响应时间（或事务数）"y"轴上，而事件数在"x"轴上。

除了显示实际性能行为外，它在计算并显示统计信息方面也很实用，如显示数据值平均偏差和标准偏差。
当性能行为能够接收时，或性能监测表明存在可能瓶颈时（如当测试脚本保持给定状态时间过长），追踪汇报可能是最有价值汇报。追踪和配置文件汇报显示低级信息。该信息包含主角和测试对象之间消息、实施流、数据访问和函数和系统调用。
该汇报反应趋势显示，在项目开始时，发觉和打开新缺点速率很快，但伴随时间推移，该速率不停降低。打开缺点趋势和新缺点趋势相同，但稍微滞后部分。关闭缺点趋势伴随打开缺点修复和核实而不停增加。这些趋势描述是成功工作。

五、程序维护手册
1. 引言
1.1编写目标
本系统维护手册适适用于系统管理员和通常见户。
1.2项目背景
项目提出者：安徽农业大学教务处
开发者：自由软件开发室
用户：安徽农业大学教务处成绩管理员和通常学生（只能够查询）
场所：假定在学校计算中心有功效强大工作站机器，在各系、各部门、图书馆、学生宿舍全部有台式PC机，学校全部计算机已经连网。那么本项目软件将采取用户机/服务器结构建立，学生成绩管理系统应用服务器和数据库服务器设置在学校计算中心工作站。学生、老师和教学管理人员能够在各系、各部门、图书馆、学生宿舍台式机上使用学生成绩管理系统。
2. 系统说明
2.1系统用途：
（1）完成数据录入和修改，并提交数据库保留。其中包含：院系及专业设置、课程设置、学生档案、学生成绩、选课统计和操作员档案等。
（2）实现信息查询。如学生成绩查询、学生档案查询等。
（3）信息含有一定安全性，如只有一定权限，才能进行数据录入和修改。故需要对操作员权限进行设置，并设置密码。
（4）含有数据备份和数据恢复功效。
2.2安全保密
本系统安全性很好，在进入系统时必需输入操作员编号和密码，这两项必需全部正确，方可进入系统，而且本系统设置一个操作员在进入系统后能够对数据进行更改，其它用户只能够进行查询、浏览、打印等操作。
3. 操作环境
3.1设备
在学校计算中心有功效强大工作站机器，在各系、各部门、图书馆、学生宿舍全部有台式PC机，学校全部计算机已经连网。本项目软件采取是用户机/服务器结构建立，学生成绩管理系统应用服务器和数据库服务器设置在学校计算中心工作站。学生、老师和教学管理人员能够在各系、各部门、图书馆、学生宿舍台式机上使用学生成绩管理系统。
3.2数据库
因为本学生管理系统是用PowerBuilder开发，PowerBuilder提供了ODBC接口，它能够用统一方法处理不一样数据源，减轻了学习新系统压力。现在除了Oracle、Sybase、Microsoft SQL、IBM DB2等大型数据库管理系统支持OCBC接口外，诸如dBase、FoxPro、ASA、Excel之类数据源也支持ODBC接口。
本系统利用PowerBuilder内置桌面管理系统Adaptive Server Anywhere(简称ASA)建立一个score数据库，其中包含8个数据表，分别是：院系表（department）、专业表（major）、老师档案表（teacher）、学生档案表（student）课程设置表（course）、学生选课表（course_sel）、学生成绩表（score）、操作员档案表（operator）。
结束语：至此一个用PowerBuilder开发项目学生成绩管理系统已经完成了，然而要用PowerBuilder开发一个优异应用程序，还要一个逐步实践、逐步积累经验过程。
软件工程作为一门年轻学科，尽管其中也包含了大量理论内容，但它含有一个显著特点是实践性。软件学科实践性不仅表现在，它形成和发展得益于软件工程项目标推进，或说，是大家在软件开发实践中碰壁以后为寻求“软件危机”出路而总结出标准和方法；而且它实践性还表现在对于软件开发项目标实际指导作用
限于水平有限 ，时间仓促，课程设计中难免有不妥之处，敬请老师提出宝贵意见！