說明書排版規(guī)范(印刷版)

1、說明書排版規(guī)范目錄第1章 說明4第2章 排版規(guī)范52.1 封面52.2 目錄52.3 正文內(nèi)容與附錄5標(biāo)題6段落6句子6表格與圖標(biāo)7軟件界面圖片8標(biāo)點符號10注、注意、警告102.4 詞匯表112.5 索引122.6 其他方面12頁面設(shè)置13頁眉與頁腳13附錄14漢語寫作的相關(guān)規(guī)定14“的、地、得”用法14目錄 1第1章 說明此文檔主要用于規(guī)范說明書排版，統(tǒng)一說明書格式，為提高說明書質(zhì)量提供標(biāo)準(zhǔn)和依據(jù)。本文檔只適用于word2003。公司所有產(chǎn)品說明書必須按照此規(guī)范來進(jìn)行撰寫。第2章 排版規(guī)范說明書應(yīng)該依次包括封面、目錄、正文內(nèi)容、附錄、詞匯表、索引幾個部分，下面分別介紹這幾部分的編排規(guī)范及其

2、他方面的設(shè)置規(guī)則。2.1 封面說明書的封面應(yīng)遵循以下規(guī)則：1. 封面有兩頁；2. 第一頁封面的信息應(yīng)該包括說明書名稱、設(shè)備版本號。名稱的中文字體屬性為華文宋體、小二、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、18pt、加粗、半角字符，段落屬性為右對齊；設(shè)備版本號的格式為：“Version：版本號”，英文、數(shù)字字體屬性為Times New Roman、10pt、加粗、半角字符，段落屬性為兩端對齊；3. 第二頁封面的信息包括說明書中特殊標(biāo)識符的定義及版權(quán)聲明、說明書版本?！疤厥鈽?biāo)識符”中文字體屬性為黑體、五號、加粗、全角字符，英文字體屬性為Times New Roman、

3、10.5pt、加粗、半角字符；特殊標(biāo)識符定義的格式為“特殊標(biāo)識符：解釋”，中文字體屬性為黑體、小五、全角字符，特殊標(biāo)識符加粗，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符、特殊標(biāo)識符加粗，冒號格式與特殊標(biāo)識符相同。版權(quán)聲明及說明書版本中文字體屬性為黑體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符。2.2 目錄說明書的目錄應(yīng)遵循以下規(guī)則：1. 目錄頁面的標(biāo)題中文字體屬性為華文宋體、小三、加粗、全角字符，英文字體屬性為Times New Roman、15pt、加粗、半角字符；2. 目錄最多三層；3. 一級目錄的中文字體屬性為黑體、四

4、號、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、14pt、加粗、半角字符；4. 二級目錄的中文字體屬性為黑體、五號、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、10.5pt、加粗、半角字符；5. 三級目錄的中文字體屬性為黑體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符；6. 一級目錄無縮進(jìn)，二級目錄比一級目錄縮進(jìn)2個字符，三級目錄比二級目錄縮進(jìn)2個字符；7. 一級標(biāo)和二級目錄的段落屬性為兩端對齊，單倍行距，段前間距為0.5行、段后間距為0行。三級目錄段落屬性為兩端對齊，單倍行距，段前間距為0行，段后間距為

5、0.1行。2.3 正文內(nèi)容與附錄正文內(nèi)容主要是向用戶介紹產(chǎn)品功能、指導(dǎo)用戶如何正確使用產(chǎn)品；附錄是用來對產(chǎn)品使用的相關(guān)補(bǔ)充、售后服務(wù)及責(zé)任聲明等。對于正文內(nèi)容與附錄部分，從以下幾方面進(jìn)行規(guī)定。標(biāo)題說明書中的標(biāo)題，遵循以下規(guī)則：1. 高一級標(biāo)題下不應(yīng)只有一個次級標(biāo)題，同時避免孤立的章節(jié)和標(biāo)題存在；2. 標(biāo)題要避免孤立編號，正文不要有孤立二、三標(biāo)題，孤立的Block Label樣式；3. 說明書中最多出現(xiàn)三級標(biāo)題，一級標(biāo)題前中文說明書編號為“第×章”，英文說明書編號表示為“Chapter ×”；二級標(biāo)題前中文與英文說明書編號同表示為“×.×”；其中“

