密级:秘密
用户手册
编制: 审核: 批准:
变更记录
版本 变更原因和内容 修订人 审批人 生效日期
目 录
1
概述 ........................................................................................................................................................ 1 1.1 简介 ........................................................................................................................................ 1 1.2 运行环境................................................................................................................................. 1 1.3 术语表 .................................................................................................................................... 2 1.4 版权声明................................................................................................................................. 2 安装与启动 ............................................................................................................................................ 3 2.1 运行环境安装 ......................................................................................................................... 3 2.2 系统安装与配置 ..................................................................................................................... 4 2.3 系统启动................................................................................................................................. 4 2.4 系统卸载................................................................................................................................. 5 操作说明 ................................................................................................................................................ 5 3.1 模块一 .................................................................................................................................... 5
3.1.1 功能描述 ......................................................................................................................... 5 3.1.2 界面图示 ......................................................................................................................... 5 3.1.3 操作描述 ......................................................................................................................... 5 3.2 模块二 .................................................................................................................................... 5 3.3 功能描述................................................................................................................................. 5 3.4 界面图示................................................................................................................................. 5 3.5 操作描述................................................................................................................................. 5 疑难解答 ................................................................................................................................................ 6 4.1 问题一 .................................................................................................................................... 6 4.2 问题二 .................................................................................................................................... 6 附录 ........................................................................................................................................................ 6
2
3
4
5
XXX公司 用户手册
1 概述
1.1 简介
【对系统进行简单介绍,扼要说明系统所提供的主要功能,以及帮助用户所解决的问题,指出预期的读者】
1.2 运行环境
【说明系统所需要的运行环境,包括:硬件设备、支持软件和数据结构等】 1. 硬件设备
列出为运行本软件所要求的硬设备的最小配置,如: 1) 处理机的型号、内存容量
2) 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机; 3) I/O设备(联机/脱机);
4) 数据传输设备和转换设备的型号、台数 2. 支持软件
说明运行本软件所需要的支持软件,如: 1) 操作系统的名称、版本号;
2) 程序语言的编译/汇编系统的名称和版本号 3) 数据库管理系统的名称和版本号 4) 其他支持软件。 3. 数据结构
列出为支持本软件的运行所需要的数据库活数据文卷。 【举例】 服务器端: 1) 主机类型
配置 WEB应用服务器/报表服务器 数据库服务器 (WEB Server & ApplicationServer) (DatabaseServer) 型号 型号自选 UNIX服务器、型号自选 CPU 2.8G以上 双CPU E-cache 1M以上 1M以上 内存 2G以上 4G以上
1
XXX公司 用户手册
硬盘 80G以上 100G以上 光驱 普通光驱 可刻录DVD光驱 磁带 普通磁带机 普通磁带机 2) 网络类型 § intrant § internet 3) 操作系统
应用服务器用WINDOWS系统,数据库服务器用UNIX操作系统 4) 数据库管理系统 ORACLE数据库 5) 其他支撑软件
WebLogic、中创报表工具及备份策略 客户端:
CPU: PIII733或celeron1G以上。 内存:256M
硬盘空间:5 G以上可用硬盘空间
通讯环境:能够登录Internet,带宽:512K以上。 操作系统:windows2000、windows2003、windowsXP等。 浏览器:Internet Explorer6.0以上版本。
1.3 术语表
【详细定义用户使用系统前,所需要了解专业术语。】 【举例】
KPI:Key Performance Index 关键性能指标
1.4 版权声明
【说明系统的版权信息】 【举例】
《XX系统》、《XX用户手册》的版权、注册商标XXXX归XX公司所有。未经XX公司的书面准许,不得将本用户手册的任何部分以任何形式、采用任何手段(电子的或机械的,包括照相复制或录制)、或为任何目的,进行复制或扩散。
®
2
XXX公司 用户手册
XX公司不对因为使用该软件、用户手册或由于该软件、用户手册中的缺陷所造成的任何损失负责。
Copyright© 2008-2008 XX公司。版权所有,翻制必究。
2 安装与启动
【一步步地说明为使用本软件而需进行地安装与初始化过程,包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。如果安装过程中用到专用软件,则应详细说明】
2.1 运行环境安装
【详细说明用户如何安装系统所需要的运行环境】 【举例】
XX系统的正常运行需要web服务容器与数据库支持。Web服务容器为Tomcat5.5.9,数据库为oracle9i。
Tomcat5.5.9的安装步骤如下:
1)下载Tomcat5.5.9,下载地址为:http://tomcat.apache.org/download-55.cgi,文件名为:jakarta-tomcat-5.5.9.exe。
2)双击“jakarta-tomcat-5.5.9.exe”文件开始安装,出现欢迎使用apache tomcat安装向导界面。如下图:
1. 点击按钮“next”,出现协议认证界面。
3
XXX公司 用户手册
2. „„„„„„„„„„
2.2 系统安装与配置
【详细说明用户如何使用安装程序,进行系统安装,以及系统配置。】 【举例一】
生产指挥系统的安装与配置
服务器端:
将sczh.war包拷贝到tomcat目录的webapp文件夹下。
客户端:
该系统的客户端不需要安装操作。 【举例二】
Tomcat的安装,见2.2节。安装系统软件的安装向导提醒一步一步的进行安装。
2.3 系统启动
【详细说明用户如何启动系统。】 【举例一】 生产指挥系统的启动
服务器端:
双击tomcat安装目录下面的“bin\\startup.bat”文件,启动tocamt。如下图(略)
客户端:
通过IE浏览器启动,启动步骤如下: 1. 打开IE浏览器,界面如下:
2. 在地址栏输入服务器IP地址。如:http://10.6.192.141:7070/sc
3. 【举例二】
小层平面图系统的启动。
系统安装完成后,主程序在所安装目录下,文件名为:StratFrame.exe。单击桌面 “开始”->“程序”->“StratFrame”,即可打开系统的主界面;或者在桌面上建立 “快捷图标”,双击快捷图标
,即可进入系统。
4
XXX公司 用户手册
2.4 系统卸载
【详细说明用户如何卸载系统。】 步骤同上。
3 操作说明
【详细说明用户使用系统】
3.1 模块一
【详细说明模块的业务功能、操作描述、界面图示等内容,根据软件需要可以自由添加】
3.1.1 功能描述
【详细说明模块的业务功能】
3.1.2 界面图示
【添加模块的界面图示】
3.1.3 操作描述
【详细说明模块的操作描述】
3.2 模块二
【同上】
举例:值班记录来电情况模块
3.3 功能描述
使用该模块可以查询其他单位发给本单位的原始信息,签收新消息,同时有新信息的提醒,包括状态、声音。
3.4 界面图示
3.5 操作描述
本模块主要完成两个功能:
根据组合查询条件查询出符合条件的值班记录结果。 签收新消息 1. 查询按钮的描述
第一步:输入查询的开始时间、结束时间、类型与关键字(如果不需要该条件,则不用填写即可);
5
XXX公司 用户手册
第二步:点击“查询”按钮,页面显示复合条件的查询结果。 2. 签收链接的描述
第一步:点击“未签收”链接,进入值班记录维护界面,该消息默认为已签收。值班记录维护界面如下图:
4 疑难解答
【为帮助用户及时排查问题,就常见问题,进行解释说明】
4.1 问题一
【详细解释说明该问题的解决方法】
4.2 问题二
【详细解释说明该问题的解决方法】
5 附录
【补充说明本手册的其他信息,如参考资料等】
6
因篇幅问题不能全部显示,请点此查看更多更全内容