用户手册编写规范

用户手册编写规范目录1.用户手册格式的统一规定1.1章、节标题1.2版面设置2.用户手册的内容2.1用户手册的目标2.2用户手册的内容2.3用户手册的风格1.用户手册格式的统一规定1.1章、节标题一般情况下，用户手册用章、节来划分其内容。如果有的系统很大，其用户手册所包含的内容繁多，那么请根据其内容把用户手册划分为几个分册。每一分册根据本规定独立进行章、节编号。1.1.1章标题每章的编号用阿拉伯数字表示，采用“第1章”、“第2章”、……的形式表示章的编号，章的编号后面空一个半角的格，然后是这一章的标题。1）每一章必须另起一页开始；2）章的编号和标题采用左对齐的格式放在行的左边；3）章的编号和标题采用黑体小三号字；4）章的编号和标题与其篇眉之间空一行，和其正文之间空三行。1.1.2节标题节的编号格式为“§x.y”。其中，x为章的号码，y为节的号码，用阿拉伯数字表示。节的编号后面空一个半角的格，然后是这一节的标题。1）每一节必须另起一页开始；2）节的编号和标题采用左对齐的格式放在行的左边；3）节的编号和标题采用黑体四号字；4）节的编号和标题与其篇眉、正文之间均空一行。1.1.3小节标题小节的编号格式为“§x.y.z”。其中，x为章的号码，y为节的号码，z为小节号码，用阿拉伯数字表示。小节的编号后面空一个半角的格，然后是这一小节的标题。1）不必专为小节另起一页开始；2）小节的编号和标题从左边开始顶格书写；3）小节的编号和标题采用黑体小四号字；4）小节的编号和标题与其前后的正文之间均空一行。【注意】1）一般情况下，章的下面可以划分为节和小节，但要具体情况具体分析。如果没有划分小节的必要，则可以划分到节为止；而且，如果有必要，还可以在小节下面划分更小的节，我们暂且称之为小小节。2）对于小小节的各种规定与小节一致。1.1.4其它编号1）页编号：用户手册中的正文按章进行编号，其格式为“章—页”。如，第2章的第3页，编号为“2-3”。各种页编号的形式请参考本手册所采用的格式。2）图、表编号：用户手册中的图、表均按章分别进行编号，其格式分别为“图x-y”、“表x-y”。如，第2章的第3幅图的编号是“图2-3”；第2章的第3张表格的编号是“表2-3”。在图、表编号的编号后面空一个半角的格，然后是这一图表的名称。另外，还规定：表的编号与名称放在表的顶部表的编号与名称和表在左边对齐，而整个表则对中放置表的编号与名称和前面的正文之间空一行，和表之间无空行表和其后面的正文之间空一行图的编号与名称放图的底部图的编号与名称和图均对中放置图的编号与名称和前面的图、后面的正文之间均空一行图和其前面的正文之间空一行图、表的编号与名称均采用黑体五号字打印3）编号序列：在本章的1.1.3中的编号序列为无名编号序列，在本小节中，带编号的序列为有名编号序列。在节、小节、小小节里面均可以含有编号序列。在一般情况下，节中编号序列所含的内容比小节所含的内容少，在什么情况下用小节、小小节，在什么情况下用编号序列，由用户手册的编制人员自己确定。编号序列在缩进两个汉字位置之后开始书写，对于有名编号序列的编号和名称要选择黑体五号打印方式，其后面的内容均采用五号宋体汉字。在带编号的序列里还容许二级编号序列，其格式规定如下：编号的格式是“n).”，其中n为阿拉伯数字其它规定和一级序列编号一致【注意】1）用户手册的正文均采用宋体五号汉字。2）编写手册时，对于界面中的按钮名称，应把按钮名称用尖括号“〈〉”括起来，按钮名称用黑体五号字书写。对于下拉菜单选项的名称，应用引号“”引起来，选项名称用黑体五号字书写。1.2版面设置1.2.1版面设置对于版面设置我们作如下规定：1）纸型：用户手册用纸统一规定为B5。宽18.2厘米，长25厘米；2）行间距：用户手册中的行间距统一定为一倍半行距；3）缩进：每段的第一行缩进两个汉字的位置；4）页面顶部空白：页面顶边到正文的距离为3厘米；5）页面底部空白：页面底边到正文的距离为2厘米；6）页面内边空白：页面内边（单号页的左边、双号页的右边）到正文的距离为2.1厘米；7）页面外边空白：页面外边（单号页的左边、双号页的右边）到正文的距离为1.6厘米。1.2.2空行规定为了保持版面清晰，在用户手册的正文中要保留一定的空行，规定如下：1）章标题和其正文之间保留3行空白；2）节标题之后留一空行；3）小节标题、小小节的前后均留一空行；4）表的编号与名称和前面的正文之间空一行，和表之间无空行；5）表和其后面的正文之间空一行；6）图的编号与名称和前面的图、后面的正文之间均空一行；7）图和其前面的正文之间空一行；8）各正文段之间空一行。1.2.3关于页眉的规定页眉位于用户手册每一页的顶部，对页眉的规定如下：1）版权申明、前言、阅读指南、目录均无篇眉；2）章编号和名称所在页的篇眉为一行有50%填充的边框；3）对于单号页，页眉的内容是当前章的标题名，要求打印在纸的右上角；4）对于双号页，页眉的内容是用户手册的名称，要求打印在纸的左上角；5）纸的顶边与页眉的距离是2.3厘米；6）页眉所采用的是昆仑细圆小五号字。1.2.4关于页脚的规定页脚位于用户手册每一页的底部，对页脚的规定如下：1）页脚的内容是当前页的页编号，具体编号方式请参考本手册；2）页编号的字体采用宋体五号；3）纸的底边与页脚的距离是1.3厘米。1.2.5注意与警告在用户手册中，对于那些需要用户特别注意的事项，应该用“【注意】”作为标志给用户以特别的提示。关于注意标志和注意事项的格式有如下规定：1）注意标志靠左顶格书写；2）注意标志采用的是黑体小四号汉字；3）注意标志和其前面的正文之间应该有一个空行；4）如果注意事项只有一条，其内容应该紧跟在注意标志的后面书写；否则，应该在注意标志的下一行开始，采用编号序列的形式分别给出。在用户手册中，对于那些会给用户造成重大损失的行为，应该用“【警告】”作为标志给用户以警告性的提示。对于一个好的软件系统来说，这种警告性的提示应少一些，但如果必要，还是应该存在。【注意】关于警告标志和警告事项的格式规定与关于注意标志和注意事项的格式规定一致。2用户手册的内容规定用户手册所要达到的目标、包含的内容、以及编写的风格。如果标题后跟有“〖条件〗”字样，说明该标题下正文所要求的内容是在一定条件下所必须的。2.1用户手册的目标1）让用户手册成为用户学习使用我们产品的最好教材。2）让用户手册能够起到降低销售费用的作用。【注意】如果本系统软件是一个大系统，其系统安装、操作说明、系统及数据维护都相当复杂，则可以把这三个部分分别编写为一本甚至几本用户手册，每本手册都有自己的封面、版权声明、前言、阅读指南、目录以及相应的基础知识介绍和附录。2.2用户手册的内容2.2.1版权声明版权声明是保护我们所开发软件的产权、不使我们公司利益受到损害的一种方式。在版权声明中应该包括以下内容：1）对我们所提供的软件及用户手册的保护声明；2）对我们的软件及商标东大阿尔派所有权的声明；3）对我们的用户手册中所提到的各种商标的版权声明；4）我们不对用户因为使用我们的软件所造成的损失负责的声明。2.2.2前言前言主要包括以下内容：1）系统的开发背景和目的；2）系统所能应用的领域和使用对象；3）系统的功能及特性简介；4）如果本手册不是该系统的第一个版本，还应该简介较上一版本的改进部分。2.2.3阅读指南应该包含如下几部分：1）手册目标：通过阅读该用户手册，用户应该或能够达到什么目标。2）阅读对象：指明什么人员应该阅读该手册，或什么人员应该阅读本手册的哪些部分；阅读对象在阅读本手册之前应该掌握哪些知识，必要时应给出资料清单，以便用户查阅。3）手册构成：如果本系统的用户手册(包括管理员手册、参考手册)由几本组成，首先应该分别简要介绍这些手册的情况。最根本的是应该介绍本手册在哪一章或哪几章讲解了什么内容。4）手册约定：这一部分应该包括字体的约定、特殊符号的约定。必要时，应该给出某些基本术语的定义。也可以把基本术语、概念的定义作为基础知识来介绍。2.2.4目录目录的编写要尽量详尽。如果用户手册的内容用到小节，则目录就应该编写到小节；如果用户手册的内容用到小小节，则目录就应该编写到小小节。编写用户手册目录的目的就是为了让用户能够根据它很快地找到想要的内容。2.2.5基础知识介绍〖条件〗用户手册编写人员应该根据实际情况确定是否需要这一部分。在一般情况下，使用我们的软件系统需要一定的基础知识。这些知识可以从有关书籍上得到，但是用户从这些资料得到这些知识需要花费相当的时间。在某些情况下，我们只需要用户掌握用户手册中使用的那些概念，那么我们就有必要编写一章“基础知识介绍”来进行专门介绍。2.2.6系统安装系统安装部分应该包括如下内容：1）硬件环境要求说明：系统运行时所需硬件环境描述，包括机型、内存大小、硬盘空间等。如果需要，还应该包括输入/输出设备、通迅环境等。2）软件环境要求说明：系统运行时所需软件支持环境描述，包括所需其它软件的名称及版本号等。3）其它环境要求说明〖条件〗：应该说明要求的任何其它环境。4）硬件安装〖条件：如果必要，应该详细说明系统所需硬件环境的安装过程。5）建立软件备份〖条件〗：如果条件容许，应该告诉用户如何作系统原介质上软件系统的备份，同时要求用户把系统的原介质作稳妥的保存，用系统的备份介质作系统安装。6）系统安装过程：这里要求给出最终用户能够据此把我们的软件系统安装到其操作环境的任何必要信息和操作。例如，环境变量的设置、系统配置描述格式等。2.2.7系统操作说明系统操作说明是用户手册的主体，主要包括系统起动、输入的命令和数据、软件的功能、输出结果、出错信息及其矫正和恢复方法。1）系统起动：应给出系统起动的详细过程。2）各种操作、命令和语言:软件系统的使用过程都是使用软件系统提供的各种操作、命令和语言的过程。操作和命令：在用户手册中详细给出各种操作的过程和功能、命令的格式和功能；应当描述在使用上的各种限制，如，操作状态、操作条件、操作序列等。另外，必要时可以通过适当的举例讲述各种操作和命令的使用方法，以帮助用户理解。输出信息：应该详细列出与操作、命令相关的各种输出信息。如果输出信息的意思本身不是很明显，应当给予解释。另外还应当说明对于这些信息所采取的操作。程序设计语言〖条件〗：如果我们的软件系统提供了某种语言，对其语言规则应当给予说明。关于程序设计语言的用户手册的内容，其详细说明我们以后补充。3）各种数据：在软件的使用过程中，用户必须与各种数据和信息打交道。为了让用户能够操作我们的软件，我们必须为用户提供各种结构以及每个数据元素的含义。有些数据适合在系统操作说明中给出，有些适合在后面的附录中给出，甚至有些除了在操作说明的同时给出外，还要在附录中给予归纳，这些都由用户手册编写人员根据实际况来决定。这些数据包括：输入数据〖条件〗：应该给出数据的内容、逻辑结构、格式以及每一个数据元素的意思。如果输入数据依赖于某特定数据介质，则应当给予说明。输出数据：应当给出软件以何种形式输出的数据的内容和格式，并要求以例样的形式给予说明。中间数据〖条件〗：如果我们告诉用户在软件的运行过程中所产生的中间数据的内容和格式，有助于用户理解软件的使用，则应当给予说明。数据限制〖条件〗：如果对数据有限制，如数据的大小限制，则应当给予说明。数据文件〖条件〗：如果要告诉用户我们的软件所使用的某些数据文件的结构有助于用户理解我们软件的使用，则应给予说明，但应该注意技术保密。如果对数据文件有所限制，例如每个文件的最大记录数、每个磁盘的最大文件数等，应当给予说明。4）处理过程〖条件〗：如果我们简要地给用户描述我们软件对用户的操作、输入的命令和输入数据的处理过程，有助于用户了解我们软件的使用，则应给予说明。5）出错处理：应当给出各种出错情况以及相应的处理措施。6）操作技术〖条件〗：有些软件的操作可能需要一定的技术和经验，才能获得满意的结果，那么应该在用户手册上尽量给出这些技术和经验的描述，或告诉用户如何才能获得这些技术和经验。例