用户手册编写规范讲解.docVIP

用户手册编写规范  目录 用户手册格式的统一规定 章、节标题 版面设置 用户手册的内容 用户手册的目标 用户手册的内容 用户手册的风格  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）表和其后面的正文之间空一行