用戶手冊編制規(guī)范
[pic] 用戶手冊編制規(guī)范 沈陽東大阿爾派軟件股份有限公司 2000.2 1. 版權(quán)聲明 《用戶手冊編制規(guī)范》的版權(quán)歸沈陽東大阿爾派軟件股份有限公司所有。未經(jīng)沈陽東大 阿爾派軟件股份有限公司的書面準(zhǔn)許，不得將本規(guī)范的任何部分以任何形式、采用任何 手段(電子的或機(jī)械的，包括照相復(fù)制或錄制)、或?yàn)槿魏文康模M(jìn)行復(fù)制或擴(kuò)散。 (c)Copyright 2000 沈陽東大阿爾派軟件股份有限公司。版權(quán)所有，翻制必究。 [pic] 是沈陽東大阿爾派軟件股份有限公司的注冊商標(biāo)。 Microsoft、word是Microsoft Corporation的注冊商標(biāo)。 Windows是Microsoft Corporation的商標(biāo)。 前 言 用戶手冊對于任何產(chǎn)品都是不可缺少的組成部分。一個(gè)好的產(chǎn)品沒有一份完備的用戶 手冊，也不能算作一個(gè)完備的產(chǎn)品。對于軟件產(chǎn)品來說更是如此，沒有用戶手冊的軟件 不能算產(chǎn)品，沒有好的用戶手冊，就不可能算好產(chǎn)品。也就是說，一個(gè)好的軟件產(chǎn)品除 了具備與市場對路的思想、良好的用戶界面、完備的測試之外，還必須有一本適合用戶 使用的用戶手冊。 本規(guī)范手冊不僅指明了軟件用戶手冊的內(nèi)容，而且規(guī)定了沈陽東大阿爾派軟件股份有 限公司軟件用戶手冊的統(tǒng)一版面、格式。本規(guī)范手冊就是按本規(guī)定編寫的，但由于本規(guī) 范手冊內(nèi)容的局限性，很難以樣本的形式表現(xiàn)軟件用戶手冊中可能出現(xiàn)的各種情況，所 以請大家認(rèn)真閱讀本規(guī)范手冊的內(nèi)容。 我們希望沈陽東大阿爾派軟件股份有限公司的相關(guān)人員，能夠按照本規(guī)范手冊編寫自 己的軟件用戶手冊，做好我們的軟件產(chǎn)品化工作。由于時(shí)間倉促，編者水平有限，希望 大家能夠提出寶貴意見，以逐步完善本規(guī)范手冊的內(nèi)容。 閱讀指南 〖手冊目標(biāo)〗 本手冊主要對沈陽東大阿爾派軟件股份有限公司軟件產(chǎn)品的用戶手冊所應(yīng)包含的內(nèi)容 及版面格式作一個(gè)初步的統(tǒng)一規(guī)定。由于實(shí)際情況千變?nèi)f化，本規(guī)定很難一次做到面面 俱到，需要逐漸完善。 〖閱讀對象〗 本手冊是為沈陽東大阿爾派軟件股份有限公司的所有軟件開發(fā)人員和軟件用戶手冊編 寫人員所編寫的。由于本手冊中的格式規(guī)定部分是根據(jù) Microsoft Windows 下的 Word 的功能而編寫的，所以沈陽東大阿爾派軟件股份有限公司的軟件用戶手冊應(yīng)該使用 MicroSoft Word排版。 〖手冊構(gòu)成〗 本手冊基本上由兩部分組成： 1. 第1章，“關(guān)于用戶手冊排版格式的規(guī)定”，規(guī)定了用戶手冊標(biāo)題及編號的格式。 2. 第2章，“用戶手冊的內(nèi)容”，規(guī)定了用戶手冊所應(yīng)包含內(nèi)容較為詳細(xì)的清單。 另外，本手冊基本上是按“用戶手冊格式的統(tǒng)一規(guī)定”編寫的一個(gè)樣本。 〖手冊約定〗 本手冊遵循以下約定： 1. 所有標(biāo)題均使用黑體字。 2. 如果標(biāo)題后跟有“〖條件〗”字樣，說明該標(biāo)題下正文所要求的內(nèi)容是在一定條件下 必須的。 【注意】的意思是請讀者注意那些需要注意的事項(xiàng)。 【警告】的意思是請讀者千萬注意某些事項(xiàng)，否則將造成嚴(yán)重錯(cuò)誤。 目 錄 第1章 用戶手冊格式規(guī)定 1-1 §1.1 標(biāo)題及編號 1-1 §1.1.1 章標(biāo)題的設(shè)置 1-1 §1.1.2 節(jié)標(biāo)題的設(shè)置 1-1 §1.1.3 小節(jié)標(biāo)題的設(shè)置 1-1 §1.1.4項(xiàng)目符號和編號的設(shè)置 1-2 §1.1.5 其它編號的設(shè)置 1-3 §1.2 正文及頁眉頁腳的排版 1-4 §1.2.1 正文排版 1-5 §1.2.2 版面設(shè)置 1-5 §1.2.2.1 版面設(shè)置 1-5 §1.2.2.2 關(guān)于頁眉、頁腳的設(shè)置 1-5 §1.2.2.3 注意與警告 1-5 第2章 用戶手冊的內(nèi)容 2-1 §2.1 用戶手冊的目標(biāo) 2-4 §2.2 用戶手冊的內(nèi)容 2-4 §2.2.1 封面 2-4 §2.2.2 二封 2-4 §2.2.3 版權(quán)聲明 2-4 §2.2.4 前言 2-4 §2.2.5 閱讀指南 2-5 §2.2.6目錄 2-5 §2.2.7基礎(chǔ)知識(shí)介紹〖條件〗 2-5 §2.2.8 系統(tǒng)安裝及啟動(dòng) 2-6 §2.2.9 系統(tǒng)操作說明 2-7 §2.2.9 1 CAD軟件 2-7 §2.2.9 2 其它軟件 2-9 §2.2.10 系統(tǒng)及數(shù)據(jù)維護(hù) 2-9 §2.2.11 例題〖條件〗 2-10 §2.2.12 各種附錄 2-10 §2.3 用戶手冊的風(fēng)格 2-11 第1章 用戶手冊格式的規(guī)定 §1.1 標(biāo)題及編號 一般情況下，用戶手冊用章、節(jié)來劃分其內(nèi)容，必要時(shí)還可引入小節(jié)、小小節(jié)的概念 。 §1.1.1 章標(biāo)題的設(shè)置 每章的編號用阿拉伯?dāng)?shù)字表示，采用“第1章”、“第2章”、……的形式表示章的編號 ，章的編號后面空一個(gè)半角的格，然后是這一章的標(biāo)題。 1. 章必須另起一頁開始打印。 2. 章的編號和標(biāo)題采用左對齊的格式放在行的左邊，左縮進(jìn)為0。 3. 章的編號和標(biāo)題中漢字采用黑體小三號字，章的編號和標(biāo)題總長度不能超過一行 。 4. 章的編號和標(biāo)題行距取最小值、12磅，段前、段后分別取24磅。 §1.1.2 節(jié)標(biāo)題的設(shè)置 節(jié)的編號格式為“§x.y”。其中，x為章的號碼，y為節(jié)的號碼，用阿拉伯?dāng)?shù)字表示 。節(jié)的編號后面空一個(gè)半角的格，然后是這一節(jié)的標(biāo)題。 1. 原則上每一節(jié)另起一頁開始打印，但對于每章的第一節(jié)，如果章標(biāo)題下無說明文 字，可以將其與章標(biāo)題放于一頁之中。 2. 節(jié)的編號和標(biāo)題采用左對齊的格式放在行的左邊，左縮進(jìn)為0。 3. 節(jié)的編號和標(biāo)題中漢字采用黑體四號字，節(jié)的編號和標(biāo)題總長度不能超過一行。 4. 節(jié)的編號和標(biāo)題行距取最小值、12磅，對于與章標(biāo)題處于同頁的要將其段前、段 后均取12磅，否則段前取24磅、段后取12磅。 §1.1.3 小節(jié)標(biāo)題的設(shè)置 小節(jié)的編號格式為“§x.y.z”。其中x為章的號碼，y為節(jié)的號碼，z為小節(jié)號碼，用 阿拉伯?dāng)?shù)字表示。小節(jié)的編號后面空一個(gè)半角的格，然后是這一小節(jié)的標(biāo)題。 1. 小節(jié)不必另起一頁開始打印。 2. 小節(jié)的編號和標(biāo)題采用左對齊的格式放在行的左邊，左縮進(jìn)0.74CM。 3. 小節(jié)的編號和標(biāo)題中漢字采用黑體小四號字，小節(jié)的編號和標(biāo)題總長度不能超過 一行。 4. 小節(jié)的編號和標(biāo)題行距取最小值、12磅，段前取12磅。 【注意】 1. 如果有必要，還可以在小節(jié)下面劃分更小的節(jié)，我們暫且稱之為小小節(jié)。 2. 對于小小節(jié)的各種規(guī)定與小節(jié)一致，為保持版面清晰，小小節(jié)不再相對于小節(jié)向 右縮進(jìn)。 3. 在用戶手冊中，系統(tǒng)提示信息采用幼圓五號字，其余所有的數(shù)字及字母采用Ar ial字體，字號與相應(yīng)的漢字相同。在本規(guī)范中提到的字體如無特殊注明，均 指漢字字體。 4. 用戶手冊中，行距均取最小值、12磅。 §1.1.4 項(xiàng)目符號和編號的設(shè)置 在章、節(jié)、小節(jié)、小小節(jié)里面均可以含有項(xiàng)目符號和編號。 1. 編號 1) 編號序列相對于與之對應(yīng)的標(biāo)題向右縮進(jìn)0.74CM。 2) 編號的格式是“n.”，其中n為阿拉伯?dāng)?shù)字。 3) 對于有名編號序列名稱采用五號黑體漢字，其后面的內(nèi)容采用五號宋體漢字 ；對于無名編號序列中的內(nèi)容字體同有名編號序列。 4) 編號序列里還允許采用二級編號序列，其格式規(guī)定如下：“n)”，其中n為阿 拉伯?dāng)?shù)字。 5) 二級編號相對于與之對應(yīng)的一級編號向右縮進(jìn)0.74CM。 6) 其它規(guī)定和一級編號序列一致。 7) 編號及二級編號的行間距取最小值，12磅。一級編號的第一項(xiàng)段前取12磅， 其余各項(xiàng)及二級編號段前均取6磅。 2. 項(xiàng)目符號 1) 項(xiàng)目符號相對于與之對應(yīng)的標(biāo)題或編號序列向右縮進(jìn)0.74CM。 2) 項(xiàng)目符號的格式是“(”，其中“(”字體為Wingdings，五號字。 3) 對于有名項(xiàng)目符號序列，名稱采用五號黑體漢字，其后面的正文采用宋體五 號字，對于無名項(xiàng)目符號序列中的內(nèi)容字體同有名編號序列。 4) 如果項(xiàng)目符號序列處于編號序列的下級，則各項(xiàng)各項(xiàng)段前均取6磅；否則首 項(xiàng)段前取12磅，其余各項(xiàng)段前取6磅。 【注意】項(xiàng)目符號和編號下的敘述文字相對于與之對應(yīng)的項(xiàng)目符號或編號向右縮進(jìn)0 .74CM，首行縮進(jìn)0.74CM，段前取6磅。漢字字體取宋體五號。 §1.1.5 其它編號的設(shè)置 1. 頁編號：用戶手冊中的正文按章進(jìn)行編號，其格式為“章- 頁”。如，第2章的第3頁，編號為“2- 3”。頁編號放在頁腳中，具體設(shè)置方法詳見“頁眉、頁腳設(shè)置”。 2. 圖、表編號： 用戶手冊中的圖、表均按章分別進(jìn)行編號，其格式分別為“圖x-y”、“表x- y”。如，第2章的第3幅圖的編號是“圖2-3”；第2章的第3張表格的編號是“表2- 3”。在圖表編號的后面空一個(gè)半角的格，然后是這一圖表的名稱。另外，還規(guī)定 ： 1) 表的編號與名稱放在表的頂部。 2) 表的編號與名稱和表左對齊，而整個(gè)表則居中放置。 3) 表的編號與名稱段后取6磅。 4) 圖的編號與名稱放在圖的底部。 5) 圖的編號與名稱和圖均居中放置。 6) 圖的編號與名稱段前取6磅。 7) 圖前面的正文段后取12磅。 8) 圖、表的編號與名稱中漢字采用黑體五號字。 §1.2 正文及頁眉、頁腳的排版 §1.2.1 正文排版 正文排版包括字符排版、段落排版、圖形排版和版權(quán)聲明、目錄等的排版，本節(jié) 就這幾方面的格式要求加以詳細(xì)闡述。 1. 字符排版： 1) 用戶手冊的正文，系統(tǒng)提示采用幼圓五號字體，其余采用宋體五號字。 2) 對于界面中的按鈕名稱，應(yīng)把按鈕名稱用“〈〉”括起來，按鈕名稱用黑體五 號字書寫。對于下拉菜單選項(xiàng)的名稱，應(yīng)用“”引起來，選項(xiàng)名稱用宋體五 號字書寫。對于熱點(diǎn)，應(yīng)用“”引起來，熱點(diǎn)名稱用黑體五號字書寫。 3) 正文均采用常規(guī)字體、標(biāo)準(zhǔn)位置、標(biāo)準(zhǔn)間距。 2. 段落排版： 1) 正文段落的首行相對于與之對應(yīng)的標(biāo)題或編號序列向右縮進(jìn)0.74CM。 2) 行距采用最小值，12磅，除項(xiàng)目符號及編號以及圖形前面正文按前面所述的 特殊要求進(jìn)行排版外，其余段前均取12磅。 3) 采取兩端對齊方式。 3. 圖形的排版： 1) 屏幕截圖時(shí)，應(yīng)使所截圖片的尺寸為最大。 2) 對于尺寸較大的圖片，可使圖片的高度和寬度按同比例適當(dāng)縮小。 3) 必要時(shí)可適當(dāng)縮小或?qū)D片移到下一頁，以保證圖片與圖號及圖名在同頁。 4) 當(dāng)正文中對圖標(biāo)進(jìn)行說明時(shí)，應(yīng)使圖標(biāo)同與之對應(yīng)的標(biāo)題對齊。 5) 為保證頁面清晰，可適當(dāng)調(diào)整圖標(biāo)右側(cè)說明文字的行間距以及段前、段后。 6) 在屏幕截圖時(shí)，圖片中輸入的數(shù)據(jù)不能包含本公司員工的真實(shí)姓名。 4. 版權(quán)聲明、目錄等的排版： 版權(quán)聲明、前言、閱讀指南、目錄的標(biāo)題為段前取36磅，段后取24磅，采用黑 體小三號字；內(nèi)容排版與手冊正文排版相同。 §1.2.2 版面設(shè)置 §1.2.2.1 版面設(shè)置 對于版面設(shè)置作如下規(guī)定： 1. 紙張大?。河脩羰謨杂眉埥y(tǒng)一規(guī)定為16開。 2. 頁邊距：上：30mm；下：20mm；內(nèi)側(cè)：21mm；外側(cè)：16mm。另外采用“對稱頁邊 距”；對于版面設(shè)置頁眉、頁腳應(yīng)選用“首頁不同”和“奇偶頁不同”。 3. 對于新項(xiàng)目或新產(chǎn)品可根據(jù)具體情況對版面設(shè)置適當(dāng)做一些修改。 §1.2.2.2 關(guān)于頁眉、頁腳的設(shè)置 1. 頁眉的設(shè)置： 1) 版權(quán)聲明、前言、閱讀指南、目錄均無篇眉。 2) 章編號和名稱所在頁的篇眉為一行有50%填充的邊框。 3) 對于單號頁，頁眉的內(nèi)容是當(dāng)前章的標(biāo)題名，要求打印在紙的右上角。 4) 對于雙號頁，頁眉的內(nèi)容是用戶手冊的名稱，要求打印在紙的左上角。 5) 紙的頂邊與頁眉的距離是23mm。 6) 頁眉中漢字采用幼圓小五號字。 2. 頁腳的設(shè)置： 1) 頁腳的內(nèi)容是當(dāng)前頁的頁編號，如第2章第2頁為2-2。 2) 頁編號的字體采用Arial五號字。 3) 紙的底邊與頁腳的距離是13mm。 4) 版權(quán)聲明、前言、閱讀指南、目錄的頁腳為ⅰ，ⅱ等，居中放置，不帶邊框。 §1.2.2.3 注意與警告 在用戶手冊中，對于那些需要用戶特別注意的事項(xiàng)，應(yīng)該用“【注意】”作為標(biāo)志 給用戶以特別的提示。關(guān)于注意標(biāo)志和注意事項(xiàng)的格式有如下規(guī)定： 1. 注意標(biāo)志同與之對應(yīng)的標(biāo)題對齊。 2. 注意標(biāo)志采用黑體小四號漢字。 3. 注意標(biāo)志段前取12磅。 4. 如果注意事項(xiàng)只有一條，其內(nèi)容應(yīng)該緊跟在注意標(biāo)志的后面書寫；否則，應(yīng)該在 注意標(biāo)志的下一行開始，采用編號序列的形式分別給出。 在用戶手冊中，對于那些會(huì)給用戶造成重大損失的行為，應(yīng)該用“【警告】”作為 標(biāo)志給用戶以警告性的提示。 【注意】關(guān)于警告標(biāo)志和警告事項(xiàng)的格式規(guī)定與關(guān)于注意標(biāo)志和注意事項(xiàng)的格式規(guī)定 一致。 第2章 用戶手冊的內(nèi)容 本章主要討論編寫用戶手冊所要達(dá)到的目標(biāo)、軟件用戶手冊所應(yīng)包含的內(nèi)容、以及在 用戶手冊編寫過程中所應(yīng)保持的風(fēng)格。 如果標(biāo)有“〖條件〗”字樣，說明該部分內(nèi)容是在一定條件下所必須的。 §2.1 用戶手冊的目標(biāo) 某軟件評測中心把軟件產(chǎn)品評測測試分為兩個(gè)階段——初評安裝測試和復(fù)評測試。只有 通過初評安裝測試的軟件才能進(jìn)入復(fù)評測試，初評安裝測試的內(nèi)容包括： 1. 按照軟件用戶手冊中的安裝說明測試軟件能否順利安裝成功。 2. 對照軟件用戶手冊測試軟件功能是否與手冊描述一致。 3. 評價(jià)產(chǎn)品包裝及用戶手冊是否符合商品化要求。 4. 通過以上三方面測試且無嚴(yán)重死機(jī)情況的軟件可進(jìn)入復(fù)評測試。 由此，我們可以看到軟件用戶手冊是一個(gè)軟件產(chǎn)品的基礎(chǔ)，沒有合格的軟件用戶手冊 就根本談不上合格的軟件產(chǎn)品。另一方面，良好的安裝說明及軟件功能與手冊描述的一 致性是對軟件用戶手冊的兩個(gè)基本要求。 我們編寫的用戶手冊要達(dá)到兩個(gè)目的： 1. 讓用戶手冊成為用戶學(xué)習(xí)使用...
用戶手冊編制規(guī)范