说明书排版要求规范印刷版.docx

1、说明书排版要求规范印刷版说明书排版规Version：特殊标识符：表示阿拉伯数字。_：表示一个空格。：表示箭头为箭尾的子菜单，且为箭尾的下一步操作。：表示词汇表中词汇与解释的连接。说明：此规随着使用会发生变动和不断完善，此版仅供参考。 2008 Neware. 所有，翻印必究。2008年10月 version 1.0第1章 说明 4第2章 排版规 52.1 封面 52.2 目录 52.3 正文容与附录 5标题 6段落 6句子 6表格与图标 7软件界面图片 8标点符号 10注、注意、警告 102.4 词汇表 112.5 索引 122.6 其他方面 12页面设置 13页眉与页脚 13附录 14汉语写

2、作的相关规定 14“的、地、得”用法 14第1章 说明此文档主要用于规说明书排版，统一说明书格式，为提高说明书质量提供标准和依据。本文档只适用于word2003。公司所有产品说明书必须按照此规来进行撰写。第2章 排版规说明书应该依次包括封面、目录、正文容、附录、词汇表、索引几个部分，下面分别介绍这几部分的编排规及其他方面的设置规则。2.1 封面说明书的封面应遵循以下规则：1.封面有两页；2.第一页封面的信息应该包括说明书名称、设备版本号。名称的中文字体属性为华文宋体、小二、加粗、全角字符，英文、数字字体属性为Times New Roman、18pt、加粗、半角字符，段落属性为右对齐；设备版本号

3、的格式为：“Version：版本号”，英文、数字字体属性为Times New Roman、10pt、加粗、半角字符，段落属性为两端对齐；3.第二页封面的信息包括说明书中特殊标识符的定义及声明、说明书版本。“特殊标识符”中文字体属性为黑体、五号、加粗、全角字符，英文字体属性为Times New Roman、10.5pt、加粗、半角字符；特殊标识符定义的格式为“特殊标识符：解释”，中文字体属性为黑体、小五、全角字符，特殊标识符加粗，英文、数字字体属性为Times New Roman、9pt、半角字符、特殊标识符加粗，冒号格式与特殊标识符相同。声明及说明书版本中文字体属性为黑体、小五、全角字符，英文

4、、数字字体属性为Times New Roman、9pt、半角字符。2.2 目录说明书的目录应遵循以下规则：1.目录页面的标题中文字体属性为华文宋体、小三、加粗、全角字符，英文字体属性为Times New Roman、15pt、加粗、半角字符；2.目录最多三层；3.一级目录的中文字体属性为黑体、四号、加粗、全角字符，英文、数字字体属性为Times New Roman、14pt、加粗、半角字符；4.二级目录的中文字体属性为黑体、五号、加粗、全角字符，英文、数字字体属性为Times New Roman、10.5pt、加粗、半角字符；5.三级目录的中文字体属性为黑体、小五、全角字符，英文、数字字体属性

5、为Times New Roman、9pt、半角字符；6.一级目录无缩进，二级目录比一级目录缩进2个字符，三级目录比二级目录缩进2个字符；7.一级标和二级目录的段落属性为两端对齐，单倍行距，段前间距为0.5行、段后间距为0行。三级目录段落属性为两端对齐，单倍行距，段前间距为0行，段后间距为0.1行。2.3 正文容与附录正文容主要是向用户介绍产品功能、指导用户如何正确使用产品；附录是用来对产品使用的相关补充、售后服务及责任声明等。对于正文容与附录部分，从以下几方面进行规定。标题说明书中的标题，遵循以下规则：1.高一级标题下不应只有一个次级标题，同时避免孤立的章节和标题存在；2.标题要避免孤立编号，

6、正文不要有孤立二、三标题，孤立的Block Label样式；3.说明书中最多出现三级标题，一级标题前中文说明书编号为“第章”，英文说明书编号表示为“Chapter ”；二级标题前中文与英文说明书编号同表示为“.”；其中“”为章节数，用阿拉伯数字表示，从1开始。标题编号采用项目编号方式。三级标题前中文与英文说明书都无编号；4.编号与标题间空一格；5.一级标题的中文字体属性为华文宋体、四号、加粗、全角字符，英文、数字字体属性为Times New Roman、14pt、半角字符；6.二级标题的中文字体属性为华文宋体、小四、加粗、全角字符，英文、数字字体属性为Times New Roman、12pt、

