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

1、說明書排版規(guī)范Version: x深圳市新威爾電子有限公司+86-755-83108866特殊標識符X ：表示阿拉伯數(shù)字。:表示一個空格。7:表示箭頭為箭尾的子菜單，且為箭尾的下一步操作。:表示詞匯表中詞匯與解釋的連接。說明：此規(guī)范隨著使用會發(fā)生變動和不斷完善，此版僅供參考? 2008 Neware.版權(quán)所有，翻印必究。2008年10月version 1.0目錄第1章說明4第2章排版規(guī)范52.1封面52.2目錄52.3正文內(nèi)容與附錄5標題6段落6句子6表格與圖標 7軟件界面圖片8標點符號 10注、注意、警告102.4詞匯表112.5索引122.6其他方面12頁面設(shè)置13頁眉與頁腳13附錄14漢

2、語寫作的相關(guān)規(guī)定 14“的、地、得”用法 14堿 Mills說明書排版規(guī)范第1章說明此文檔主要用于規(guī)范說明書排版，統(tǒng)一說明書格式，為提高說明書質(zhì)量提供標準和依據(jù)。本文檔只適用于 word2003。公司所有產(chǎn)品說明書必須按照此規(guī)范來進行撰寫。6說明tilll說明書排版規(guī)范第2章排版規(guī)范說明書應(yīng)該依次包括封面、目錄、正文內(nèi)容、附錄、詞匯表、索引幾個部分，下面分別介紹 這幾部分的編排規(guī)范及其他方面的設(shè)谿規(guī)則。2.1封面說明書的封面應(yīng)遵循以下規(guī)則：1. 封面有兩頁；2. 第一頁封面的信息應(yīng)該包括說明書名稱、設(shè)備版本號。名稱的中文字體屬性為華文宋體、小二、加粗、全角字符，英文、數(shù)字字體屬性為Times

3、New Roman、18pt、加粗、半角字符，段落屬性為右對齊；設(shè)備版本號的格式為："Version：版本號”，英文、數(shù)字字體屬性為Times New Roman、10pt、加粗、半角字符，段落屬性為兩端對齊；3. 第二頁封面的信息包括說明書中特殊標識符的定義及版權(quán)聲明、說明書版本?！疤厥鈽俗R符"中文字體屬性為黑體、 五號、加粗、全角字符，英文字體屬性為Times New Roman、 10.5pt、加粗、半角字符；特殊標識符定義的格式為“特殊標識符：解釋” ，中文字體屬 性為黑體、小五、全角字符，特殊標識符加粗，英文、數(shù)字字體屬性為 Times New Roman >

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

5、體屬性為TimesNew Roman、10.5pt、加粗、半角字符；5. 三級目錄的中文字體屬性為黑體、小五、全角字符，英文、數(shù)字字體屬性為Times NewRoman、9pt、半角字符；6. 一級目錄無縮進，二級目錄比一級目錄縮進 2個字符，三級目錄比二級目錄縮進 2個字 符；7. 一級標和二級目錄的段落屬性為兩端對齊，單倍行距，段前間距為 0.5行、段后間距為0行。三級目錄段落屬性為兩端對齊，單倍行距，段前間距為0行，段后間距為0.1行。2.3正文內(nèi)容與附錄正文內(nèi)容主要是向用戶介紹產(chǎn)品功能、指導(dǎo)用戶如何正確使用產(chǎn)品；附錄是用來對產(chǎn)品使用的相關(guān)補充、售后服務(wù)及責任聲明等。對于正文內(nèi)容與附錄部

6、分，從以下幾方面進行規(guī)定。標題說明書中的標題，遵循以下規(guī)則：1. 高一級標題下不應(yīng)只有一個次級標題，同時避免孤立的章節(jié)和標題存在；2. 標題要避免孤立編號，正文不要有孤立二、三標題，孤立的 Block Label樣式；3. 說明書中最多出現(xiàn)三級標題，一級標題前中文說明書編號為“第x章”，英文說明書編號表示為“Chapter x” ；二級標題前中文與英文說明書編號同表示為“x .X”；其中“X”為章節(jié)數(shù)，用阿拉伯數(shù)字表示，從 1開始。標題編號采用項目編號方式。三級標題前中 文與英文說明書都無編號；4. 編號與標題間空一格；5. 一級標題的中文字體屬性為華文宋體、四號、加粗、全角字符，英文、數(shù)字字