6、5;”為章節(jié)數(shù)，用阿拉伯?dāng)?shù)字表示，從1開始。標(biāo)題編號采用項目編號方式。三級標(biāo)題前中文與英文說明書都無編號；4. 編號與標(biāo)題間空一格；5. 一級標(biāo)題的中文字體屬性為華文宋體、四號、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、14pt、半角字符；6. 二級標(biāo)題的中文字體屬性為華文宋體、小四、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、12pt、加粗、半角字符；7. 三級標(biāo)題的中文字體屬性為華文宋體、五號、加粗、全角字符，英文、數(shù)字字體屬性為Times New Roman、10.5pt、加粗、半角字符；8. 標(biāo)題段落屬性均為無縮進(jìn)，兩端對齊，單倍行距，

7、段前間距為0.5行、段后間距為0行。段落說明書中的段落，遵循以下規(guī)則：段落的中文、符號字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符；段落屬性為無縮進(jìn)，兩端對齊，單倍行距，段前間距為0行、段后間距為0.1行。句子說明書中的句子，遵循以下規(guī)則：1. 正文中若需項目列表，一級列表編號中英文同為阿拉伯?dāng)?shù)字，二級列表編號使用項目符號“”，其下不可再嵌入子項目列表；2. 句子中可以出現(xiàn)圖形，但不能改變行間距；3. 講述產(chǎn)品的操作時，句子中出現(xiàn)的產(chǎn)品相關(guān)詞匯需加引號并加粗顯示，但不得改變字體大小和字體種類，引號格式與詞匯相同。當(dāng)用產(chǎn)品相關(guān)詞匯描述一

8、連串的操作動作，后者是前者的下一步同時是其子菜單時，則詞匯之間用“”連接，但若詞匯之間有文字性描述，則不用其連接，“”的格式與詞匯相同。如：例1，點擊Windows“開始”“所有程序”“neware”“TC52”“BTSDA”，啟動軟件；例2，點擊“導(dǎo)出”，選擇“TXT、EXCEL或 PDF”中任意一種。表格與圖標(biāo)對于說明書中的表格和圖像遵循以下規(guī)則：1. 表格一行中的單元要求不跨頁；2. 表格的題注在緊接表格的上方，中文文檔格式為“表_×_名稱”，英文文檔格式為“Table_×_名稱”。其中“_”為一個空格，“×”為阿拉伯?dāng)?shù)字，從1開始，全文統(tǒng)一編號，中文字體屬

9、性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符。段落屬性為居中。無邊框表格不需題注，不按此規(guī)則；3. 每個表格的下方都要空一行，這一空行的樣式為正文。在遇換頁的特殊情況下，若表格后的空行為頁面第一行，空行需刪除。無邊框表格不需按此規(guī)則，隨使用單獨規(guī)范；4. 禁止使用第三方的商標(biāo)、圖標(biāo)、圖形；5. 所有VISIO繪制的組網(wǎng)圖一律另存為*.WMF格式，才能在WORD中插入；6. 圖中的文本：中文華文宋體，小五，全角字符；字母與數(shù)字Times New Roman，9pt，半角字符；7. 圖形的題注緊接圖形的下方，中文文檔格式為“圖_×_名

10、稱”，英文文檔格式為“Figure_×_名稱”。其中“_”為一個空格，“×”為阿拉伯?dāng)?shù)字，從1開始，全文統(tǒng)一編號，中文字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符。段落屬性為居中；8. 若要介紹圖形中的某些部分名稱，可對這些部分分別加標(biāo)注，標(biāo)注形式為阿拉伯?dāng)?shù)字，從1開始，若要解釋的部分在圖形中不清晰，可引出圖形放大部分與原圖形一起進(jìn)行標(biāo)注；對標(biāo)注從1開始進(jìn)行解釋，有兩種情況，一是簡單解釋其名稱，緊接圖形題注的下方使用無邊框表格來描述，居中顯示，中文字體屬性為黑體、五號、全角字符，英文與數(shù)字字體屬性為Times Ne

11、w Roman、10.5pt、加粗、半角字符；一是要一并介紹其功能，緊接圖形題注下方使用表格來描述。標(biāo)號與解釋之間空一格，兩種情況格式如下：圖 1 機(jī)箱外形情況一：解釋名稱1 電源及狀態(tài)指示燈2 電源開關(guān)3 通道工作指示燈(共八個)4 164插座情況二：解釋名稱與介紹功能：表 1 表格示例1 電源及狀態(tài)指示燈用于顯示電源及狀態(tài)。2 電源開關(guān)控制電源打開關(guān)閉。3 通道工作指示燈共8個，用于表示通道的工作狀態(tài)。4 164插座用來連接鱷魚夾具。9. 圖形解釋（使用無邊框表格的情況一）下方需空一行，這一空行的樣式為正文。在遇換頁的特殊情況下，若表格后的空行為頁面第一行，空行需刪除。軟件界面圖片在描述上