7、加粗、半角字符；7.三级标题的中文字体属性为华文宋体、五号、加粗、全角字符，英文、数字字体属性为Times New Roman、10.5pt、加粗、半角字符；8.标题段落属性均为无缩进，两端对齐，单倍行距，段前间距为0.5行、段后间距为0行。段落说明书中的段落，遵循以下规则：段落的中文、符号字体属性为华文宋体、小五、全角字符，英文、数字字体属性为Times New Roman、9pt、半角字符；段落属性为无缩进，两端对齐，单倍行距，段前间距为0行、段后间距为0.1行。句子说明书中的句子，遵循以下规则：1.正文中若需项目列表，一级列表编号中英文同为阿拉伯数字，二级列表编号使用项目符号“”，其下不

8、可再嵌入子项目列表；2.句子中可以出现图形，但不能改变行间距；3.讲述产品的操作时，句子中出现的产品相关词汇需加引号并加粗显示，但不得改变字体大小和字体种类，引号格式与词汇相同。当用产品相关词汇描述一连串的操作动作，后者是前者的下一步同时是其子菜单时，则词汇之间用“”连接，但若词汇之间有文字性描述，则不用其连接，“”的格式与词汇相同。如：例1，点击Windows“开始”“所有程序”“neware”“TC52”“BTSDA”，启动软件；例2，点击“导出”，选择“TXT、EXCEL或 PDF”中任意一种。表格与图标对于说明书中的表格和图像遵循以下规则：1.表格一行中的单元要求不跨页；2.表格的题注

9、在紧接表格的上方，中文文档格式为“表_名称”，英文文档格式为“Table_名称”。其中“_”为一个空格，“”为阿拉伯数字，从1开始，全文统一编号，中文字体属性为华文宋体、小五、全角字符，英文、数字字体属性为Times New Roman、9pt、半角字符。段落属性为居中。无边框表格不需题注，不按此规则；3.每个表格的下方都要空一行，这一空行的样式为正文。在遇换页的特殊情况下，若表格后的空行为页面第一行，空行需删除。无边框表格不需按此规则，随使用单独规；4.禁止使用第三方的商标、图标、图形；5.所有VISIO绘制的组网图一律另存为*.WMF格式，才能在WORD中插入；6.图中的文本：中文华文宋体

10、，小五，全角字符；字母与数字Times New Roman，9pt，半角字符；7.图形的题注紧接图形的下方，中文文档格式为“图_名称”，英文文档格式为“Figure_名称”。其中“_”为一个空格，“”为阿拉伯数字，从1开始，全文统一编号，中文字体属性为华文宋体、小五、全角字符，英文、数字字体属性为Times New Roman、9pt、半角字符。段落属性为居中；8.若要介绍图形中的某些部分名称，可对这些部分分别加标注，标注形式为阿拉伯数字，从1开始，若要解释的部分在图形中不清晰，可引出图形放大部分与原图形一起进行标注；对标注从1开始进行解释，有两种情况，一是简单解释其名称，紧接图形题注的下方使

11、用无边框表格来描述，居中显示，中文字体属性为黑体、五号、全角字符，英文与数字字体属性为Times New Roman、10.5pt、加粗、半角字符；一是要一并介绍其功能，紧接图形题注下方使用表格来描述。标号与解释之间空一格，两种情况格式如下：图 1 机箱外形情况一：解释名称1 电源及状态指示灯2 电源开关3 通道工作指示灯(共八个)4 164插座情况二：解释名称与介绍功能：表 1 表格示例1 电源及状态指示灯用于显示电源及状态。2 电源开关控制电源打开关闭。3 通道工作指示灯共8个，用于表示通道的工作状态。4 164插座用来连接鳄鱼夹具。9.图形解释（使用无边框表格的情况一）下方需空一行，这一