7、體屬性為 Times New Roman、14pt、半角字符；6. 二級標題的中文字體屬性為華文宋體、小四、加粗、全角字符，英文、數(shù)字字體屬性為 Times New Roman、12pt、加粗、半角字符；7. 三級標題的中文字體屬性為華文宋體、五號、加粗、全角字符，英文、數(shù)字字體屬性為 Times New Roman、10.5pt、加粗、半角字符；8. 標題段落屬性均為無縮進，兩端對齊，單倍行距，段前間距為0.5行、段后間距為0行。段落說明書中的段落，遵循以下規(guī)則：段落的中文、符號字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符；段落屬性

8、為無縮進，兩端對齊，單倍行距，段前間距為0行、段后間距為0.1行。句子說明書中的句子，遵循以下規(guī)則：1. 正文中若需項目列表，一級列表編號中英文同為阿拉伯數(shù)字，二級列表編號使用項目符號“"，其下不可再嵌入子項目列表；2. 句子中可以出現(xiàn)圖形，但不能改變行間距；3. 講述產(chǎn)品的操作時，句子中出現(xiàn)的產(chǎn)品相關(guān)詞匯需加引號并加粗顯示，但不得改變字體大小和字體種類，引號格式與詞匯相同。 當用產(chǎn)品相關(guān)詞匯描述一連串的操作動作，后者是前者的下一步同時是其子菜單時，則詞匯之間用連接，但若詞匯之間有文字 性描述，則不用其連接，的格式與詞匯相同。如：例 1,點擊 Windows "開始”“所有

9、程序”“ neware”“ TC52”" BTSDA”，啟動軟件；例 2,點擊“導(dǎo)出”，選擇“TXT、EXCEL 或 PDF”中任意一種。8 |排版規(guī)范說明書排版規(guī)范表格與圖標對于說明書中的表格和圖像遵循以下規(guī)則：1. 表格一行中的單元要求不跨頁；2. 表格的題注在緊接表格的上方，中文文檔格式為“表_x 名稱”，英文文檔格式為“Table_X名稱”。其中“ ”為一個空格，“X”為阿拉伯數(shù)字，從1開始，全文統(tǒng)一編號，中文字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times New Roman、9pt、半角字符。段落屬性為居中。無邊框表格不需題注，不按此規(guī)則；3. 每個表格

10、的下方都要空一行，這一空行的樣式為正文。在遇換頁的特殊情況下，若表格 后的空行為頁面第一行，空行需刪除。無邊框表格不需按此規(guī)則，隨使用單獨規(guī)范；4. 禁止使用第三方的商標、圖標、圖形；5. 所有VISI。繪制的組網(wǎng)圖一律另存為 *.WMF格式，才能在 WORD中插入；6. 圖中的文本：中文華文宋體，小五，全角字符；字母與數(shù)字Times New Roman , 9pt,半角字符；7. 圖形的題注緊接圖形的下方，中文文檔格式為“圖_ x 名稱”，英文文檔格式為“Figure_X名稱”。其中“ ”為一個空格，“X”為阿拉伯數(shù)字，從1開始，全文統(tǒng)一編號，中文字體屬性為華文宋體、小五、全角字符，英文、數(shù)

11、字字體屬性為Times New Roman >9pt、半角字符。段落屬性為居中；8. 若要介紹圖形中的某些部分名稱，可對這些部分分別加標注，標注形式為阿拉伯數(shù)字，從1開始，若要解釋的部分在圖形中不清晰，可引出圖形放大部分與原圖形一起進行標注；對標注從1開始進行解釋，有兩種情況，一是簡單解釋其名稱，緊接圖形題注的下 方使用無邊框表格來描述，居中顯示，中文字體屬性為黑體、五號、全角字符，英文與數(shù)字字體屬性為 Times New Roman、10.5pt、加粗、半角字符；一是要一并介紹其功能， 緊接圖形題注下方使用表格來描述。標號與解釋之間空一格，兩種情況格式如下：13圖1機箱外形情況一：解釋

12、名稱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. 圖形解釋（使用無邊框表格的情況一）下方需空一行，這一空行的樣式為正文。在遇換 頁的特殊情況下，若表格后的空行為頁面第一行，空行需刪除。軟件界面圖片在描述上位機和中位機軟件界面時，內(nèi)容遵循以下規(guī)則：1. 包含軟件啟動的主界面圖片；:電2. 包含相關(guān)功能的主界面圖片，如上位機 BGS客戶端功能性主界面的當前界面 常規(guī)顯示、列表顯示、工步顯

