用户手册(GB8567——88)
1引言
1.1编写目的
说明编写这份用户手册的目的,指出预期的读者。
本手册的目的在于告诉机房收费系统的使用者,本系统提供了那些功能,以及如何正确地、有效地来使用这些功能。
预期读者:机房收费系统的用户
1.2背景
说明:
a. 这份用户手册所描述的软件系统的名称;
b. 该软件项目的任务提出者、开发者、用户(或首批用户)及安装此软件的计算中心。
1、待开发软件名称:机房收费系统
2、项目提出者:米新江老师
3、开发者:李富超
4、用户:廊坊师范学院全体教职工和学生
5、实现该软件的计算中心或计算机网络:廊坊师范学院局域网
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
姓名(Name)
卡号(CardNO)
班级(Class)
教师(Teachers)
上机(Online)
下机(Outline)
时间(Time)
余额(cash)
退卡(Backof the card)
充值(Recharge)
结账(Checkout)
1.4参考资料
列出有用的参考资料,如:
a. 项目的经核准的计划任务书或合同、上级机关的批文;
b. 属于本项目的其他已发表文件;
c. 本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够取得这些文件资料的来源。
《软件工程导论》 张海藩 编著
2用途
2.1功能
结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。
本软件共有三大模块:管理模块、信息设定模块、财务模块。共有3中不同的权限,一般用户、操作员、管理员;根据权限的不同,用户能够使用不同的功能。
1、一般用户:学生查看余额,学生查看上机记录,学生充值记录,学生上机状态查看,修改密码,退出。
2、操作员:注册,充值、退卡,收取金额查询,金额退还信息查询,学生基本信息维护,学生上机统计信息查询,操作员工作记录。
3、管理员:结账,添加删除用户,基本数据设定,正在值班教师,日结账单,周结账单
2.2性能
2.2.1精度
逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度,包括传输中的精度要求。
软件的输入精度:小数点后保留一位有效数字
输出数据的精度:小数点后保留一位有效数字
传输过程中的精度:小数点后保留一位有效数字
2.2.2时间特性
定量地说明本软件的时间特性,如响应时间,更新处理时间,数据传输、转换时间,计算时间等。
响应时间:0.5s内
更新处理时间:0.5s内
数据的更换和传送时间:1s内
2.2.3灵活性
说明本软件所具有的灵活性,即当用户需求(如对操作方式、运行环境、结果精度、时间特性等的要求)有某些变化时,本软件的适应能力。
a. 运行环境的变化:该软件适用于现在流行的造作系操统
b. 精度和有效时限的变化:因不同情况而定
c. 计划的变化和改进:根据用户的需求随时对软件做必要的升级和更新
2.3安全保密
说明本软件在安全、保密方面的设计考虑和实际达到的能力。
本系统在进入系统前要判别用户的权限,只有具有相应权限,并且在密码和用户名都正确的条件下用户才能进入相应的子系统然后进行相应的操作,如:一般用户只有简单的上下机功能和对学生信息的查询功能。
3运行环境
3.1硬设备
列出为运行本软件所要求的硬设备的最小配置,如:
a. 处理机的型号、内存容量;
b. 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机;
c. I/O设备(联机/脱机?);
d. 数据传输设备和转换设备的型号、台数。
A.server要求内存256以上,cpu 2.0GHz以上
B.Clinet内存128以上,cpu奔腾III以上,最大可支持20台分机同时连接到主机上
3.2支持软件
说明为运行本软件所需要的支持软件,如:
a. 操作系统的名称、版本号;
b. 程序语言的编译/汇编系统的名称和版本号;
c. 数据库管理系统的名称和版本号;
d. 其他支持软件。
操作系统:windowsxp以上操作系统
数据库管理系统:sqlserver2014
3.3数据结构
列出为支持本软件的运行所需要的数据库或数据文卷。
本系统以MicrosoftSQL Server 2014作为后台数据库管理系统,其中所需要的数据表有:
操作员工作日志记录(Worklog_Info)
管理员信息(User_Info)
学生基本信息(Student_Info)
充值记录(ReCharge_Info)
学生上机记录(Online_Info)
周结账单(CheckWeek_Info)
日结账单(CheckDay_Info)
退卡表(CancelCard_Info)
基本数据设定表(BasicData_Info)
4使用过程
在本章,首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。
4.1安装与初始化
一步一步地说明为使用本软件而需进行的安装与初始化过程,包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。
该系统是基于C/S模式的,设置简单安装方便,不需要任何辅助安装软件。先在服务器上安装好SQL然后设置好DNS,再将系统客户机上安装后即可使用。
4.2输入
规定输入数据和参量的准备要求。
4.2.1输入数据的现实背景
说明输入数据的现实背景,主要是
a. 情况——例如人员变动、库存缺货;
b. 情况出现的频度——例如是周期性的、随机的、一项操作状态的函数;
c. 情况来源—一例如人事部门、仓库管理部门;
d. 输入媒体———例如键盘、穿孔卡片、磁带;
e. 限制——出于安全、保密考虑而对访问这些输入数据所加的限制;
f. 质量管理——例如对输入数据合理性的检验以及当输入数据有错误时应采取的措施,如建立出错情况的记录等;
g. 支配——例如如何确定输入数据是保留还是废弃,是否要分配给其他的接受者等。
首先管理员、操作员、一般用户根据各自的权限及用户名和密码进入系统,学生通过注册成为一般用户后登陆该系统能获得相应的权限。
学生的注册由操作员手工录入完成
4.2.2输入格式
说明对初始输入数据和参量的格式要求,包括语法规则和有关约定,如:
a. 长度—一例如字符数/行,字符数/项;
b. 格式基准——例如以左面的边沿为基准;
c. 标号——例如标记或标识符;
d. 顺序——例如各个数据项的次序及位置;
e. 标点——例如用来表示行、数据组等的开始或结束而使用的空格、斜线、星号、字符组等。
f. 词汇表——给出允许使用的字符组合的列表,禁止使用*的字符组合的列表等;
g. 省略和重复——给出用来表示输人元素可省略或重复的表示方式;
h. 控制——给出用来表示输入开始或结束的控制信息。
4.2.3输入举例
为每个完整的输入形式提供样本,包括:
a. 控制或首部——例如用来表示输入的种类和类型的信息,标识符输入日期,正文起点和对所用编码的规定;
b. 主体——输入数据的主体,包括数据文卷的输入表述部分;
c. 尾部——用来表示输入结束的控制信息,累计字符总数等;
d. 省略——指出哪些输入数据是可省略的;
e. 重复——指出哪些输入数据是重复的。
账号:1
密码:1
用户姓名:lfc
4.3输出对每项输出作出说明
4.3.1输出数据的现实背景
说明输出数据的现实背景,主要是:
a. 使用——这些输出数据是给谁的,用来干什么;
b. 使用频度——例如每周的、定期的或备查阅的;
c. 媒体——打印、CRI显示、磁带、卡片、磁盘,
d. 质量管理—一例如关于合理性检验、出错纠正的规定;
e. 支配——例如如何确定输出数据是保留还是废弃,是否要分配给其他接受者等。
数据的输出需要用户提交系统命令后才执行。
4.3.2输出格式
给出对每一类输出信息的解释,主要是:
a. 首部——如输出数据的标识符,输出日期和输出编号;
b. 主体——输出信息的主体,包括分栏标题;
c. 尾部——包括累计总数,结束标记。
1、对应从系统中输出要查询的结果。
2、用户输入的内容不合法,系统会弹框提示。
3、导出到Excel和各种报表的输出。
4.3.3输出举例
为每种输出类型提供例子。对例子中的每一项,说明:
a. 定义——每项输出信息的意义和用途;
b. 来源——是从特定的输入中抽出、从数据库文卷中取出、或从软件的计算过程中得到;
c. 特性——输出的值域、计量单位、在什么情况下可缺省等。
1)充值提示:
充值卡号,上次卡内余额,现在卡内余额,充值日期,充值时间,充值教师。
2)账单查询:
查询结果显示:查询卡号,充值金额,充值日期,时间,教师及结账状态
4.4文卷查询
这一条的编写针对具有查询能力的软件,内容包括:同数据库查询有关的初始化、准备、及处理所需要的详细规定,说明查询的能力、方式,所使用的命令和所要求的控制规定。
无
4.5出错处理和恢复
列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力,用户必须遵循的处理过程。
软件问题:软件可能出现兼容性问题,可与开发公司联系。
硬件问题:由于机房断电、磁盘损坏、病毒入侵等造成的数据损坏,可联系开发人员,进行专业的数据恢复和系统修复
4.6终端操作
当软件是在多终端系统上工作时,应编写本条,以说明终端的配置安排、连接步释、数据和参数输入步骤以及控制规定.说明通过终端操作进行查询、检索、修改数据文卷的能力、语言、过程以及辅助性程序等。
无