用户操作手册模版

软件文档写作实践五

全国铁路查询系统

用户操作手册

[V1.0(版本号)]

拟 制 人 蒋爱玲

班 级 08计科S1 组 号 5 同 组 人 黄栩洁 韩 宇

柏金金 顾春华

[2009年5月27日]

目 录

一 引言 ......................................................................................................................... 3

1.1编写目的 ............................................................................................................................. 3 1.2项目背景 ............................................................................................................................. 3 1.3定义 ..................................................................................................................................... 3 1.4参考资料 ............................................................................................................................. 4

二．软件概述 ............................................................................................................... 4

2.1目标 ..................................................................................................................................... 4 2.2功能 ..................................................................................................................................... 4

2.2.1 管理端 ..................................................................................................................... 4 2.2.2 客户端 ..................................................................................................................... 5 2.3性能 ..................................................................................................................................... 5

2.3.1 数据精确度 ............................................................................................................. 5 2.3.2 时间特性 ................................................................................................................. 5 2.3.3 灵活性 ..................................................................................................................... 5

三．运行环境 ............................................................................................................... 5

3.1硬件 ..................................................................................................................................... 5 3.2支持软件 ............................................................................................................................. 6

四．使用说明 ............................................................................................................... 6

4.1安装和初始化 ..................................................................................................................... 6 4.2输入 ..................................................................................................................................... 6

4.2.1数据背景 .................................................................................................................. 6 4.2.2数据格式 .................................................................................................................. 6 4.2.3输入举例 .................................................................................................................. 7 4.3输出 ..................................................................................................................................... 8

4.3.1数据背景 .................................................................................................................. 8 4.3.2数据格式 .................................................................................................................. 8 4.3.3输出举例 .................................................................................................................. 9 4.4出错和恢复 ......................................................................................................................... 9

4.4.1 出错信息及其含义 ........................................................................................... 9 4.4.2 用户应采取措施 ..................................................................................................... 9 4.5 求助查询 ............................................................................................................................ 9

五．运行说明 ............................................................................................................. 10

5.1运行表 ............................................................................................................................... 10 5.2运行步骤 ........................................................................................................................... 10

5.2.1运行控制 ................................................................................................................ 10 5.2.2操作信息 ................................................................................................................ 11 5.2.3输入/输出文件 ....................................................................................................... 11 5.2.4启动或恢复过程 .................................................................................................... 11

六．非常规过程 ......................................................................................................... 11 七．操作命令一览表 ................................................................................................. 12 八．程序文件和数据文件一览表 ............................................................................. 12 九．用户操作举例 ..................................................................................................... 12

一 引言

1.1编写目的

本软件经过一定规划与测试，在市场上出售，为了让用户在第一次使用时可以很快上手操作，特地编写此用户操作手册，为用户提供便利，解决在使用本软件时碰到的一系列疑问。 读者对象：使用本软件的所有用户。

1.2项目背景

随着现在社会的发展，人们外出的机会越来越多，这时交通工具的选择就显得尤其重要。有些人会选择坐飞机，但是，飞机对于大多数的人来说是一笔比较贵的费用。对于大多数人来说，铁路交通是第一选择。至此，人们对铁路的需求也越来越大。因此，建立一个铁路查询系统是破在眉睫的事。而且，随着信息化的进步，计算机应用于各个领域。建立健全信息维护机制，及时更新完善相应的信息库，确保信息库资源完整、准确、规范，做到随时需要、随时统计、随时提供，逐步实现考勤管理的实时话、人性化、合理化。 铁路交通查询系统是一种信息查询系统，它主要包括了后台数据库的建立和维护，以及前端程序的应用开发两个方面。对于后台数据库的建立和维护，要求数据的一致性、完整性和安全性。对于前端程序的应用开发，则要求功能完备，使用简单等功能。

本系统尽可能为用户提供充足的信息和快捷方便的查询。使用计算机网络对铁路交通信息进行查询，比人工查询要优化。比如：检索迅速，查找方便，可靠性强，存储量大。

委托单位：上海第二工业大学； 开发单位：203工作室； 主管部门：203工作室。

1.3定义

全国铁路查询系统：对铁路交通信息进行查询的计算机软件程序。 定义关键词如下：

B/S： 服务器浏览器模式

JDBC：JAVA DataBase Connectivity（JAVA数据库连接） Web browser：网络浏览器

HTTP：Hyper Text Transfer Protocol（超文本传输协议） HTML：Hyper Text Markup Language (超文本标记语言) 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数据格式

① 长度：2个字节以上（可以输入中文，可以输入地名首字母）

② 格式基准：char（字符） ③ 标号：无

④ 顺序：从左至右输入起点与终点。 ⑤ 分隔符：无

⑥ 词汇表：只限字符

⑦ 省略和重复：输入时可以简单输入地名首字母。

例：要输入“上海”，可以只输入“sh”。

⑧ 控制：输入开始即输入起点与终点的地名或车次。

输入结束即按“查询”按钮

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操作信息

① 运行目的：按照要求查询所需列车时刻表及价格等。 ② 操作要求：输入起点终点或车次（中国地名），按“查询”显示结果。 ③ 启动方法：按“查询”启动。

④ 预计运行时间：系统在5秒以内给出结果 ⑤ 操作命令格式及说明：字符（中文和字母），不得少于2个字符。 ⑥ 其他事项：要有网络支持。

5.2.3输入/输出文件

⑦ 文件的名称及编号：在线察看，无须输出文件，若要保存，可存为文本文档。 ⑧ 记录媒体：打印机、显示屏、光盘、磁盘、可移动硬盘等。 ⑨ 存留的目录：无。

⑩ 文件的支配：在线察看，无文件。

5.2.4启动或恢复过程

若出现故障，只需关闭，重新启动即可，无需重启计算机。

六．非常规过程

①输入地名不合法

②输入不能为空

七．操作命令一览表

C：查询

输入起点终点或车次（中国地名），按“查询”显示结果。

八．程序文件和数据文件一览表

C：车次查询：

L：类型选择：

Z：站站查询：

九．用户操作举例

第一步：输入起点站名。（例：上海）

第二步：输入终点站名。（例：温州）

第三步：选择火车类型

第四步：按“查询”按钮提交

第五步：显示结果

本文来源：https://www.bwwdw.com/article/arw8.html