PMG-XXXX项目-安装维护用户手册.doc

安装维护用户手册

PAGE

PAGE5

XX安装维护用户手册

版本号

编写部门：

编写人员：

文档修改历史

版本

修改日期

编写

评审

批准

修改内容

TOC\o"1-3"\h\z

1引言 4

1.1编写目的 4

1.2背景 4

1.3定义 4

1.4参考资料 4

2用途 4

2.1功能 4

2.2性能 5

2.2.1时间特性 5

2.2.2灵活性 5

2.3安全保密 5

3运行环境 5

3.1硬件设备 5

3.2软件环境 5

3.3网络环境 6

3.3数据库环境 6

4维护说明 6

4.1安装与初始化 6

4.2常见问题与错误处理 7

4.3数据备份与空间清理 7

4.4系统状态检查和HA维护 7

4.5远程操作 7

安装维护用户手册

1引言

1.1编写目的

说明编写这份用户手册的目的，指出预期的读者。

1.2背景

说明：

这份用户手册所描述的软件系统的名称；

该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的单位。

1.3定义

列出本文件中用到的专门术语的定义和英语缩写和短语。

1.4参考资料

列出有用的参考资料，如：

项目的经评审的需求规格说明书、项目计划、概要设计、或合同、项目签报等；

属于本项目的其他可公布文件；

本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料的来源。

2用途

2.1功能

结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。

2.2性能

2.2.1时间特性

定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。

2.2.2灵活性

说明本软件所具有的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时间特性等的要求）有某些变化时，本软件的适应能力。

2.3安全保密

说明本软件在安全、保密方面的设计考虑和实际达到的能力。

对应用系统在用户、分组、数据库用户、中间件用户等有安全性方面的需求，必须在此章节中进行详细说明。

如有网络方面的安全性考虑则可在本章节中进行详述，或在网络环境章节中进行描述。

3运行环境

3.1硬件设备

列出为运行本软件所要求的硬件设备的最小配置（或推荐配置），如：

硬件设备型号、处理器个数与型号、内存容量；

存储设备以及I／O方面的特性；

备份设备以及备份策略；

传输设备。

3.2软件环境

说明为运行本软件所需要的支持软件，如：

操作系统的名称、版本号；

程序语言的编译／汇编系统的名称和版本号；

数据库管理系统的名称和版本号；

其他支持软件。

3.3网络环境

推荐使用网络拓扑图描述网络需求以及所需连接的各个系统，如有连接公网、设置防火墙等特殊需求，需着重描述。

网络拓扑图示例如下所示：

3.3数据库环境

描述为支持本应用软件的运行所需要的数据库版本、表空间、索引、等特性。

4维护说明

在本章描述与维护相关的内容。

4.1安装与初始化

按照实际操作步骤详细说明使用本应用系统软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、应用系统对这些命令的反应与答复，出错处理。表示安装工作完成的测试实例等。如果在安装过程中使用专用商业软件，则需建立新的子章节进行详细说明。

注：对于应用系统、数据库系统、通讯中间件、等软件的启动、重启、等相关操作需要在本章节中详细描述。

4.2常见问题与错误处理

列出由软件产生的出错编码或条件以及应由用户或者维护者承担的修改纠正工作。指出为了确保再启动和恢复的能力，用户必须遵循的处理过程。

可以列出常用出错码、出错提示、出错处理的对应表格

出错码

出错说明

出错处理方法

4.3数据备份与空间清理

详细说明系统的数据备份策略，备份的频率，所需的存储空间，操作命令，需要注意点等等。

4.4系统状态检查和HA维护

如应用系统带有系统监控等功能，或者需要使用操作系统的监控功能，需要在本章节中详细描述如何进行监控，设定系统安全临界点的阈值。

注：对于使用双击热备等策略的应用系统，需要在此进行描述。

4.5远程操作

如果本应用软件能够通过远程终端控制运行，则在本章说明通过远程终端运行本软件的操作过程。