12、位機(jī)和中位機(jī)軟件界面時，內(nèi)容遵循以下規(guī)則:1. 包含軟件啟動的主界面圖片；2. 包含相關(guān)功能的主界面圖片，如上位機(jī)BGS客戶端功能性主界面的當(dāng)前界面:常規(guī)顯示、列表顯示、工步顯示、容量分選、電池配組、大小圖標(biāo)切換顯示、小圖標(biāo)里:電壓顯示、電流顯示、容量顯示、時間顯示；歷史界面的顯示。3. 界面圖片的描述方式：方式一：通過箭頭引出說明。圖 2 BTSDA.exe軟件主界面方式二：通過在表格中圖片加文字描述說明。表 2 工步參數(shù)設(shè)置記錄條件 包括 時間間隔 、電壓變化 及 電流變化三個選項，可以同時選擇多項有效。各項記錄條件之間是 邏輯或 的關(guān)系，只要其中任意一項滿足，就記錄一次數(shù)據(jù)。恰當(dāng)?shù)剡x擇記

13、錄條件可使數(shù)據(jù)文件盡可能小，但卻不漏掉關(guān)鍵性的數(shù)據(jù)。提高數(shù)據(jù)處理的速度?！鞍踩Ｗo(hù)”主要是針對測試過程中，電池電流、電壓采樣異常的通道進(jìn)行硬件保護(hù)。具體設(shè)置以鋰電為例，通常鋰電放電電壓為2.75V，充電電壓為4.20V，安全保護(hù)參數(shù)上下限電壓可參考設(shè)置為2.54.3V。本系統(tǒng)定義充電電流為“+”，放電為“-”，設(shè)置安全保護(hù)時務(wù)必注意，如設(shè)置充、放電電流為700mA，“安全保護(hù)”中“電流范圍±”數(shù)值應(yīng)大于700mA，不是電流偏差。備注信息 的內(nèi)容會自動存入數(shù)據(jù)文件，以備查詢或打印。方式三：通過注釋，放大界面中的主要標(biāo)簽、結(jié)構(gòu)、圖樣等。標(biāo)點符號說明書中的標(biāo)點符號遵循以下規(guī)則：1. 如果是

14、中文說明書，使用中文的標(biāo)點符號，不論句子的結(jié)束文字是英文或是中文；如果是英文說明書，使用英文標(biāo)點符號；2. 標(biāo)點符號無論中英文下均為半角字符；3. 半字線常用于漢字和數(shù)字（字母）之間：鈾235、惠普5000；4. 一些外來的詞匯中常用短劃線：E-Mail、CD-ROM、ITU-T、8-bit；5. 浪紋符用于表示數(shù)量的范圍：13；6. 長橫常用于地名之間：北京天津。注、注意、警告說明書中要添加注、注意、警告三種提示語，以便用戶更好地理解使用產(chǎn)品。它們遵循以下規(guī)則：1. 注：表示可以幫助用戶更好地使用產(chǎn)品，圖標(biāo)為“”；2. 注意：表示可能會損壞硬件或?qū)е聰?shù)據(jù)丟失，并告訴用戶如何避免該問題，圖標(biāo)為

15、“”；3. 警告：表示可能會導(dǎo)致財產(chǎn)損失、人身傷害甚至死亡，圖標(biāo)為“”；4. 圖標(biāo)從本文檔中復(fù)制使用，三種圖標(biāo)大小均設(shè)置為高0.56cm，寬0.56cm；5. 三種提示中文說明書表示形式為“圖標(biāo)_注/注意/警告：內(nèi)容”，英文說明書表示形式為“圖標(biāo)_Note/Notice/Caution:_內(nèi)容”，其中“_”為一個空格，“內(nèi)容”為提示內(nèi)容；6. 三種提示（含提示內(nèi)容）中文字體屬性為黑體、小五、加粗、全角字符，英文與數(shù)字字體屬性為Times New Roman、9pt、加粗、半角字符。7. 注、注意、警告的圖標(biāo)及其內(nèi)容放在無邊框表格中。圖片格式和表格屬性請參看下例。例：注意：循環(huán)序號/過程序號/記

