用户手册编写规范.pdfVIP

用户手册编写规范 用户手册编写规范 Ver1.0 目录 1. 用户手册格式的统一规定 1.1 章、节标题 1.2 版面设置 2. 用户手册的内容 2.1 用户手册的目标 2.2 用户手册的内容 2.3 用户手册的风格 沈阳东大阿尔派软件股份有限公司 用户手册编写规范 Ver1.0 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）一般情况下，章的下面可以划分为节和小节，但要具体情况具体分析。如果没有划分 小节的必要，则可以划分到节为止；而且，如果有必要，还可以在小节下面划分更小的 节，我们暂且称之为小小节。 沈阳东大阿尔派软件股份有限公司 用户手册编写规范 Ver1.0 2）对于小小节的各种规定与小节一致。 1.1.4 其它编号 1 2 3 ）页编号：用户手册中的正文按章进行编号，其格式为“章—页”。如，第章的第 页， 2-3 编号为“ ”。各种页编号的形式请参考本手册所采用的格式。 2 x-y ）图、表编号：用户手册中的图、表均按章分别进行编号，其格式分别为“图 ”、 x-y 2 3 2-3 2 3 “表 ”。如，第章的第 幅图的编号是“图 ”；第 章的第 张表格的编号是“表 2-3”。在图、表编号的编号后面空一个半角的格，然后是这一图表的名称。另外，还规 定：  表的编号与名称放在表的顶部