13、示、容量分選、電池配組、大小圖標切換顯示、小圖標里 壓顯示、電流顯示、容量顯示、時間顯示；歷史界面的顯示。3. 界面圖片的描述方式：方式一：通過箭頭引出說明。圖2 BTSDA.exe軟件主界面10 |排版規(guī)范說明書排版規(guī)范方式二：通過在表格中圖片加文字描述說明。表2工步參數(shù)設(shè)谿記錄條件 包括 時間間隔、電壓變化 及 電流 變化三個選項，可以同時選擇多項有效。各項記 錄條件之間是邏輯或的關(guān)系，只要其中任意一 項滿足，就記錄一次數(shù)據(jù)。恰當?shù)剡x擇記錄條件 可使數(shù)據(jù)文件盡可能小，但卻不漏掉關(guān)鍵性的數(shù) 據(jù)。提高數(shù)據(jù)處理的速度?！鞍踩Ｗo”主要是針對測試過程中，電池電流、 電壓采樣異常的通道進行硬件保護。

14、具體設(shè)谿以鋰電為例，通常鋰電放電電壓為2.75V,充電電壓為4.20V,安全保護參數(shù)上下限電壓可參考設(shè) 谿為2.5-4.3V。本系統(tǒng)定義充電電流為“ + ”，放 電為“-”，設(shè)谿安全保護時務(wù)必注意，如設(shè)谿充、放電電流為700mA, “安全保護”中“電流范圍 土 ”數(shù)值應(yīng)大于700mA,不是電流偏差。備注信息 的內(nèi)容會自動存入數(shù)據(jù)文件，以備查 詢或打印。方式三：通過注釋，放大界面中的主要標簽、結(jié)構(gòu)、圖樣等。排版規(guī)范11同 Mi HIC JNkWAHt說明書排版規(guī)范KS Tridlo* 0. d13 J2> - IIIK-SllE illI 11? IW D IH 1A 忡 IM D m 3

15、3U* mi.> IK 0 IM 33M?！啃的。誦3W> MS 1KjrirjftS1世$禪 jqi世 flA8A8ifi s理1 "踏示工步墨示暮量孫逸電 ituetg標點符號說明書中的標點符號遵循以下規(guī)則：1. 如果是中文說明書，使用中文的標點符號，不論句子的結(jié)束文字是英文或是中文；如果是英文說明書，使用英文標點符號；2. 標點符號無論中英文下均為半角字符；3. 半字線常用于漢字和數(shù)字（字母）之間：鈾-235、惠普-5000;4. 一些外來的詞匯中常用短劃線：E-Mail、CD-ROM、ITU-T、8-bit;5. 浪紋符用于表示數(shù)量的范圍：13;6. 長橫常用于

16、地名之間：北京一一天津。注、注意、警告說明書中要添加注、注意、警告三種提示語，以便用戶更好地理解使用產(chǎn)品。它們遵循以下規(guī)則：1. 注：表示可以幫助用戶更好地使用產(chǎn)品，圖標為“舊”；2. 注意：表示可能會損壞硬件或?qū)е聰?shù)據(jù)丟失，并告訴用戶如何避免該問題，圖標為3. 警告：表示可能會導(dǎo)致財產(chǎn)損失、人身傷害甚至死亡，圖標為“少”；4. 圖標從本文檔中復(fù)制使用，三種圖標大小均設(shè)谿為高0.56cm，寬0.56cm；5. 三種提示中文說明書表示形式為“圖標_注/注意/警告：內(nèi)容”，英文說明書表示形式為"圖標_Note/Notice/Caution:_內(nèi)容”，其中"_"為一個空

17、格，"內(nèi)容”為提示內(nèi)容；6. 三種提示（含提示內(nèi)容）中文字體屬性為黑體、小五、加粗、全角字符，英文與數(shù)字字體屬性為 Times New Roman、9pt、加粗、半角字符。例:A7. 注、注意、警告的圖標及其內(nèi)容放在無邊框表格中。圖片格式和表格屬性請參看下例。注意：循環(huán)序號/過程序號/記錄序號為必須顯示的內(nèi)容，不可選。注：循環(huán)序號/過程序號/記錄序號為必須顯示的內(nèi)容，不可選。警告：循環(huán)序號/過程序號/記錄序號為必須顯示的內(nèi)容，不可選。2.4詞匯表詞匯表用來提供術(shù)語的解釋。詞匯表應(yīng)遵循以下規(guī)則：1. 詞匯表只有一級標題，即詞匯表頁面的標題，中文字體屬性為華文宋體、小三、加粗、全角字符，