16、錄序號為必須顯示的內(nèi)容，不可選。注：循環(huán)序號/過程序號/記錄序號為必須顯示的內(nèi)容，不可選。警告：循環(huán)序號/過程序號/記錄序號為必須顯示的內(nèi)容，不可選。2.4 詞匯表詞匯表用來提供術(shù)語的解釋。詞匯表應(yīng)遵循以下規(guī)則：1. 詞匯表只有一級標(biāo)題，即詞匯表頁面的標(biāo)題，中文字體屬性為華文宋體、小三、加粗、全角字符，英文字體屬性為Times New Roman、15pt、加粗、半角字符。標(biāo)題前無編號；2. 英文說明書的詞匯按字母升序排列。中文說明書的詞匯表，若有中英文兩種詞匯，則分為“英文”、“中文”，分別進(jìn)行升序排序，“中文”內(nèi)再分為“A、B”，將中文詞匯按字母順序進(jìn)行分類并升序排序；若無英文詞匯，則分為

17、“A、B”，將詞匯分類并升序排序?！坝⑽摹薄ⅰ爸形摹弊煮w屬性為華文宋體、四號、加粗、全角字符，“ABCD”字體屬性為Times New Roman、12pt、加粗、半角字符；3. 詞匯表中的詞匯中文字體屬性為華文宋體、五號、加粗、全角字符，數(shù)字與英文字體屬性為Times New Roman、10.5pt、加粗、半角字符；4. 詞匯表中關(guān)于詞匯的解釋中文字體屬性為華文宋體、五號、全角字符，數(shù)字與英文字體屬性為Times New Roman、10.5pt、半角字符；5. 詞匯與解釋之間用符號“”連接，其格式與詞匯相同；6. 整個詞匯表（包括標(biāo)題與全部內(nèi)容）的段落屬性為無縮進(jìn)，兩端對齊，單倍行距，段

18、前間距為0行、段后間距為0.5行。例：中文說明書詞匯表（含英文詞匯）圖 3 中文說明書詞匯表示例2.5 索引索引是把文檔等資料中的項目或內(nèi)容摘記下來，每條下標(biāo)注出處頁碼，按一定的次序排列，供人查閱的資料。對于說明書中的索引，遵循以下幾條規(guī)則：1. 索引只有一級標(biāo)題，即索引頁面的標(biāo)題，中文字體屬性為華文宋體、小三、加粗、全角字符，英文字體屬性為Times New Roman、15pt、加粗、半角字符。標(biāo)題前無編號；2. 索引的排序與詞匯表一致，參照2.4節(jié)第2點；3. 索引最多兩層；4. 一級索引加粗顯示，二級索引不加粗；一級索引無縮進(jìn)，二級索引比一級索引縮進(jìn)2個字符；5. 索引項中文字體屬性為

19、華文宋體、五號、全角字符，英文、數(shù)字字體屬性為Times New Roman、10.5pt、半角字符；6. 整個索引（包括標(biāo)題與全部內(nèi)容）的段落屬性為兩端對齊，單倍行距，段前間距為0行、段后間距為0.5行。2.6 其他方面頁面設(shè)置頁面統(tǒng)一國際標(biāo)準(zhǔn)A5型紙排版，上下頁邊距為2.41cm，左右頁邊距為1.45cm。頁眉與頁腳說明書中的頁眉頁腳遵循以下規(guī)則：1. 說明書封面的第二頁無頁眉頁腳，目錄無頁眉；2. 頁眉中的中文字體屬性為華文宋體、五號、全角字符，英文、數(shù)字字體屬性為Times New Roman、10.5pt、半角字符；3. 頁眉的段落格式為兩端對齊；4. 頁眉左端插入公司的商標(biāo)，高0.

20、58cm，寬1.72cm，右端為該說明書的名稱；5. 頁腳的中文字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符；6. 第一頁封面的頁腳段落格式為居中；其他頁面頁腳的段落格式奇數(shù)頁為右對齊，偶數(shù)頁為左對齊；7. 第一頁封面的頁腳依次插入公司名稱、公司網(wǎng)址、公司電話；其他頁面的頁腳中英文文檔格式奇數(shù)頁為“該章標(biāo)題_該頁頁號”，偶數(shù)頁為“該頁頁號_該章標(biāo)題”，其中“_”為一個空格；頁號為阿拉伯?dāng)?shù)字。排版規(guī)范 11附錄漢語寫作的相關(guān)規(guī)定為了提高中文說明書的質(zhì)量，讓字、詞、句的用法更加符合現(xiàn)在漢語表達(dá)的規(guī)定和習(xí)慣，現(xiàn)在做出如下規(guī)定，介于漢語表達(dá)的靈活性和復(fù)雜多變，此規(guī)定僅