用户手册编写规范

用户手册编写规范

书目

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为小节号码，用阿拉伯

数字表示。小节的编号后面空一个半角的格，然后是这一小节的标题。

1）不必专为小节另起一页起先；

2）小节的编号和标题从左边起先顶格竹写；

3）小节的编号和标题采纳黑体小四号字；

4）小节的编号和标题与其前后的正文之间均空一行。

【留意】

1）一般状况下，章的下面可以划分为节和小节，但要具体状况具体分析。恨如没有划分

小节的必要，则可以划分到节为止；而且，假如有必要，还可以在小节下面划分更小的

节，我们暂且称之为小小节。

1.2版面设置

版面设置

对于版面设置我们作如下规定：

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用户手册的内容

规定用户手册所要达到的目标、包含的内容、以及编写的风格。

假如标题后跟有“K条件F”字样，说明该标题下正文所要求的内容是在肯定条件下所

必需的。

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基础学问介绍K条件X

用户手册编写人员应当依据实际状况确定是否须要这一部分。

在一般状况下，运用我们的软件系统须要肯定的基础学问。这些学问可以从有关书籍上

得到，但是用户从这些资料得到这些学问须要花费相当的时间。在某些状况3我们只

须要用户驾驭用户手卅中运用的那些概念，那么我们就有必要编写一章“基础学问介绍”

来进行特地介绍。

2.2.6系统安装

系统安装部分应当包括如下内容：

1）硬件环境要求说明：系统运行时所需硬件环境描述，包括机型、内存大小、硬投空间

等。假如须要，还应当包括输入/输出设备、通迅环境等。

2）软件环境要求说明：系统运行时所需软件支持环境描述，包括所需其它软件的名称及

版本号等。

3）其它环境要求说明K条件》：应当说明要求的任何其它环境。

4）硬件安装K条件：假如必要，应当具体说明系统所需硬件环境的安装过程。

5）建立软件备份K条件?：假如条件容许，应当告知用户如何作系统原介质上软件系统

的备份，同时要求用户把系统的原介质作稳妥的保存，用系统的备份介质作系统安装。

6）系统安装过程：这里要求给出最终用户能够据此把我们的软件系统安装到其操作环境

的任何必要信息和操作。例如，环境变量的设置、系统配置描述格式等。

2.2.7系统操作说明

系统操作说明是用户手册的主体，主要包括系统起动、输入的吩咐和数据、软件的功能、

输出结果、出错信息及其矫正和复原方法。

1）系统起动：应给由系统起动的具体过程。

2）各种操作、吩咐和语言：软件系统的运用过程都是运用软件系统供应的各种操作、吩

咐和语言的过程。

•操作和吩咐：在用户手册中具体给出各种操作的过程和功能、吩咐的格式和功能；应

当描述在运用上的各种限制，如，操作状态、操作条件、操作序列等。另外，必要时

可以通过适当的举例讲解并描述各种操作和吩咐的运用方法，以帮助用户理解。

•输出信息：应当具体列出与操作、吩咐相关的各种输出信息。假如输出信息的意思本

身不是很明显，应当赐予说明。另外还应当说明对于这些信息所实行的操作。

•程序设计语言K条件假如我们的软件系统供应了某种语言，对其语言规则应当赐

予说明。关于程序设计语言的用户手册的内容，其具体说明我们以后补充。

3）各种数据：在软件的运用过程中，用户必需与各种数据和信息打交道。为了让用户能

够操作我们的软件，我们必需为用户供应各种结构以及每个数据元素的含义。

有些数据适合在系统操作说明中给出，有些适合在后面的附录中给出，甚至有些除了在

操作说明的同时给出外，还要在附录中赐予归纳，这些都由用户手册编写人员依据实际

况来确定。这些数据包括：

•输入数据K条件X：应当给出数据的内容、逻辑结构、格式以及每一个数据元素的意

思。假如输入数据依靠于某特定数据介质，则应当赐予说明。

•输出数据：应当给出软件以何种形式输出的数据的内容和格式，并要求以例样的形式

赐予说明。

•中间数据K条件讥假如我们告知用户在软件的运行过程中所产生的中间数据的内容

和格式，有助于用户理解软件的运用，则应当赐予说明。

•数据限制K条件1：假如对数据有限制，如数据的大小限制，则应当赐予说明。

•数据文件K条件讥假如要告知用户我们的软件所运用的某些数据文件的结构有助于

用户理解我们软件的运用，则应赐予说明，但应当留意技术保密.假如对数据文件有

所限制，例如每个文件的最大记录数、每个磁盘的最大文件数等，应当赐予说明。

4）处理过程K条件］：假如我们简要地给用户措述我们软件对用户的操作、输入的吩咐

和输入数据的处理过程，有助于用户了解我们软件的运用，则应赐予说明。

5）出错处理：应当给出各种出错状况以及相应的处理措施。

6）操作技术K条件》：有些软件的操作可能须要肯定的技术和阅历，才能获得满足的结

果，那么应当在用户手册上尽量给出这些技术和阅历的描述，或告知用户如何才能获得

这些技术和阅历。例如，在操作SEAS系统作图纸净化处理时，如何选择适当的阀值就是

须要肯定的技术和阅历的问题。

【警告】在编写软件用户手册的系统操作说明时，我们在确定是否供应某种数据的格式

时，应以不泄漏公司的技术而且有利于用户运用为准则。

2.2.8系统及数据维护

应当给出用户数据的后备、复原、删除、整理的具体过程。假如必要，应当给出系统数

据、系统磁盘空间维护的具体过程。

2.2.9例题K条件》

有些软件系统可以通过一个较为完整的例题演示系统的大部分功能的运用方法，在这个

例题中，用户应当具体地描述每一步的操作过程，用户可以通过这个例题对系统的操作

有一个初步的了解。

2.2.10各种附录

在用户手册中，有些学问和信息可以通过附录的形式供应应用户，以便于用户查阅，这

些内容是：

1）错误提示信息：通常可以以表的形式依据肯定的依次，例如按出错提示信息编号依次、

或按出错提示信息的字母依次，给出出错提示信息的编号、提示信息、相应的说明、出

错缘由和解决方法。

2）吩咐速杳表R条件51：通常可以以表的形式依据肯定的依次给出各种吩咐的概要（包括

吩咐名称、各种参数、及相应的功