18、英文字體屬性為 Times New Roman、15pt、加粗、半角字符。標題前無編號；2. 英文說明書的詞匯按字母升序排列。中文說明書的詞匯表， 若有中英文兩種詞匯， 則分為“英文”、“中文，分別進行升序排序，“中文，內(nèi)再分為“ A、B”，將中文 詞匯按字母順序進行分類并升序排序；若無英文詞匯，則分為“A、B”，將詞匯分類并升序排序?！坝⑽摹?、“中文”字體屬性為華文宋體、四號、加粗、全角字符，"ABCD” 字體屬性為Times New Roman、12pt、加粗、半角字符；3. 詞匯表中的詞匯中文字體屬性為華文宋體、五號、加粗、全角字符，數(shù)字與英文字體屬 性為Times New R

19、oman、10.5pt、加粗、半角字符；4. 詞匯表中關(guān)于詞匯的解釋中文字體屬性為華文宋體、五號、全角字符，數(shù)字與英文字體屬性為 Times New Roman、10.5pt、半角字符；5. 詞匯與解釋之間用符號“一”連接，其格式與詞匯相同；6. 整個詞匯表（包括標題與全部內(nèi)容）的段落屬性為無縮進，兩端對齊，單倍行距，段前 間距為0行、段后間距為0.5行。例：中文說明書詞匯表（含英文詞匯）排版規(guī)范14說明書排版規(guī)范詞匯表英文AC一交流電Bts一電池測試系統(tǒng).中文A安裝程A用于安裝及硬件和軟件的程序B圖3中文說明書詞匯表示例2.5索引索引是把文檔等資料中的項目或內(nèi)容摘記下來，每條下標注出處頁碼，

20、按一定的次序排列，供人查閱的資料。對于說明書中的索引，遵循以下幾條規(guī)則：1. 索引只有一級標題，即索引頁面的標題，中文字體屬性為華文宋體、小三、加粗、全角 字符，英文字體屬性為 Times New Roman、15pt、加粗、半角字符。標題前無編號；2. 索引的排序與詞匯表一致，參照 2.4節(jié)第2點；3. 索引最多兩層；4. 一級索引加粗顯示，二級索引不加粗；一級索引無縮進，二級索引比一級索引縮進2個字符；5. 索引項中文字體屬性為華文宋體、五號、全角字符，英文、數(shù)字字體屬性為Times NewRoman、10.5pt、半角字符；6. 整個索引（包括標題與全部內(nèi)容）的段落屬性為兩端對齊，單倍行

21、距，段前間距為0行、段后間距為 0.5行。2.6其他方面頁面設(shè)谿頁面統(tǒng)一國際標準 A5型紙排版，上下頁邊距為 2.41cm，左右頁邊距為1.45cm。貞眉與貞腳說明書中的頁眉頁腳遵循以下規(guī)則：1. 說明書封面的第二頁無頁眉頁腳，目錄無頁眉；2. 頁眉中的中文字體屬性為華文宋體、五號、全角字符，英文、數(shù)字字體屬性為 Times NewRoman、10.5pt、半角字符；3. 頁眉的段落格式為兩端對齊；4. 頁眉左端插入公司的商標，高 0.58cm,寬1.72cm,右端為該說明書的名稱；5. 頁腳的中文字體屬性為華文宋體、小五、全角字符，英文、數(shù)字字體屬性為Times NewRoman、9pt、半角字符；6. 第一頁封面的頁腳段落格式為居中；其他頁面頁腳的段落格式奇數(shù)頁為右對齊，偶數(shù)頁為左對齊；7. 第一頁封面的頁腳依次插入公司名稱、公司網(wǎng)址、公司電話；其他頁面的頁腳中英文文檔格式奇數(shù)頁為“該章標題I該頁頁號”，偶數(shù)頁為“該頁頁號I該章標題”，其中“ ”為一個空格；頁號為阿拉伯數(shù)字。排版規(guī)范16堿 Mills說明書排版規(guī)范附錄漢語寫作的相關(guān)規(guī)定為了提高中文說明書的質(zhì)量，讓字、詞、句的用法更加符合