《用户手册编写规范》.pdfVIP

杭州东联软件有限公司《用户手册编写规则》QB

版本：1.0

索菱有限公司

用户手册编写规范

杭州东联软件有限公司《用户手册编写规则》

文件基本信息

文档主题用户手册编写规则

文档编写刘飞龙文档审核於杰文档批准徐筱明

文档类型作业指导书安全状态受控状态首次发布2007/7/10

分发对象过程改进工作指导委员会和过程改进组成员

修改历史记录

版本日期更改记录批准者更改者

杭州东联软件有限公司《用户手册编写规则》

目录

1.目的.

2.适用范围.

3.用户（操作）手册内容.

3.1.引言

3.1.1.编写目的.

3.1.2.定义.

3.1.3.参考资料（可选）.

3.1.4.文档综述（可选）.

3.2.软件概述.

3.2.1.目标.

3.2.2.功能.

3.2.3.性能（特色）.

3.3.产品运行环境

3.3.1.硬件环境.

3.3.2.支持软件.

3.4.产品安装.

3.4.1.安装条件.

3.4.2.安装步骤.

3.4.3.安装配置方法.

3.5.使用说明.

3.5.1.产品界面介绍.

3.5.2.帮助操作说明.

3.5.3.操作说明.

3.6.用户常见问题说明（可选）

3.7.热键和快捷键一览表.

4.用户手册排版规则.

4.1.封面

4.2.目录

4.3.一级标题.

4.4.二级标题.

4.5.三级标题.

4.6.正文

杭州东联软件有限公司《用户手册编写规则》

1.目的

通过对本公司公司产品的用户（操作）手册编写进行基本规范，使用户（操作）手册的编写达到标准化。

2.适用范围

适用于本公司各类产品用户（操作）手册的编写。

本标准指定可选内容可视产品的性质进行选择。

在产品用户（手册）的具体编写时，可不按本标准的排列方式（顺序）和相应的目录。

3.用户（操作）手册内容

3.1.引言

3.1.1.编写目的

阐明编写用户（操作）手册的目的，指明读者对象。

3.1.2.定义

列出用户（操作）手册中使用的专门术语的定义和缩写词的原意、适用范围。

3.1.3.参考资料（可选）

列出有关参考资料的名称、作者、标题、发表日期、出版单位或资料来源。

3.1.4.文档综述（可选）

描述文档其余部分的内容和组织结构。

3.2.软件概述

3.2.1.目标

描述产品所能达到的目标。

3.2.2.功能

描述产品的主要功能。

3.2.3.性能（特色）

描述产品的主要性能（特色）。

3.3.产品运行环境

3.3.1.硬件环境

描述软件系统运行时所需的硬件最小配置。

3.3.2.支持软件

1).描述操作系统名称和版本号。

2).如有数据库管理系统的话，描述数据库系统的名称及版本号。

3).如有其它必要的支持软件的话，描述其它软件的名称及版本号。

杭州东联软件有限公司《用户手册编写规则》

3.4.