搜索
（项目名称）用户手册章节说明文件控制受控不受控文档编号版本号分册名称第册/共册总页数正文附录编制审批生效日期XX有限公司修改变更记录：更改条款及内容更改人审批人更改日期目录1用户手册的内容1.1封面封面内容应包括公司的ICON、软件名称及版本号、公司名称及手册印刷时间。1.2二封二封正面为软件名称及版本号、公司名称、手册印刷时间、公司地址及服务电话等。以先一科技开发平台用户手册手册为例，其形式如下：1.3版权声明版权声明是保护我们所开发软件的产权、不使我们公司利益受到损害的一种方式。在版权声明中应该包括以下内容：对我们所提供的软件及用户手册的保护声明。对我们的软件及注册商标®所有权的声明。我们不对用户因为使用我们的软件所造成的损失负责的声明（如：XX有限公司不对因为使用该软件、用户手册或由于该软件、用户手册中的缺陷所造成的任何损失负责）。具体可参考本规范的版权声明。1.4前言对于前言所应包含的内容经常根据用户手册编写人员的习惯不同而不同，有时仅仅包含了系统的开发背景和目的，有时还包含了系统简介，有时甚至还包含了用户手册的阅读指南。为了统一起见，在这里我们规定前言主要包括以下内容：系统的开发背景和目的。〖条件〗系统所能应用的领域和使用对象。系统的功能及特性简介。如果本手册不是该系统的第一个版本，还应该简介较上一版本的改进部分。〖条件〗1.5阅读指南阅读指南是每本（套）用户手册必不可少的组成部分，用户通过它可以了解到用户手册的基本内容；了解到应该如何、从哪儿开始阅读该用户手册。用户手册的阅读指南应该包含如下几部分：手册目标：通过阅读该用户手册，用户应该或能够达到什么目标。阅读对象：指明什么人员应该阅读该手册，或什么人员应该阅读本手册的哪些部分；阅读对象在阅读本手册之前应该掌握哪些知识，必要时应给出资料清单，以便用户查阅。手册构成：如果本系统的用户手册（包括管理员手册、参考手册）由几本组成，首先应该分别简要介绍这些手册的情况。最根本的是应该介绍本手册在哪一章或哪几章讲解了什么内容，对于较大系统。手册约定：这一部分应该包括字体的约定、特殊符号的约定以及【注意】、【警告】、【说明】等的含义。必要时，应该给出某些基本术语的定义。也可以把基本术语、概念的定义作为基础知识来介绍。具体请参考本规范的阅读指南。1.6目录目录的编写要尽量详尽。如果用户手册的内容用到小节，则目录就应该编写到小节；如果用户手册的内容用到小小节，则目录就应该编写到小小节。编写用户手册目录的目的就是为了让用户能够根据它很快地找到想要的内容。有关格式请参考本规范目录的编写。2基础知识介绍〖条件〗这一部分内容是在一定条件下必需的，用户手册编写人员应该根据实际情况确定是否需要这一部分。如果包括基础知识介绍，应将其放在第1章。在一般情况下，使用我们的软件系统需要一定的基础知识。这些知识可以从有关书籍上得到，但是用户从这些资料得到这些知识需要花费相当的时间。在某些情况下，我们只需要用户掌握用户手册中使用的那些概念，那么我们就有必要编写一章“基础知识介绍”来进行专门介绍。3系统安装及启动如果手册中包括基础知识介绍，应把系统安装及启动作为第2章，否则，将其作为第1章首先向读者予以介绍。系统安装及启动部分应该包括如下内容：系统的运行环境硬件环境要求说明：系统运行时所需硬件环境描述。包括机型、内存大小、硬盘空间等。如果必要，还应包括输入/输出设备、通讯环境等。软件环境要求说明：系统运行时所需软件支持环境的描述。包括所需任何其它软件的名称及版本号等。其它环境要求说明〖条件〗：应该说明要求的任何其它环境。系统的安装对于不同的系统其安装应有所区别，一般来说，应给出最终用户能够据此把软件安装到其操作系统并配置完成，且能成功运行的任何信息和操作。系统的安装包括软件的安装过程及系统环境的配置〖条件〗，必要时还应给出硬件的安装〖条件〗。硬件安装〖条件〗：如果必要，应该详细说明系统所需硬件环境的安装过程，其中包括软件加密锁的安装。软件安装：应该用图示方法详细介绍软件的安装过程。对于网络版软件，应对服务器端及客户端的安装分别予以介绍所有产品的安装包括以下界面：安装快闪界面〖条件〗、安装初始窗口（欢迎）、版权声明界面、选择安装路径界面、选择程序文件夹（程序组）界面〖条件〗、安装进程界面〖条件〗及安装完成界面。系统配置〖条件〗：应给出系统配置的详细过程，以便用户能够顺利操作系统。对于网络版软件，应分别讲述服务器和客户端的配置过程。系统的启动：应给出系统启动的方法。如果系统由多个模块组成，则不必单列出一节讲述系统的启动方法，只须在介绍各个模块的操作时给出模块的启动方法即可。对于系统的安装及启动的结构总结如下，供编写用户手册时参考：|------系统的运行环境|----硬件环境||----软件环境|系统的安装及启动||----硬件安装|------系统的安装|----软件安装||----系统的配置||------系统的启动4系统操作说明系统操作说明是用户手册的主体，这部分详细介绍了产品的功能、作用和意义。在编写时应遵循以下原则：应该以系统的功能为主线进行说明介绍功能介绍的顺序应依据功能实现的逻辑顺序进行，不应单纯地按照菜单项、按钮或工具条介绍对于功能比较复杂的部分，除了介绍操作方法之外，还应对该功能的作用和意义予以解释应该详细地描述操作过程中的每一步句子尽量简洁。如果用一个句子表达起来比较复杂，定语多，则可以分成两个甚至几个句子来说明，这样用户在阅读用户手册时会轻松些每节、段的内容明确。这样用户可以通过目录很方便地查到自己所需要的内容；注意段的划分，每段不要太长，突出重点，否则用户不容易获得其中的精华用户手册的用词要前后一致。在用户手册中使用的概念、术语的用词要前后一致，否则用户将不容易读懂此手册用户不一定是计算机专家，用户手册编写人员应该牢牢记住这一点。手册中应该尽量不使用较深奥的计算机术语。如果不可避免，我们应该给予适当的解释和说明用户手册各部分风格应该统一。一些较大的系统可能由多人开发和测试，从而造成用户手册各部分风格各异，这就要求用户手册编排人员最终将各部分统一成风格相同的一本手册在对功能的具体描述中，可以参考下面的操作步骤：启动某一程序，进入该程序的主界面。执行某一功能（选择菜单或工具按钮）。弹出相关界面。对输入信息予以说明。继续操作（点击按钮）。结束界面。对输出信息予以说明。有些软件的操作可能需要一定的技术和经验才能获得满意的结果，那么应该在用户手册上尽量给出这些技术和经验的描述，或告诉用户如何才能获得这些技术和经验。在用户手册中应按操作顺序或界面中菜单顺序分别对上述内容中的每一项操作予以介绍。要求详细给出操作过程及命令格式与功能，具体规定如下：各种操作、命令和语言：软件系统的使用过程都是使用软件系统提供的各种操作、命令和语言的过程。所以，我们必须做到：操作和命令：在用户手册中详细给出各种操作的过程和功能、命令的格式和功能；应当描述在使用上的各种限制，如，操作状态、操作条件、操作序列等。另外，必要时可以通过适当地举例讲述各种操作和命令的使用方法，以帮助用户理解。输出信息：应该详细列出与操作、命令相关的各种输出信息。如果输出信息的意思本身不是很明显，应当给予解释。另外还应当说明对于这些信息所采取的操作。程序设计语言〖条件〗：如果我们的软件系统提供了某种语言，对其语言规则应当给予说明。各种数据：在软件的使用过程中，用户必须与各种数据和信息打交道。为了让用户能够操作我们的软件，我们必须为用户提供各种结构以及每个数据元素的含义有些数据适合在系统操作说明中给出，有些适合在后面的附录中给出，甚至有些除了在操作说明中给出外，同时还要在附录中给予归纳，这些都由用户手册编写人员根据实际情况来决定。5系统及数据维护应该给出用户数据的备份、恢复、删除、整理的详细过程。如果必要，应该给出系统数据、系统磁盘空间维护的详细过程。