12、空行的样式为正文。在遇换页的特殊情况下，若表格后的空行为页面第一行，空行需删除。软件界面图片在描述上位机和中位机软件界面时，容遵循以下规则:1.包含软件启动的主界面图片；2.包含相关功能的主界面图片，如上位机BGS客户端功能性主界面的当前界面:常规显示、列表显示、工步显示、容量分选、电池配组、大小图标切换显示、小图标里:电压显示、电流显示、容量显示、时间显示；历史界面的显示。3.界面图片的描述方式：方式一：通过箭头引出说明。图 2 BTSDA.exe软件主界面方式二：通过在表格中图片加文字描述说明。表 2 工步参数设置记录条件 包括 时间间隔 、电压变化 及 电流变化三个选项，可以同时选择多项

13、有效。各项记录条件之间是 逻辑或 的关系，只要其中任意一项满足，就记录一次数据。恰当地选择记录条件可使数据文件尽可能小，但却不漏掉关键性的数据。提高数据处理的速度。“安全保护”主要是针对测试过程中，电池电流、电压采样异常的通道进行硬件保护。具体设置以锂电为例，通常锂电放电电压为2.75V，充电电压为4.20V，安全保护参数上下限电压可参考设置为2.54.3V。本系统定义充电电流为“+”，放电为“-”，设置安全保护时务必注意，如设置充、放电电流为700mA，“安全保护”中“电流围”数值应大于700mA，不是电流偏差。备注信息 的容会自动存入数据文件，以备查询或打印。方式三：通过注释，放大界面中的

14、主要标签、结构、图样等。标点符号说明书中的标点符号遵循以下规则：1.如果是中文说明书，使用中文的标点符号，不论句子的结束文字是英文或是中文；如果是英文说明书，使用英文标点符号；2.标点符号无论中英文下均为半角字符；3.半字线常用于汉字和数字（字母）之间：铀235、惠普5000；4.一些外来的词汇中常用短划线：E-Mail、CD-ROM、ITU-T、8-bit；5.浪纹符用于表示数量的围：13；6.长横常用于地名之间：。注、注意、警告说明书中要添加注、注意、警告三种提示语，以便用户更好地理解使用产品。它们遵循以下规则：1.注：表示可以帮助用户更好地使用产品，图标为“”；2.注意：表示可能会损坏硬

15、件或导致数据丢失，并告诉用户如何避免该问题，图标为“”；3.警告：表示可能会导致财产损失、人身伤害甚至死亡，图标为“”；4.图标从本文档中复制使用，三种图标大小均设置为高0.56cm，宽0.56cm；5.三种提示中文说明书表示形式为“图标_注/注意/警告：容”，英文说明书表示形式为“图标_Note/Notice/Caution:_容”，其中“_”为一个空格，“容”为提示容；6.三种提示（含提示容）中文字体属性为黑体、小五、加粗、全角字符，英文与数字字体属性为Times New Roman、9pt、加粗、半角字符。7.注、注意、警告的图标及其容放在无边框表格中。图片格式和表格属性请参看下例。例：

16、注意：循环序号/过程序号/记录序号为必须显示的容，不可选。注：循环序号/过程序号/记录序号为必须显示的容，不可选。警告：循环序号/过程序号/记录序号为必须显示的容，不可选。2.4 词汇表词汇表用来提供术语的解释。词汇表应遵循以下规则：1.词汇表只有一级标题，即词汇表页面的标题，中文字体属性为华文宋体、小三、加粗、全角字符，英文字体属性为Times New Roman、15pt、加粗、半角字符。标题前无编号；2.英文说明书的词汇按字母升序排列。中文说明书的词汇表，若有中英文两种词汇，则分为“英文”、“中文”，分别进行升序排序，“中文”再分为“A、B”，将中文词汇按字母顺序进行分类并升序排序；若无

17、英文词汇，则分为“A、B”，将词汇分类并升序排序。“英文”、“中文”字体属性为华文宋体、四号、加粗、全角字符，“ABCD”字体属性为Times New Roman、12pt、加粗、半角字符；3.词汇表中的词汇中文字体属性为华文宋体、五号、加粗、全角字符，数字与英文字体属性为Times New Roman、10.5pt、加粗、半角字符；4.词汇表中关于词汇的解释中文字体属性为华文宋体、五号、全角字符，数字与英文字体属性为Times New Roman、10.5pt、半角字符；5.词汇与解释之间用符号“”连接，其格式与词汇相同；6.整个词汇表（包括标题与全部容）的段落属性为无缩进，两端对齐，单倍行

