用户手册编制规范
[pic] 用户手册编制规范 沈阳东大阿尔派软件股份有限公司 2000.2 1. 版权声明 《用户手册编制规范》的版权归沈阳东大阿尔派软件股份有限公司所有。未经沈阳东大 阿尔派软件股份有限公司的书面准许，不得将本规范的任何部分以任何形式、采用任何 手段(电子的或机械的，包括照相复制或录制)、或为任何目的，进行复制或扩散。 (c)Copyright 2000 沈阳东大阿尔派软件股份有限公司。版权所有，翻制必究。 [pic] 是沈阳东大阿尔派软件股份有限公司的注册商标。 Microsoft、word是Microsoft Corporation的注册商标。 Windows是Microsoft Corporation的商标。 前 言 用户手册对于任何产品都是不可缺少的组成部分。一个好的产品没有一份完备的用户 手册，也不能算作一个完备的产品。对于软件产品来说更是如此，没有用户手册的软件 不能算产品，没有好的用户手册，就不可能算好产品。也就是说，一个好的软件产品除 了具备与市场对路的思想、良好的用户界面、完备的测试之外，还必须有一本适合用户 使用的用户手册。 本规范手册不仅指明了软件用户手册的内容，而且规定了沈阳东大阿尔派软件股份有 限公司软件用户手册的统一版面、格式。本规范手册就是按本规定编写的，但由于本规 范手册内容的局限性，很难以样本的形式表现软件用户手册中可能出现的各种情况，所 以请大家认真阅读本规范手册的内容。 我们希望沈阳东大阿尔派软件股份有限公司的相关人员，能够按照本规范手册编写自 己的软件用户手册，做好我们的软件产品化工作。由于时间仓促，编者水平有限，希望 大家能够提出宝贵意见，以逐步完善本规范手册的内容。 阅读指南 〖手册目标〗 本手册主要对沈阳东大阿尔派软件股份有限公司软件产品的用户手册所应包含的内容 及版面格式作一个初步的统一规定。由于实际情况千变万化，本规定很难一次做到面面 俱到，需要逐渐完善。 〖阅读对象〗 本手册是为沈阳东大阿尔派软件股份有限公司的所有软件开发人员和软件用户手册编 写人员所编写的。由于本手册中的格式规定部分是根据 Microsoft Windows 下的 Word 的功能而编写的，所以沈阳东大阿尔派软件股份有限公司的软件用户手册应该使用 MicroSoft Word排版。 〖手册构成〗 本手册基本上由两部分组成： 1. 第1章，“关于用户手册排版格式的规定”，规定了用户手册标题及编号的格式。 2. 第2章，“用户手册的内容”，规定了用户手册所应包含内容较为详细的清单。 另外，本手册基本上是按“用户手册格式的统一规定”编写的一个样本。 〖手册约定〗 本手册遵循以下约定： 1. 所有标题均使用黑体字。 2. 如果标题后跟有“〖条件〗”字样，说明该标题下正文所要求的内容是在一定条件下 必须的。 【注意】的意思是请读者注意那些需要注意的事项。 【警告】的意思是请读者千万注意某些事项，否则将造成严重错误。 目 录 第1章 用户手册格式规定 1-1 §1.1 标题及编号 1-1 §1.1.1 章标题的设置 1-1 §1.1.2 节标题的设置 1-1 §1.1.3 小节标题的设置 1-1 §1.1.4项目符号和编号的设置 1-2 §1.1.5 其它编号的设置 1-3 §1.2 正文及页眉页脚的排版 1-4 §1.2.1 正文排版 1-5 §1.2.2 版面设置 1-5 §1.2.2.1 版面设置 1-5 §1.2.2.2 关于页眉、页脚的设置 1-5 §1.2.2.3 注意与警告 1-5 第2章 用户手册的内容 2-1 §2.1 用户手册的目标 2-4 §2.2 用户手册的内容 2-4 §2.2.1 封面 2-4 §2.2.2 二封 2-4 §2.2.3 版权声明 2-4 §2.2.4 前言 2-4 §2.2.5 阅读指南 2-5 §2.2.6目录 2-5 §2.2.7基础知识介绍〖条件〗 2-5 §2.2.8 系统安装及启动 2-6 §2.2.9 系统操作说明 2-7 §2.2.9 1 CAD软件 2-7 §2.2.9 2 其它软件 2-9 §2.2.10 系统及数据维护 2-9 §2.2.11 例题〖条件〗 2-10 §2.2.12 各种附录 2-10 §2.3 用户手册的风格 2-11 第1章 用户手册格式的规定 §1.1 标题及编号 一般情况下，用户手册用章、节来划分其内容，必要时还可引入小节、小小节的概念 。 §1.1.1 章标题的设置 每章的编号用阿拉伯数字表示，采用“第1章”、“第2章”、……的形式表示章的编号 ，章的编号后面空一个半角的格，然后是这一章的标题。 1. 章必须另起一页开始打印。 2. 章的编号和标题采用左对齐的格式放在行的左边，左缩进为0。 3. 章的编号和标题中汉字采用黑体小三号字，章的编号和标题总长度不能超过一行 。 4. 章的编号和标题行距取最小值、12磅，段前、段后分别取24磅。 §1.1.2 节标题的设置 节的编号格式为“§x.y”。其中，x为章的号码，y为节的号码，用阿拉伯数字表示 。节的编号后面空一个半角的格，然后是这一节的标题。 1. 原则上每一节另起一页开始打印，但对于每章的第一节，如果章标题下无说明文 字，可以将其与章标题放于一页之中。 2. 节的编号和标题采用左对齐的格式放在行的左边，左缩进为0。 3. 节的编号和标题中汉字采用黑体四号字，节的编号和标题总长度不能超过一行。 4. 节的编号和标题行距取最小值、12磅，对于与章标题处于同页的要将其段前、段 后均取12磅，否则段前取24磅、段后取12磅。 §1.1.3 小节标题的设置 小节的编号格式为“§x.y.z”。其中x为章的号码，y为节的号码，z为小节号码，用 阿拉伯数字表示。小节的编号后面空一个半角的格，然后是这一小节的标题。 1. 小节不必另起一页开始打印。 2. 小节的编号和标题采用左对齐的格式放在行的左边，左缩进0.74CM。 3. 小节的编号和标题中汉字采用黑体小四号字，小节的编号和标题总长度不能超过 一行。 4. 小节的编号和标题行距取最小值、12磅，段前取12磅。 【注意】 1. 如果有必要，还可以在小节下面划分更小的节，我们暂且称之为小小节。 2. 对于小小节的各种规定与小节一致，为保持版面清晰，小小节不再相对于小节向 右缩进。 3. 在用户手册中，系统提示信息采用幼圆五号字，其余所有的数字及字母采用Ar ial字体，字号与相应的汉字相同。在本规范中提到的字体如无特殊注明，均 指汉字字体。 4. 用户手册中，行距均取最小值、12磅。 §1.1.4 项目符号和编号的设置 在章、节、小节、小小节里面均可以含有项目符号和编号。 1. 编号 1) 编号序列相对于与之对应的标题向右缩进0.74CM。 2) 编号的格式是“n.”，其中n为阿拉伯数字。 3) 对于有名编号序列名称采用五号黑体汉字，其后面的内容采用五号宋体汉字 ；对于无名编号序列中的内容字体同有名编号序列。 4) 编号序列里还允许采用二级编号序列，其格式规定如下：“n)”，其中n为阿 拉伯数字。 5) 二级编号相对于与之对应的一级编号向右缩进0.74CM。 6) 其它规定和一级编号序列一致。 7) 编号及二级编号的行间距取最小值，12磅。一级编号的第一项段前取12磅， 其余各项及二级编号段前均取6磅。 2. 项目符号 1) 项目符号相对于与之对应的标题或编号序列向右缩进0.74CM。 2) 项目符号的格式是“(”，其中“(”字体为Wingdings，五号字。 3) 对于有名项目符号序列，名称采用五号黑体汉字，其后面的正文采用宋体五 号字，对于无名项目符号序列中的内容字体同有名编号序列。 4) 如果项目符号序列处于编号序列的下级，则各项各项段前均取6磅；否则首 项段前取12磅，其余各项段前取6磅。 【注意】项目符号和编号下的叙述文字相对于与之对应的项目符号或编号向右缩进0 .74CM，首行缩进0.74CM，段前取6磅。汉字字体取宋体五号。 §1.1.5 其它编号的设置 1. 页编号：用户手册中的正文按章进行编号，其格式为“章- 页”。如，第2章的第3页，编号为“2- 3”。页编号放在页脚中，具体设置方法详见“页眉、页脚设置”。 2. 图、表编号： 用户手册中的图、表均按章分别进行编号，其格式分别为“图x-y”、“表x- y”。如，第2章的第3幅图的编号是“图2-3”；第2章的第3张表格的编号是“表2- 3”。在图表编号的后面空一个半角的格，然后是这一图表的名称。另外，还规定 ： 1) 表的编号与名称放在表的顶部。 2) 表的编号与名称和表左对齐，而整个表则居中放置。 3) 表的编号与名称段后取6磅。 4) 图的编号与名称放在图的底部。 5) 图的编号与名称和图均居中放置。 6) 图的编号与名称段前取6磅。 7) 图前面的正文段后取12磅。 8) 图、表的编号与名称中汉字采用黑体五号字。 §1.2 正文及页眉、页脚的排版 §1.2.1 正文排版 正文排版包括字符排版、段落排版、图形排版和版权声明、目录等的排版，本节 就这几方面的格式要求加以详细阐述。 1. 字符排版： 1) 用户手册的正文，系统提示采用幼圆五号字体，其余采用宋体五号字。 2) 对于界面中的按钮名称，应把按钮名称用“〈〉”括起来，按钮名称用黑体五 号字书写。对于下拉菜单选项的名称，应用“”引起来，选项名称用宋体五 号字书写。对于热点，应用“”引起来，热点名称用黑体五号字书写。 3) 正文均采用常规字体、标准位置、标准间距。 2. 段落排版： 1) 正文段落的首行相对于与之对应的标题或编号序列向右缩进0.74CM。 2) 行距采用最小值，12磅，除项目符号及编号以及图形前面正文按前面所述的 特殊要求进行排版外，其余段前均取12磅。 3) 采取两端对齐方式。 3. 图形的排版： 1) 屏幕截图时，应使所截图片的尺寸为最大。 2) 对于尺寸较大的图片，可使图片的高度和宽度按同比例适当缩小。 3) 必要时可适当缩小或将图片移到下一页，以保证图片与图号及图名在同页。 4) 当正文中对图标进行说明时，应使图标同与之对应的标题对齐。 5) 为保证页面清晰，可适当调整图标右侧说明文字的行间距以及段前、段后。 6) 在屏幕截图时，图片中输入的数据不能包含本公司员工的真实姓名。 4. 版权声明、目录等的排版： 版权声明、前言、阅读指南、目录的标题为段前取36磅，段后取24磅，采用黑 体小三号字；内容排版与手册正文排版相同。 §1.2.2 版面设置 §1.2.2.1 版面设置 对于版面设置作如下规定： 1. 纸张大小：用户手册用纸统一规定为16开。 2. 页边距：上：30mm；下：20mm；内侧：21mm；外侧：16mm。另外采用“对称页边 距”；对于版面设置页眉、页脚应选用“首页不同”和“奇偶页不同”。 3. 对于新项目或新产品可根据具体情况对版面设置适当做一些修改。 §1.2.2.2 关于页眉、页脚的设置 1. 页眉的设置： 1) 版权声明、前言、阅读指南、目录均无篇眉。 2) 章编号和名称所在页的篇眉为一行有50%填充的边框。 3) 对于单号页，页眉的内容是当前章的标题名，要求打印在纸的右上角。 4) 对于双号页，页眉的内容是用户手册的名称，要求打印在纸的左上角。 5) 纸的顶边与页眉的距离是23mm。 6) 页眉中汉字采用幼圆小五号字。 2. 页脚的设置： 1) 页脚的内容是当前页的页编号，如第2章第2页为2-2。 2) 页编号的字体采用Arial五号字。 3) 纸的底边与页脚的距离是13mm。 4) 版权声明、前言、阅读指南、目录的页脚为ⅰ，ⅱ等，居中放置，不带边框。 §1.2.2.3 注意与警告 在用户手册中，对于那些需要用户特别注意的事项，应该用“【注意】”作为标志 给用户以特别的提示。关于注意标志和注意事项的格式有如下规定： 1. 注意标志同与之对应的标题对齐。 2. 注意标志采用黑体小四号汉字。 3. 注意标志段前取12磅。 4. 如果注意事项只有一条，其内容应该紧跟在注意标志的后面书写；否则，应该在 注意标志的下一行开始，采用编号序列的形式分别给出。 在用户手册中，对于那些会给用户造成重大损失的行为，应该用“【警告】”作为 标志给用户以警告性的提示。 【注意】关于警告标志和警告事项的格式规定与关于注意标志和注意事项的格式规定 一致。 第2章 用户手册的内容 本章主要讨论编写用户手册所要达到的目标、软件用户手册所应包含的内容、以及在 用户手册编写过程中所应保持的风格。 如果标有“〖条件〗”字样，说明该部分内容是在一定条件下所必须的。 §2.1 用户手册的目标 某软件评测中心把软件产品评测测试分为两个阶段——初评安装测试和复评测试。只有 通过初评安装测试的软件才能进入复评测试，初评安装测试的内容包括： 1. 按照软件用户手册中的安装说明测试软件能否顺利安装成功。 2. 对照软件用户手册测试软件功能是否与手册描述一致。 3. 评价产品包装及用户手册是否符合商品化要求。 4. 通过以上三方面测试且无严重死机情况的软件可进入复评测试。 由此，我们可以看到软件用户手册是一个软件产品的基础，没有合格的软件用户手册 就根本谈不上合格的软件产品。另一方面，良好的安装说明及软件功能与手册描述的一 致性是对软件用户手册的两个基本要求。 我们编写的用户手册要达到两个目的： 1. 让用户手册成为用户学习使用...
用户手册编制规范