产品安装维护手册_模板

项目名称 安装维护手册

文档编号：CRB_QA_MNT_TMP 文档信息：安装维护手册模版 文档名称：

文档类别：质量保证模板 密 级：机密 版本信息：1.0

创 建 人：侯智勇 审 核 者： 批 准 人： 批准日期：

保 管 人： 存放位置：

编辑软件：Microsoft Office 2007 中文版

CONFIDENTIAL

文档修订记录 版本编号或者更改记录编号 V1.0 *变化 简要说明（变更内日期 状态 A 容和变更范围） 新建 2010-12-7 侯智勇 变更人 批准日期 批准人 *变化状态：A——增加，M——修改，D——删除

文档审批信息 序号 审批人

角色 审批日期 签字 备注

目录

第1章 1.1 1.2 1.3 1.4 第2章 2.1 2.2 第3章 3.1 3.2 第4章 4.1 4.2 4.3

阅读指南 ..................................................................................................... 错误!未定义书签。 手册分册 ......................................................................................................... 错误!未定义书签。 使用建议 ......................................................................................................... 错误!未定义书签。 名词解释 ......................................................................................................... 错误!未定义书签。 参考资料 ......................................................................................................... 错误!未定义书签。 系统简介 ..................................................................................................... 错误!未定义书签。 系统功能和用途.............................................................................................. 错误!未定义书签。 系统运行环境说明 .......................................................................................... 错误!未定义书签。 XX子系统 ................................................................................................... 错误!未定义书签。 功能概述 ......................................................................................................... 错误!未定义书签。 操作指南 ......................................................................................................... 错误!未定义书签。 附录 ............................................................................................................. 错误!未定义书签。 附录A：名词解释 .......................................................................................... 错误!未定义书签。 附录B：FAQ—常见问题解答 ...................................................................... 错误!未定义书签。 附录C：错误信息对照表 .............................................................................. 错误!未定义书签。

[项目名称]安装维护手册

1. 前言

文档用途

【内容】

说明此文档的主要用途。

【裁剪原则】

此部分内容不允许裁剪。

阅读对象

【内容】

说明此文档将适合哪些人员阅读以及阅读人员需要具备的知识。软件产品使用手册的对象一般为使用该软件产品的用户 【裁剪原则】

此部分内容不允许裁剪。

参考资料

【内容】

列出该文档编写时的主要参考资料。 【裁剪原则】

如果没有参考其他资料，此部分内容允许裁剪掉。

1

[项目名称]安装维护手册

系统简介

系统功能和用途

【内容】

简单讲述本系统的功能及用途。包括（1)软件全名；（2）开发单位（3）软件面向对象（4）软件开发遵循标准等。 【裁剪原则】

此部分内容不允许裁剪掉。

系统结构

【内容】

讲述本章所需要描述的内容：包括（1）软件结构；（2）软件结构图；（3）软件功能

并按照以上的内容简介开始介绍本系统的结构。目的在于使用简明的语言，描述整个系统的结构及功能，给读者一个整体概括的印象。

【裁剪原则】

此部分内容不允许裁剪掉。

阅读指南

【内容】

简单讲述下面各章内容提要 【裁剪原则】

此部分内容不允许裁剪掉。

2

[项目名称]安装维护手册

安装前的准备

【内容】

首先介绍本章的内容介绍：例如：“从本章节开始介绍本系统的安装维护方法。在本章中将介绍系统安装前的准备工作，如：安装组织结构、运行环境、建立数据库用户及表空间、检查硬盘空间、保持网络通畅、删除原数据库表，如果你按照以下说明完成工作，将对系统顺利安装成功创造良好的条件。”

然后开始按照上面所述的内容，分节介绍安装前所需的一切准备工作。以前列出的节是本章中必须有的内容项，其他内容其它项内容可以根据实际情况进行说明。

【裁剪原则】

此部分内容不允许裁剪掉。

安装组织结构

【内容】

对于较大的软件系统必须描述其组织结构，如果对于存在多种组合方式的软件，必须在此将所有组合进行分析比较。

运行环境

【内容】

将所有运行此软件所涉及到软硬件环境均在此说明。尽量避免出现＂以上＂或＂以下＂字样。例如： 1、 服务器

         

工作站 操作系统 内存 硬盘剩余空间 软件需求 数据库版本号 所需数据库表空间 硬件设备 操作系统

需要使用软件的名称及版本号

2、 数据库

安装文件

【内容】

软件安装程序名。

3

[项目名称]安装维护手册

文件名称 权限 功能 4

[项目名称]安装维护手册

软件安装

软件安装步骤

【内容】

将屏幕打印信息抄录下来，使用不同背景加以区分，在此上或下面加入说明性文字。 例如：

在安装的临时目录下执行＂./install.noc＂命令。

安装完成后产生的文件清单

文件与目录按照下面的格式要求书写： 文件名称 权限 目录名：用途，有无权限的特殊要求，其它 目录名：用途，有无权限的特殊要求，其它 功能 配置文件的修改

【内容】需要说明：配置文件名称、所在目录位置、功能、详细内容、配置说明。

例：

保存在＂$abc_HOME/etc＂目录下的配置文件abc.cfg提供本系统所需的重要的参数。格式：KEY = CONTENT 说明：

 “=”两边必须有空格  配置路径时应为绝对路径。  没有的项请不要配置。  每个配置项占一行。  不要加入多余字符。

需要定时运行或马上运行的程序

【内容】需要说明：程序名称、所在目录位置、功能、运行方法。

5

[项目名称]安装维护手册

系统维护

【内容】此章需要将软件运行维护部分的内容加以说明。

日常管理

异常情况处理

6

[项目名称]安装维护手册

附录

附录A：名词解释

【内容】

在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。例如：

Web服务器：又可称Web Server，是支持管理Web浏览的服务软件。

软件包：一些软件的集合。这里是指为软件安装方便，而使用UNIX中tar命令而打的包。

【裁剪原则】

如果没有特别生疏的术语，此部分内容允许裁剪掉。

附录B：快速安装指南

【内容】

此项是安装的简化版，主要是对系统已经了解并需要在短时间内完成安装的人员使用。 【裁剪原则】

此部分内容不允许裁剪掉。

7