《用户手册编写规范》(20210311155417)

1、杭州东联软件有限公司用户手册编写规则QB版本：1.0索菱有限公司用户手册编写规范文件基本信息文档主题用户手册编写规则文档编写刘飞龙文档审核於杰文档批准徐筱明文档类型作业指导书安全状态受控状态首次发布2007/7/10分发对象过程改进工作指导委员会和过程改进组成员修改历史记录版本日期更改记录批准者更改者1. 目的12. 适用范围13. 用户（操作）手册内容13.1. 引言13.1.1. 编写目的13.1.2. 定义13.1.3. 参考资料（可选）13.1.4. 文档综述（可选）13.2. 软件概述13.2.1. 目标13.2.2. 功能13.2.3. 性能（特色）13.3. 产品运行环境13.3

2、.1. 硬件环境13.3.2. 支持软件13.4. 产品安装23.4.1. 安装条件23.4.2. 安装步骤23.4.3. 安装配置方法 23.5. 使用说明23.5.1. 产品界面介绍23.5.2. 帮助操作说明33.5.3. 操作说明 33.6. 用户常见问题说明（可选）33.7. 热键和快捷键一览表34. 用户手册排版规则 34.1. 封面34.2. 目录34.3. 一级标题34.4. 二级标题34.5. 三级标题34.6. 正文31. 目的通过对本公司公司 产品的用户（操作）手册编写进行基本规范，使用户（操作）手册的编写达到标准化。2. 适用范围适用于本公司各 类产品用户（操作）手册的

3、编写。本标准指定可 选内容可视产品的性质进行选择。在产品用户（手册）的具体编写时，可不按本标准的排列方式（顺序）和相应的目录。3. 用户（操作）手册内容3.1. 引言311编写目的阐明编写用户（操作）手册的目的，指明读者对象。312定义列出用户（操作）手册中使用的专门术语的定义和缩写词的原意、适用范围。3.1.3. 参考资料（可选）列出有关参考 资料的名称、作者、标题、发表日期、出版单位或资料来源。3.1.4. 文档综述（可选）描述文档其余部分的内容和 组织结构。3.2. 软件概述321目标描述产品所能达到的目标。322功能描述产品的主要功能。323性能（特色）描述产品的主要性能（特色）。33

4、产品运行环境331硬件环境描述软件系统运行时所需的硬件最小配置。332支持软件1）.描述操作系统名称和版本号。2）.如有数据库管理系统的话，描述数据库系统的名称及版本号。3）.如有其它必要的支持 软件的话，描述其它软件的名称及版本号。3.4.产品安装341安装条件列出该产品安装所需的 软硬件环境和系统配置等前提条件和注意事 项。3.4.1.1. 硬件环境和配置要求说明该系统对硬件及其配置的要求。3.4.1.2. 软件环境和配置要求说明系统对软件运行环境的要求，可包括：对操作系统、数据库、其它所需外来软件产品和配置的要求等。3.4.1.3. 安装注意事项列出安装时需特别给予注意的一些事宜，如 对

5、软件版本的要求或 对不同平台的不同的定制文件的要求等。342安装步骤简要说明安装的步 骤，各相关软硬件安装的顺序。343安装配置方法详细说明所需各项安装的详细方法、步骤 和注意事项。3.4.3.1. 硬件环境的安装和配置（可选）说明产品所需硬件 环境的安装和配置方法及其注意事项。3.4.3.2. 操作系统的安装和配置说明产品所需操作系 统的安装和对网络等进行配置的方法及其注意事 项，如需安装 补丁”也要给出安装说 明和特别的提示。3.4.3.3. 数据库系统的安装和配置（可选）说明产品使用的数据 库产品的安装和 设置方法及其注意事 项，如需安装 补丁”也要给出安装说明和特别的 提示。3.4.3

6、.4. 其它所需软件的安装和配置（可选）若安装、调试 或使用产品时，需要其它外来软件产品的支持，应列出其安装配置的方法和注意事项。3.4.3.5. 项目应用软件的安装和配置3.4.3.5.1. 应用软件的安装详细列出该产品的安装详细步骤和注意事项，包括用户、环境、口令等等方面设 置的要求，同时应说明备份 保护机制。3.4.3.52 应用数据库的创建（可选）详细描述产品应用数据库的创建、设置和初始化的步 骤与方法，说明数据备份机制等需要注意的 问题。3.4.36调试与验证为了确保安装的正确性和适用性，应作一些相 应的调试和验证，应给出相应的调试与验证的方法和要求3.5. 使用说明3.5.1. 产

7、品界面介绍详细对产品界面进行描述，包括功能菜单、工具条、指令图标等。3.5.2. 帮助操作说明详细描述产品的在线帮助的使用方法。3.5.3. 操作说明1）.详细描述产品各功能的操作方法；2）.详细描述产品所产生文件的保存方式（格式）；3）.详细描述产品与第三方同类产品的数据交换方式。3.6. 用户常见问题说明（可选）详细描述对用户常见问题（由于用户操作经验和操作方法而引起的）的 处理方法。3.7. 热键和快捷键一览表按字母顺序或按功能逐个列出 热键和快捷键的名称和功能 说明。4. 用户手册排版规则4.1. 封面1）产品名称：X系统。字体为黑体、小初；2）公司名称：杭州浙大大天信息有限公司。字体为黑体、三号；3）出版日期：xxxx年 %月。字体为黑体、小四号；4.2. 目录1）目录，字体为黑体、三号；2）目录列表：字体为宋体，五号。4.3. 一级标题第一章”字体为宋体、小一、灰色5%底纹、加粗。4.4. 二级标题第一节”字体为宋体、小一、灰色5%底纹、加粗。4.5. 三级标题“1.1.1” ：字体为宋体、三号、加粗。4.6. 正文1）提示文字：操作系统。字体为宋体、小四、加粗。2）所有文字行距1.5倍行距。3）段首缩进：2个字符。4）本节要点： 本节要点”字体为黑体、小四。小四。5）要点