用户操作手册模版.docx
《用户操作手册模版.docx》由会员分享，可在线阅读，更多相关《用户操作手册模版.docx（15页珍藏版）》请在冰豆网上搜索。
用户操作手册模版
软件文档写作实践五
全国铁路查询系统
用户操作手册
[V1.0（版本号）]
拟制人蒋爱玲
班级08计科S1
组号5
同组人黄栩洁韩宇
柏金金顾春华
[2009年5月27日]
目录
一引言2
1.1编写目的2
1.2项目背景2
1.3定义2
1.4参考资料3
二．软件概述3
2.1目标3
2.2功能3
2.2.1管理端3
2.2.2客户端4
2.3性能4
2.3.1数据精确度4
2.3.2时间特性4
2.3.3灵活性4
三．运行环境4
3.1硬件4
3.2支持软件5
四．使用说明5
4.1安装和初始化5
4.2输入5
4.2.1数据背景5
4.2.2数据格式5
4.2.3输入举例6
4.3输出7
4.3.1数据背景7
4.3.2数据格式7
4.3.3输出举例8
4.4出错和恢复8
4.4.1出错信息及其含义8
4.4.2用户应采取措施8
4.5求助查询8
五．运行说明9
5.1运行表9
5.2运行步骤9
5.2.1运行控制9
5.2.2操作信息10
5.2.3输入/输出文件10
5.2.4启动或恢复过程10
六．非常规过程10
七．操作命令一览表11
八．程序文件和数据文件一览表11
九．用户操作举例11
一引言
1.1编写目的
本软件经过一定规划与测试，在市场上出售，为了让用户在第一次使用时可以很快上手操作，特地编写此用户操作手册，为用户提供便利，解决在使用本软件时碰到的一系列疑问。
读者对象：
使用本软件的所有用户。
1.2项目背景
随着现在社会的发展，人们外出的机会越来越多，这时交通工具的选择就显得尤其重要。
有些人会选择坐飞机，但是，飞机对于大多数的人来说是一笔比较贵的费用。
对于大多数人来说，铁路交通是第一选择。
至此，人们对铁路的需求也越来越大。
因此，建立一个铁路查询系统是破在眉睫的事。
而且，随着信息化的进步，计算机应用于各个领域。
建立健全信息维护机制，及时更新完善相应的信息库，确保信息库资源完整、准确、规范，做到随时需要、随时统计、随时提供，逐步实现考勤管理的实时话、人性化、合理化。
铁路交通查询系统是一种信息查询系统，它主要包括了后台数据库的建立和维护，以及前端程序的应用开发两个方面。
对于后台数据库的建立和维护，要求数据的一致性、完整性和安全性。
对于前端程序的应用开发，则要求功能完备，使用简单等功能。
本系统尽可能为用户提供充足的信息和快捷方便的查询。
使用计算机网络对铁路交通信息进行查询，比人工查询要优化。
比如：
检索迅速，查找方便，可靠性强，存储量大。
委托单位：
上海第二工业大学；
开发单位：
203工作室；
主管部门：
203工作室。
1.3定义
全国铁路查询系统：
对铁路交通信息进行查询的计算机软件程序。
定义关键词如下：
B/S：
服务器浏览器模式
JDBC：
JAVADataBaseConnectivity（JAVA数据库连接）
Webbrowser：
网络浏览器
HTTP：
HyperTextTransferProtocol（超文本传输协议）
HTML：
HyperTextMarkupLanguage（超文本标记语言）
IPO：
——Input&Process&Output（输入、处理、输出）
1.4参考资料
《“全国铁路查询系统”软件项目可行性报告》
——203工作室编著
《“全国铁路查询系统”软件项目计划》
——203工作室编著
《“全国铁路查询系统”需求规格说明书》
——203工作室编著
《“全国铁路查询系统”概要设计说明书》
——203工作室编著
《软件工程》----张海藩编著
——人民邮电出版社
《实用软件文档写作》----肖刚古辉等著
——清华大学出版社
二．软件概述
2.1目标
为了能更方便、快捷的了解铁路交通的信息，开发的查询软件能为出行的人们提供方便。
本软件作到，信息更新快，铁路交通信息覆盖广阔，到达人性化的需求。
通过此查询软件实现自动化、流程化、标准化的运维体系，系统性能稳定，方便使用，易学易用，信息和国家铁路局同步。
2.2功能
2.2.1管理端
1、交通线路信息查询模块
编号
输入
处理
输出
1
起始地点
查询：
交通信息列表
输出符合条件的交通线路
2
目的地点
查询：
交通信息列表
输出符合条件的交通线路
2、交通线路信息查询模块
编号
输入
处理
输出
1
交通线路信息
修改：
交通信息列表
输出交通线路列表数据
3、添加交通信息模块
编号
输入
处理
输出
1
交通线路信息
修改：
交通信息列表
输出交通线路列表数据
2.2.2客户端
1.信息查询模块
编号
输入
处理
输出
1
起始地点、目的地点
查询：
交通信息列表
输出符合条件的交通线路
2.3性能
2.3.1数据精确度
本系统的数据信息与全国铁路交通局发布的铁路信息同步。
而且，本系统能作到对信息的及时的更新，所以，本系统的数据信息精确度是可以得到保证的。
2.3.2时间特性
系统正常情况下，保证查询等快速响应时间在5秒以内。
2.3.3灵活性
系统具有灵活的操作方式，既可以使用鼠标，也可以键盘操作。
系统必须有良好的可扩展性，以适应新的查询方式、新的线路开通等方面的更新扩展（比如同一其始点和目的地增加了一趟新的列车）。
三．运行环境
3.1硬件
软件系统运行时所需的硬件最小配置：
（1）计算机型号：
不限；主存容量：
256MB。
（2）外存储器：
不限；媒体：
带网络的计算机；
记录格式：
文本表格；设备型号：
不限；数量：
不限。
3.2支持软件
（1）操作系统名称：
win98、win2000、winxp、vista。
（2）语言编译系统或汇编系统的名称：
VC、VB、JAVA、C#。
（3）数据库管理系统的名称：
SQL，ACCESS。
四．使用说明
4.1安装和初始化
在产品包装盒中取出光盘后，读取光盘，直接双击
，就可以运行本软件了，无需安装，直接打开就可以用，极其方便。
4.2输入
4.2.1数据背景
数据来源：
用户
存储媒体：
网络硬盘
出现频率：
不限
限制：
中国国内地名
质量管理：
如果输入不合法，系统将提示
4.2.2数据格式
1长度：
2个字节以上（可以输入中文，可以输入地名首字母）
2格式基准：
char（字符）
3标号：
无
4顺序：
从左至右输入起点与终点。
5分隔符：
无
6词汇表：
只限字符
7省略和重复：
输入时可以简单输入地名首字母。
例：
要输入“上海”，可以只输入“sh”。
8控制：
输入开始即输入起点与终点的地名或车次。
输入结束即按“查询”按钮
4.2.3输入举例
第一步：
输入起点站名。
（例：
上海）
第二步：
输入终点站名。
（例：
温州）
第三步：
选择火车类型
第四步：
按“查询”按钮提交
第五步：
显示结果
4.3输出
4.3.1数据背景
输出数据的去向：
显示给用户
使用频率：
不限
存放媒体：
打印、显示屏、磁盘
质量管理：
无。
4.3.2数据格式
输出数据的格式：
表格、列表、文字。
4.3.3输出举例
4.4出错和恢复
4.4.1出错信息及其含义
①输入地名不合法
②输入不能为空
4.4.2用户应采取措施
按照要求输入数据，起点与终点地名不能为空，只能是中国国内地名或地名首字母。
4.5求助查询
在系统界面下方显示如下：
五．运行说明
5.1运行表
（1）按起点终点查询：
目的：
使对车次不清楚的用户可以方便查询到所有需要的铁路车次。
（2）按车次查询：
目的：
缩小范围，直接可查询这个车次的起点终点和经过站、始发时间、到达时间、不同座位票价等信息。
5.2运行步骤
5.2.1运行控制
输入起点和终点或车次，按“查询”，显示最后结果。
5.2.2操作信息
1运行目的：
按照要求查询所需列车时刻表及价格等。
2操作要求：
输入起点终点或车次（中国地名），按“查询”显示结果。
3启动方法：
按“查询”启动。
4预计运行时间：
系统在5秒以内给出结果
5操作命令格式及说明：
字符（中文和字母），不得少于2个字符。
6其他事项：
要有网络支持。
5.2.3输入/输出文件
7文件的名称及编号：
在线察看，无须输出文件，若要保存，可存为文本文档。
8记录媒体：
打印机、显示屏、光盘、磁盘、可移动硬盘等。
9存留的目录：
无。
10文件的支配：
在线察看，无文件。
5.2.4启动或恢复过程
若出现故障，只需关闭，重新启动即可，无需重启计算机。
六．非常规过程
①输入地名不合法
②输入不能为空
七．操作命令一览表
C：
查询
输入起点终点或车次（中国地名），按“查询”显示结果。
八．程序文件和数据文件一览表
C：
车次查询：
L：
类型选择：
Z：
站站查询：
九．用户操作举例
第一步：
输入起点站名。
（例：
上海）
第二步：
输入终点站名。
（例：
温州）
第三步：
选择火车类型
第四步：
按“查询”按钮提交
第五步：
显示结果
升级会员 