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

资源描述

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

《说明书排版规范印刷版.docx》由会员分享，可在线阅读，更多相关《说明书排版规范印刷版.docx（9页珍藏版）》请在冰豆网上搜索。

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

说明书排版规范印刷版

资料范本

本资料为word版本，可以直接编辑和打印，感谢您的下载

说明书排版规范（印刷版）

地点：

__________________

时间：

__________________

说明：

本资料适用于约定双方经过谈判，协商而共同承认，共同遵守的责任与义务，仅供参考，文档可直接下载或修改，不需要的部分可直接删除，使用时请详细阅读内容

说明书排版规范

Version：

特殊标识符

×：

表示阿拉伯数字。

_：

表示一个空格。

→：

表示箭头为箭尾的子菜单，且为箭尾的下一步操作。

—：

表示词汇表中词汇与解释的连接。

说明：

此规范随着使用会发生变动和不断完善，此版仅供参考。

2008年10月version1.0

TOC\o"1-3"\h\z\uHYPERLINK\l"_Toc216083515"第1章说明PAGEREF_Toc216083515\h4

HYPERLINK\l"_Toc216083516"第2章排版规范PAGEREF_Toc216083516\h5

HYPERLINK\l"_Toc216083517"2.1封面PAGEREF_Toc216083517\h5

HYPERLINK\l"_Toc216083518"2.2目录PAGEREF_Toc216083518\h5

HYPERLINK\l"_Toc216083519"2.3正文内容与附录PAGEREF_Toc216083519\h5

HYPERLINK\l"_Toc216083520"标题PAGEREF_Toc216083520\h6

HYPERLINK\l"_Toc216083521"段落PAGEREF_Toc216083521\h6

HYPERLINK\l"_Toc216083522"句子PAGEREF_Toc216083522\h6

HYPERLINK\l"_Toc216083523"表格与图标PAGEREF_Toc216083523\h7

HYPERLINK\l"_Toc216083524"软件界面图片PAGEREF_Toc216083524\h8

HYPERLINK\l"_Toc216083525"标点符号PAGEREF_Toc216083525\h10

HYPERLINK\l"_Toc216083526"注、注意、警告PAGEREF_Toc216083526\h10

HYPERLINK\l"_Toc216083527"2.4词汇表PAGEREF_Toc216083527\h11

HYPERLINK\l"_Toc216083528"2.5索引PAGEREF_Toc216083528\h12

HYPERLINK\l"_Toc216083529"2.6其他方面PAGEREF_Toc216083529\h12

HYPERLINK\l"_Toc216083530"页面设置PAGEREF_Toc216083530\h13

HYPERLINK\l"_Toc216083531"页眉与页脚PAGEREF_Toc216083531\h13

HYPERLINK\l"_Toc216083532"附录PAGEREF_Toc216083532\h14

HYPERLINK\l"_Toc216083533"汉语写作的相关规定PAGEREF_Toc216083533\h14

HYPERLINK\l"_Toc216083534"“的、地、得”用法PAGEREF_Toc216083534\h14

第1章说明

此文档主要用于规范说明书排版，统一说明书格式，为提高说明书质量提供标准和依据。

本文档只适用于word2003。

公司所有产品说明书必须按照此规范来进行撰写。

第2章排版规范

说明书应该依次包括封面、目录、正文内容、附录、词汇表、索引几个部分，下面分别介绍这几部分的编排规范及其他方面的设置规则。

2.1封面

说明书的封面应遵循以下规则：

封面有两页；

第一页封面的信息应该包括说明书名称、设备版本号。

名称的中文字体属性为华文宋体、小二、加粗、全角字符，英文、数字字体属性为TimesNewRoman、18pt、加粗、半角字符，段落属性为右对齐；设备版本号的格式为：

“Version：

版本号”，英文、数字字体属性为TimesNewRoman、10pt、加粗、半角字符，段落属性为两端对齐；

“特殊标识符”中文字体属性为黑体、五号、加粗、全角字符，英文字体属性为TimesNewRoman、10.5pt、加粗、半角字符；特殊标识符定义的格式为“特殊标识符：

解释”，中文字体属性为黑体、小五、全角字符，特殊标识符加粗，英文、数字字体属性为TimesNewRoman、9pt、半角字符、特殊标识符加粗，冒号格式与特殊标识符相同。

2.2目录

说明书的目录应遵循以下规则：

目录页面的标题中文字体属性为华文宋体、小三、加粗、全角字符，英文字体属性为TimesNewRoman、15pt、加粗、半角字符；

目录最多三层；

一级目录的中文字体属性为黑体、四号、加粗、全角字符，英文、数字字体属性为TimesNewRoman、14pt、加粗、半角字符；

二级目录的中文字体属性为黑体、五号、加粗、全角字符，英文、数字字体属性为TimesNewRoman、10.5pt、加粗、半角字符；

三级目录的中文字体属性为黑体、小五、全角字符，英文、数字字体属性为TimesNewRoman、9pt、半角字符；

一级目录无缩进，二级目录比一级目录缩进2个字符，三级目录比二级目录缩进2个字符；

一级标和二级目录的段落属性为两端对齐，单倍行距，段前间距为0.5行、段后间距为0行。

三级目录段落属性为两端对齐，单倍行距，段前间距为0行，段后间距为0.1行。