18、距，段前间距为0行、段后间距为0.5行。例：中文说明书词汇表（含英文词汇）图 3 中文说明书词汇表示例2.5 索引索引是把文档等资料中的项目或容摘记下来，每条下标注出处页码，按一定的次序排列，供人查阅的资料。对于说明书中的索引，遵循以下几条规则：1.索引只有一级标题，即索引页面的标题，中文字体属性为华文宋体、小三、加粗、全角字符，英文字体属性为Times New Roman、15pt、加粗、半角字符。标题前无编号；2.索引的排序与词汇表一致，参照2.4节第2点；3.索引最多两层；4.一级索引加粗显示，二级索引不加粗；一级索引无缩进，二级索引比一级索引缩进2个字符；5.索引项中文字体属性为华文宋

19、体、五号、全角字符，英文、数字字体属性为Times New Roman、10.5pt、半角字符；6.整个索引（包括标题与全部容）的段落属性为两端对齐，单倍行距，段前间距为0行、段后间距为0.5行。2.6 其他方面页面设置页面统一国际标准A5型纸排版，上下页边距为2.41cm，左右页边距为1.45cm。页眉与页脚说明书中的页眉页脚遵循以下规则：1.说明书封面的第二页无页眉页脚，目录无页眉；2.页眉中的中文字体属性为华文宋体、五号、全角字符，英文、数字字体属性为Times New Roman、10.5pt、半角字符；3.页眉的段落格式为两端对齐；4.页眉左端插入公司的商标，高0.58cm，宽1.7

20、2cm，右端为该说明书的名称；5.页脚的中文字体属性为华文宋体、小五、全角字符，英文、数字字体属性为Times New Roman、9pt、半角字符；6.第一页封面的页脚段落格式为居中；其他页面页脚的段落格式奇数页为右对齐，偶数页为左对齐；7.第一页封面的页脚依次插入公司名称、公司网址、公司；其他页面的页脚中英文文档格式奇数页为“该章标题_该页页号”，偶数页为“该页页号_该章标题”，其中“_”为一个空格；页号为阿拉伯数字。附录汉语写作的相关规定为了提高中文说明书的质量，让字、词、句的用法更加符合现在汉语表达的规定和习惯，现在做出如下规定，介于汉语表达的灵活性和复杂多变，此规定仅作参考。“的、地

21、、得”用法从汉语言文学的语法来说明“的、地、得”在不同语言环境中的用法及其读音规定。1.“的”是通用的，可以作为的、地、得的替代语，日常都可以通用。严格来说，上述三字是组成语句的短语（词组）的虚词之一。“的”常用在介宾词组，表达一种描述后的结果，通常用在名词、形容词后。 “地”常用在动宾词组，也是一种描述的后果，通常用在名词、动词、形容词后。“得”常常表示一种后果，常出现在动补词组，表示一种状态，一种结果，通常用在动词后，作为动补状语出现。2.使用“de”语法结构：修饰限制+的+名词；修饰限制+地+动词；动词（形容词）+得+补充说明。3.“的、地、得”用法举例:“的”后面跟的都是名词，例如，我

22、们的家乡，美丽的家乡，强壮的小伙.“地”后面跟的都是表示动作的词，例如，项目在快速地推进、工程师们紧地开始工作.“得”前面跟的多数是动词，后面跟的都是形容词，表示怎么怎么样的，如“扫得真干净，笑得多甜啊.”如果“de”的后面是“很、真、太”等这些词，一般用“得”。4.“的”、“地”、“得”附着在词或词组后面，在句子中起结构作用时，都读作“de”，在书写时却要写成三个不同的字，所以非常容易发生混淆。用得对，意思表达就明确，用得不对，有时也会产生非表达者意愿的“意义错位”。比如：看了这场球赛，他激动得叫了。看了这场球赛，他激动得叫了。这两句话从表面看只是一字之差，但意思不完全相同。前一句强调“激动”，“叫了”是对激动程度的补充说明。后一句主要是述“叫了”，“激动”是对叫的样子的修饰。因此两句用了不同的“de”。