《用户手册编写范》.doc

QB 版本：1.0 杭州东联软件有限公司 用户手册编写规范 文件基本信息 文档主题 用户手册编写规则 文档编写 刘飞龙 文档审核 於杰 文档批准 徐筱明 文档类型 作业指导书 安全状态 受控状态 首次发布 2007/7/10 分发对象 过程改进工作指导委员会和过程改进组成员 修改历史记录 版本 日期 更改记录 批准者 更改者 目 录 1. 目的 1 2. 适用范围 1 3. 用户（操作）手册内容 1 3.1. 引言 1 3.1.1. 编写目的 1 3.1.2. 定义 1 3.1.3. 参考资料（可选） 1 3.1.4. 文档综述（可选） 1 3.2. 软件概述 1 3.2.1. 目标 1 3.2.2. 功能 1 3.2.3. 性能（特色） 1 3.3. 产品运行环境 1 3.3.1. 硬件环境 1 3.3.2. 支持软件 1 3.4. 产品安装 2 3.4.1. 安装条件 2 3.4.2. 安装步骤 2 3.4.3. 安装配置方法 2 3.5. 使用说明 2 3.5.1. 产品界面介绍 2 3.5.2. 帮助操作说明 3 3.5.3. 操作说明 3 3.6. 用户常见问题说明（可选） 3 3.7. 热键和快捷键一览表 3 4. 用户手册排版规则 3 4.1. 封面 3 4.2. 目录 3 4.3. 一级标题 3 4.4. 二级标题 3 4.5. 三级标题 3 4.6. 正文 3 目的 通过对本公司公司产品的用户（操作）手册编写进行基本规范，使用户（操作）手册的编写达到标准化。 适用范围 适用于本公司各类产品用户（操作）手册的编写。 本标准指定可选内容可视产品的性质进行选择。 在产品用户（手册）的具体编写时，可不按本标准的排列方式（顺序）和相应的目录。 用户（操作）手册内容 引言 编写目的 阐明编写用户（操作）手册的目的，指明读者对象。 定义 列出用户（操作）手册中使用的专门术语的定义和缩写词的原意、适用范围。 参考资料（可选） 列出有关参考资料的名称、作者、标题、发表日期、出版单位或资料来源。 文档综述（可选） 描述文档其余部分的内容和组织结构。 软件概述 目标 描述产品所能达到的目标。 功能 描述产品的主要功能。 性能（特色） 描述产品的主要性能（特色）。 产品运行环境 硬件环境 描述软件系统运行时所需的硬件最小配置。 支持软件 描述操作系统名称和版本号。 如有数据库管理系统的话，描述数据库系统的名称及版本号。 如有其它必要的支持软件的话，描述其它软件的名称及版本号。 产品安装 安装条件 列出该产品安装所需的软硬件环境和系统配置等前提条件和注意事项。 硬件环境和配置要求 说明该系统对硬件及其配置的要求。 软件环境和配置要求 说明系统对软件运行环境的要求，可包括：对操作系统、数据库、其它所需外来软件产品和配置的要求等。 安装注意事项 列出安装时需特别给予注意的一些事宜，如对软件版本的要求或对不同平台的不同的定制文件的要求等。 安装步骤 简要说明安装的步骤，各相关软硬件安装的顺序。 安装配置方法 详细说明所需各项安装的详细方法、步骤和注意事项。 硬件环境的安装和配置（可选） 说明产品所需硬件环境的安装和配置方法及其注意事项。 操作系统的安装和配置 说明产品所需操作系统的安装和对网络等进行配置的方法及其注意事项，如需安装“补丁”，也要给出安装说明和特别的提示。 数据库系统的安装和配置（可选） 说明产品使用的数据库产品的安装和设置方法及其注意事项，如需安装“补丁”，也要给出安装说明和特别的提示。 其它所需软件的安装和配置（可选） 若安装、调试或使用产品时，需要其它外来软件产品的支持，应列出其安装配置的方法和注意事项。 项目应用软件的安装和配置 应用软件的安装 详细列出该产品的安装详细步骤和注意事项，包括用户、环境、口令等等方面设置的要求，同时应说明备份保护机制。 应用数据库的创建（可选） 详细描述产品应用数据库的创建、设置和初始化的步骤与方法，说明数据备份机制等需要注意的问题。 调试与验证 为了确保安装的正确性和适用性，应作一些相应的调试和验证，应给出相应的调试与验证的方法和要求 使用说明 产品界面介绍 详细对产品界面进行描述，包括功能菜单、工具条、指令图标等。 帮助操作说明 详细描述产品的在线帮助的使用方法。 操作说明 详细描述产品各功能的操作方法；