2.3正文内容与附录

正文内容主要是向用户介绍产品功能、指导用户如何正确使用产品；附录是用来对产品使用的相关补充、售后服务及责任声明等。

对于正文内容与附录部分，从以下几方面进行规定。

标题

说明书中的标题，遵循以下规则：

高一级标题下不应只有一个次级标题，同时避免孤立的章节和标题存在；

标题要避免孤立编号，正文不要有孤立二、三标题，孤立的BlockLabel样式；

说明书中最多出现三级标题，一级标题前中文说明书编号为“第×章”，英文说明书编号表示为“Chapter×”；二级标题前中文与英文说明书编号同表示为“×.×”；其中“×”为章节数，用阿拉伯数字表示，从1开始。

标题编号采用项目编号方式。

三级标题前中文与英文说明书都无编号；

编号与标题间空一格；

一级标题的中文字体属性为华文宋体、四号、加粗、全角字符，英文、数字字体属性为TimesNewRoman、14pt、半角字符；

二级标题的中文字体属性为华文宋体、小四、加粗、全角字符，英文、数字字体属性为TimesNewRoman、12pt、加粗、半角字符；

三级标题的中文字体属性为华文宋体、五号、加粗、全角字符，英文、数字字体属性为TimesNewRoman、10.5pt、加粗、半角字符；

标题段落属性均为无缩进，两端对齐，单倍行距，段前间距为0.5行、段后间距为0行。

段落

说明书中的段落，遵循以下规则：

段落的中文、符号字体属性为华文宋体、小五、全角字符，英文、数字字体属性为TimesNewRoman、9pt、半角字符；段落属性为无缩进，两端对齐，单倍行距，段前间距为0行、段后间距为0.1行。

句子

说明书中的句子，遵循以下规则：

正文中若需项目列表，一级列表编号中英文同为阿拉伯数字，二级列表编号使用项目符号“●”，其下不可再嵌入子项目列表；

句子中可以出现图形，但不能改变行间距；

讲述产品的操作时，句子中出现的产品相关词汇需加引号并加粗显示，但不得改变字体大小和字体种类，引号格式与词汇相同。

当用产品相关词汇描述一连串的操作动作，后者是前者的下一步同时是其子菜单时，则词汇之间用“→”连接，但若词汇之间有文字性描述，则不用其连接，“→”的格式与词汇相同。

如：

例1，点击Windows“开始”→“所有程序”→“neware”→“TC52”→“BTSDA”，启动软件；例2，点击“导出”，选择“TXT、EXCEL或PDF”中任意一种。

表格与图标

对于说明书中的表格和图像遵循以下规则：

表格一行中的单元要求不跨页；

表格的题注在紧接表格的上方，中文文档格式为“表_×_名称”，英文文档格式为“Table_×_名称”。

其中“_”为一个空格，“×”为阿拉伯数字，从1开始，全文统一编号，中文字体属性为华文宋体、小五、全角字符，英文、数字字体属性为TimesNewRoman、9pt、半角字符。

段落属性为居中。

无边框表格不需题注，不按此规则；

每个表格的下方都要空一行，这一空行的样式为正文。

在遇换页的特殊情况下，若表格后的空行为页面第一行，空行需删除。

无边框表格不需按此规则，随使用单独规范；

禁止使用第三方的商标、图标、图形；

所有VISIO绘制的组网图一律另存为*.WMF格式，才能在WORD中插入；

图中的文本：

中文华文宋体，小五，全角字符；字母与数字TimesNewRoman，9pt，半角字符；

图形的题注紧接图形的下方，中文文档格式为“图_×_名称”，英文文档格式为“Figure_×_名称”。

段落属性为居中；

若要介绍图形中的某些部分名称，可对这些部分分别加标注，标注形式为阿拉伯数字，从1开始，若要解释的部分在图形中不清晰，可引出图形放大部分与原图形一起进行标注；对标注从1开始进行解释，有两种情况，一是简单解释其名称，紧接图形题注的下方使用无边框表格来描述，居中显示，中文字体属性为黑体、五号、全角字符，英文与数字字体属性为TimesNewRoman、10.5pt、加粗、半角字符；一是要一并介绍其功能，紧接图形题注下方使用表格来描述。

标号与解释之间空一格，两种情况格式如下：

图SEQ图\*ARABIC1机箱外形

情况一：

解释名称

情况二：

解释名称与介绍功能：

表SEQ表\*ARABIC1表格示例

图形解释（使用无边框表格的情况一）下方需空一行，这一空行的样式为正文。

在遇换页的特殊情况下，若表格后的空行为页面第一行，空行需删除。

软件界面图片

在描述上位机和中位机软件界面时，内容遵循以下规则:

包含软件启动的主界面图片；

包含相关功能的主界面图片，如上位机BGS客户端功能性主界面的当前界面:

常规显示、列表显示、工步显示、容量分选、电池配组、大小图标切换显示、小图标里:

电压显示、电流显示、容量显示、时间显示；历史界面的显示。

界面图片的描述方式：

方式一：

通过箭头引出说明。

图SEQ图\*ARABIC2BTSDA.exe软件主界面

方式二：

通过在表格中图片加文字描述说明。

表SEQ表\*ARABIC2工步参数设置

方式三：

通过注

展开阅读全文