用戶手冊編寫規(guī)范.doc

用戶手冊編寫規(guī)范目錄1. 用戶手冊格式的統(tǒng)一規(guī)定1.1 章、節(jié)標(biāo)題1.2 版面設(shè)置2. 用戶手冊的內(nèi)容2.1 用戶手冊的目標(biāo)2.2 用戶手冊的內(nèi)容2.3 用戶手冊的風(fēng)格1. 用戶手冊格式的統(tǒng)一規(guī)定1.1章、節(jié)標(biāo)題一般情況下，用戶手冊用章、節(jié)來劃分其內(nèi)容。如果有的系統(tǒng)很大，其用戶手冊所包含的內(nèi)容繁多，那么請根據(jù)其內(nèi)容把用戶手冊劃分為幾個分冊。每一分冊根據(jù)本規(guī)定獨立進(jìn)行章、節(jié)編號。1.1.1 章標(biāo)題每章的編號用阿拉伯?dāng)?shù)字表示，采用“第1章”、“第2章”、的形式表示章的編號，章的編號后面空一個半角的格，然后是這一章的標(biāo)題。1）每一章必須另起一頁開始； 2）章的編號和標(biāo)題采用左對齊的格式放在行的左邊； 3）章的編號和標(biāo)題采用黑體小三號字；4）章的編號和標(biāo)題與其篇眉之間空一行，和其正文之間空三行。1.1.2 節(jié)標(biāo)題節(jié)的編號格式為“x.y”。其中，x為章的號碼，y為節(jié)的號碼，用阿拉伯?dāng)?shù)字表示。節(jié)的編號后面空一個半角的格，然后是這一節(jié)的標(biāo)題。 1）每一節(jié)必須另起一頁開始； 2）節(jié)的編號和標(biāo)題采用左對齊的格式放在行的左邊； 3）節(jié)的編號和標(biāo)題采用黑體四號字；4）節(jié)的編號和標(biāo)題與其篇眉、正文之間均空一行。 1.1.3 小節(jié)標(biāo)題小節(jié)的編號格式為“x.y.z”。其中，x為章的號碼，y為節(jié)的號碼，z為小節(jié)號碼，用阿拉伯?dāng)?shù)字表示。小節(jié)的編號后面空一個半角的格，然后是這一小節(jié)的標(biāo)題。 1）不必專為小節(jié)另起一頁開始；2）小節(jié)的編號和標(biāo)題從左邊開始頂格書寫；3）小節(jié)的編號和標(biāo)題采用黑體小四號字；4）小節(jié)的編號和標(biāo)題與其前后的正文之間均空一行?！咀⒁狻?）一般情況下，章的下面可以劃分為節(jié)和小節(jié)，但要具體情況具體分析。如果沒有劃分小節(jié)的必要，則可以劃分到節(jié)為止；而且，如果有必要，還可以在小節(jié)下面劃分更小的節(jié)，我們暫且稱之為小小節(jié)。2）對于小小節(jié)的各種規(guī)定與小節(jié)一致。1.1.4 其它編號1）頁編號：用戶手冊中的正文按章進(jìn)行編號，其格式為“章頁”。如，第2章的第3頁，編號為“2-3”。各種頁編號的形式請參考本手冊所采用的格式。2）圖、表編號：用戶手冊中的圖、表均按章分別進(jìn)行編號，其格式分別為“圖 x-y”、“表 x-y”。如，第2章的第3幅圖的編號是“圖 2-3”；第2章的第3張表格的編號是“表 2-3”。在圖、表編號的編號后面空一個半角的格，然后是這一圖表的名稱。另外，還規(guī)定：l 表的編號與名稱放在表的頂部l 表的編號與名稱和表在左邊對齊，而整個表則對中放置l 表的編號與名稱和前面的正文之間空一行，和表之間無空行l(wèi) 表和其后面的正文之間空一行l(wèi) 圖的編號與名稱放圖的底部l 圖的編號與名稱和圖均對中放置l 圖的編號與名稱和前面的圖、后面的正文之間均空一行l(wèi) 圖和其前面的正文之間空一行l(wèi) 圖、表的編號與名稱均采用黑體五號字打印3）編號序列：在本章的1.1.3中的編號序列為無名編號序列，在本小節(jié)中，帶編號的序列為有名編號序列。在節(jié)、小節(jié)、小小節(jié)里面均可以含有編號序列。在一般情況下，節(jié)中編號序列所含的內(nèi)容比小節(jié)所含的內(nèi)容少，在什么情況下用小節(jié)、小小節(jié)，在什么情況下用編號序列，由用戶手冊的編制人員自己確定。編號序列在縮進(jìn)兩個漢字位置之后開始書寫，對于有名編號序列的編號和名稱要選擇黑體五號打印方式，其后面的內(nèi)容均采用五號宋體漢字。在帶編號的序列里還容許二級編號序列，其格式規(guī)定如下：l 編號的格式是“n).”，其中n為阿拉伯?dāng)?shù)字l 其它規(guī)定和一級序列編號一致【注意】1）用戶手冊的正文均采用宋體五號漢字。2）編寫手冊時，對于界面中的按鈕名稱，應(yīng)把按鈕名稱用尖括號“ ”括起來，按鈕名稱用黑體五號字書寫。對于下拉菜單選項的名稱，應(yīng)用引號“ ”引起來，選項名稱用黑體五號字書寫。1.2 版面設(shè)置1.2.1 版面設(shè)置對于版面設(shè)置我們作如下規(guī)定：1）紙型：用戶手冊用紙統(tǒng)一規(guī)定為B5。寬18.2厘米，長25厘米；2）行間距：用戶手冊中的行間距統(tǒng)一定為一倍半行距；3）縮進(jìn)：每段的第一行縮進(jìn)兩個漢字的位置；4）頁面頂部空白：頁面頂邊到正文的距離為3厘米；5）頁面底部空白：頁面底邊到正文的距離為2厘米；6）頁面內(nèi)邊空白：頁面內(nèi)邊（單號頁的左邊、雙號頁的右邊）到正文的距離為2.1厘米；7）頁面外邊空白：頁面外邊（單號頁的左邊、雙號頁的右邊）到正文的距離為 1.6厘米。1.2.2 空行規(guī)定為了保持版面清晰，在用戶手冊的正文中要保留一定的空行，規(guī)定如下：1）章標(biāo)題和其正文之間保留3行空白；2）節(jié)標(biāo)題之后留一空行；3）小節(jié)標(biāo)題、小小節(jié)的前后均留一空行；4）表的編號與名稱和前面的正文之間空一行，和表之間無空行；5）表和其后面的正文之間空一行；6）圖的編號與名稱和前面的圖、后面的正文之間均空一行；7）圖和其前面的正文之間空一行；8）各正文段之間空一行。1.2.3 關(guān)于頁眉的規(guī)定頁眉位于用戶手冊每一頁的頂部，對頁眉的規(guī)定如下：1）版權(quán)申明、前言、閱讀指南、目錄均無篇眉；2）章編號和名稱所在頁的篇眉為一行有50%填充的邊框；3）對于單號頁，頁眉的內(nèi)容是當(dāng)前章的標(biāo)題名，要求打印在紙的右上角；4）對于雙號頁，頁眉的內(nèi)容是用戶手冊的名稱，要求打印在紙的左上角；5）紙的頂邊與頁眉的距離是2.3厘米；6）頁眉所采用的是昆侖細(xì)圓小五號字。1.2.4 關(guān)于頁腳的規(guī)定頁腳位于用戶手冊每一頁的底部，對頁腳的規(guī)定如下：1）頁腳的內(nèi)容是當(dāng)前頁的頁編號，具體編號方式請參考本手冊；2）頁編號的字體采用宋體五號；3）紙的底邊與頁腳的距離是1.3厘米。1.2.5 注意與警告在用戶手冊中，對于那些需要用戶特別注意的事項，應(yīng)該用“【注意】”作為標(biāo)志給用戶以特別的提示。關(guān)于注意標(biāo)志和注意事項的格式有如下規(guī)定：1）注意標(biāo)志靠左頂格書寫；2）注意標(biāo)志采用的是黑體小四號漢字；3）注意標(biāo)志和其前面的正文之間應(yīng)該有一個空行；4）如果注意事項只有一條，其內(nèi)容應(yīng)該緊跟在注意標(biāo)志的后面書寫；否則，應(yīng)該在注意標(biāo)志的下一行開始，采用編號序列的形式分別給出。在用戶手冊中，對于那些會給用戶造成重大損失的行為，應(yīng)該用“【警告】”作為標(biāo)志給用戶以警告性的提示。對于一個好的軟件系統(tǒng)來說，這種警告性的提示應(yīng)少一些，但如果必要，還是應(yīng)該存在。【注意】關(guān)于警告標(biāo)志和警告事項的格式規(guī)定與關(guān)于注意標(biāo)志和注意事項的格式規(guī)定一致。 2 用戶手冊的內(nèi)容規(guī)定用戶手冊所要達(dá)到的目標(biāo)、包含的內(nèi)容、以及編寫的風(fēng)格。如果標(biāo)題后跟有“條件”字樣，說明該標(biāo)題下正文所要求的內(nèi)容是在一定條件下所必須的。2.1 用戶手冊的目標(biāo)1）讓用戶手冊成為用戶學(xué)習(xí)使用我們產(chǎn)品的最好教材。2）讓用戶手冊能夠起到降低銷售費用的作用?！咀⒁狻咳绻鞠到y(tǒng)軟件是一個大系統(tǒng)，其系統(tǒng)安裝、操作說明、系統(tǒng)及數(shù)據(jù)維護(hù)都相當(dāng)復(fù)雜，則可以把這三個部分分別編寫為一本甚至幾本用戶手冊，每本手冊都有自己的封面、版權(quán)聲明、前言、閱讀指南、目錄以及相應(yīng)的基礎(chǔ)知識介紹和附錄。2.2 用戶手冊的內(nèi)容2.2.1 版權(quán)聲明版權(quán)聲明是保護(hù)我們所開發(fā)軟件的產(chǎn)權(quán)、不使我們公司利益受到損害的一種方式。在版權(quán)聲明中應(yīng)該包括以下內(nèi)容：1）對我們所提供的軟件及用戶手冊的保護(hù)聲明；2）對我們的軟件及商標(biāo)東大阿爾派所有權(quán)的聲明；3）對我們的用戶手冊中所提到的各種商標(biāo)的版權(quán)聲明；4）我們不對用戶因為使用我們的軟件所造成的損失負(fù)責(zé)的聲明。2.2.2 前言前言主要包括以下內(nèi)容：1）系統(tǒng)的開發(fā)背景和目的；2）系統(tǒng)所能應(yīng)用的領(lǐng)域和使用對象；3）系統(tǒng)的功能及特性簡介；4）如果本手冊不是該系統(tǒng)的第一個版本，還應(yīng)該簡介較上一版本的改進(jìn)部分。2.2.3 閱讀指南應(yīng)該包含如下幾部分：1）手冊目標(biāo)：通過閱讀該用戶手冊，用戶應(yīng)該或能夠達(dá)到什么目標(biāo)。2）閱讀對象：指明什么人員應(yīng)該閱讀該手冊，或什么人員應(yīng)該閱讀本手冊的哪些部分；閱讀對象在閱讀本手冊之前應(yīng)該掌握哪些知識，必要時應(yīng)給出資料清單，以便用戶查閱。3）手冊構(gòu)成：如果本系統(tǒng)的用戶手冊(包括管理員手冊、參考手冊)由幾本組成，首先應(yīng)該分別簡要介紹這些手冊的情況。最根本的是應(yīng)該介紹本手冊在哪一章或哪幾章講解了什么內(nèi)容。4）手冊約定：這一部分應(yīng)該包括字體的約定、特殊符號的約定。必要時，應(yīng)該給出某些基本術(shù)語的定義。也可以把基本術(shù)語、概念的定義作為基礎(chǔ)知識來介紹。2.2.4 目錄目錄的編寫要盡量詳盡。如果用戶手冊的內(nèi)容用到小節(jié)，則目錄就應(yīng)該編寫到小節(jié)；如果用戶手冊的內(nèi)容用到小小節(jié)，則目錄就應(yīng)該編寫到小小節(jié)。編寫用戶手冊目錄的目的就是為了讓用戶能夠根據(jù)它很快地找到想要的內(nèi)容。2.2.5 基礎(chǔ)知識介紹條件用戶手冊編寫人員應(yīng)該根據(jù)實際情況確定是否需要這一部分。在一般情況下，使用我們的軟件系統(tǒng)需要一定的基礎(chǔ)知識。這些知識可以從有關(guān)書籍上得到，但是用戶從這些資料得到這些知識需要花費相當(dāng)?shù)臅r間。在某些情況下，我們只需要用戶掌握用戶手冊中使用的那些概念，那么我們就有必要編寫一章“基礎(chǔ)知識介紹”來進(jìn)行專門介紹。2.2.6 系統(tǒng)安裝系統(tǒng)安裝部分應(yīng)該包括如下內(nèi)容：1）硬件環(huán)境要求說明：系統(tǒng)運行時所需硬件環(huán)境描述，包括機型、內(nèi)存大小、硬盤空間等。如果需要，還應(yīng)該包括輸入/輸出設(shè)備、通迅環(huán)境等。2）軟件環(huán)境要求說明：系統(tǒng)運行時所需軟件支持環(huán)境描述，包括所需其它軟件的名稱及版本號等。3）其它環(huán)境要求說明條件：應(yīng)該說明要求的任何其它環(huán)境。4）硬件安裝條件：如果必要，應(yīng)該詳細(xì)說明系統(tǒng)所需硬件環(huán)境的安裝過程。5）建立軟件備份條件：如果條件容許，應(yīng)該告訴用戶如何作系統(tǒng)原介質(zhì)上軟件系統(tǒng)的備份，同時要求用戶把系統(tǒng)的原介質(zhì)作穩(wěn)妥的保存，用系統(tǒng)的備份介質(zhì)作系統(tǒng)安裝。6）系統(tǒng)安裝過程：這里要求給出最終用戶能夠據(jù)此把我們的軟件系統(tǒng)安裝到其操作環(huán)境的任何必要信息和操作。例如，環(huán)境變量的設(shè)置、系統(tǒng)配置描述格式等。2.2.7 系統(tǒng)操作說明系統(tǒng)操作說明是用戶手冊的主體，主要包括系統(tǒng)起動、輸入的命令和數(shù)據(jù)、軟件的功能、輸出結(jié)果、出錯信息及其矯正和恢復(fù)方法。1）系統(tǒng)起動： 應(yīng)給出系統(tǒng)起動的詳細(xì)過程。2）各種操作、命令和語言: 軟件系統(tǒng)的使用過程都是使用軟件系統(tǒng)提供的各種操作、命令和語言的過程。l 操作和命令：在用戶手冊中詳細(xì)給出各種操作的過程和功能、命令的格式和功能；應(yīng)當(dāng)描述在使用上的各種限制，如，操作狀態(tài)、操作條件、操作序列等。另外，必要時可以通過適當(dāng)?shù)呐e例講述各種操作和命令的使用方法，以幫助用戶理解。l 輸出信息：應(yīng)該詳細(xì)列出與操作、命令相關(guān)的各種輸出信息。如果輸出信息的意思本身不是很明顯，應(yīng)當(dāng)給予解釋。另外還應(yīng)當(dāng)說明對于這些信息所采取的操作。l 程序設(shè)計語言條件：如果我們的軟件系統(tǒng)提供了某種語言，對其語言規(guī)則應(yīng)當(dāng)給予說明。關(guān)于程序設(shè)計語言的用戶手冊的內(nèi)容，其詳細(xì)說明我們以后補充。3）各種數(shù)據(jù)：在軟件的使用過程中，用戶必須與各種數(shù)據(jù)和信息打交道。為了讓用戶能夠操作我們的軟件，我們必須為用戶提供各種結(jié)構(gòu)以及每個數(shù)據(jù)元素的含義。有些數(shù)據(jù)適合在系統(tǒng)操作說明中給出，有些適合在后面的附錄中給出，甚至有些除了在操作說明的同時給出外，還要在附錄中給予歸納，這些都由用戶手冊編寫人員根據(jù)實際況來決定。這些數(shù)據(jù)包括：l 輸入數(shù)據(jù)條件：應(yīng)該給出數(shù)據(jù)的內(nèi)容、邏輯結(jié)構(gòu)、格式以及每一個數(shù)據(jù)元素的意思。如果輸入數(shù)據(jù)依賴于某特定數(shù)據(jù)介質(zhì)，則應(yīng)當(dāng)給予說明。l 輸出數(shù)據(jù)：應(yīng)當(dāng)給出軟件以何種形式輸出的數(shù)據(jù)的內(nèi)容和格式，并要求以例樣的形式給予說明。l 中間數(shù)據(jù)條件：如果我們告訴用戶在軟件的運行過程中所產(chǎn)生的中間數(shù)據(jù)的內(nèi)容和格式，有助于用戶理解軟件的使用，則應(yīng)當(dāng)給予說明。l 數(shù)據(jù)限制條件：如果對數(shù)據(jù)有限制，如數(shù)據(jù)的大小限制，則應(yīng)當(dāng)給予說明。l 數(shù)據(jù)文件條件：如果要告訴用戶我們的軟件所使用的某些數(shù)據(jù)文件的結(jié)構(gòu)有助于用戶理解我們軟件的使用，則應(yīng)給予說明，但應(yīng)該注意技術(shù)保密。如果對數(shù)據(jù)文件有所限制，例如每個文件的最大記錄數(shù)、每個磁盤的最大文件數(shù)等，應(yīng)當(dāng)給予說明。4） 處理過程條件：如果我們簡要地給用戶描述我們軟件對用戶的操作、輸入的命令和輸入數(shù)據(jù)的處理過程，有助于用戶了解我們軟件的使用，則應(yīng)給予說明。5）出錯處理：應(yīng)當(dāng)給出各種出錯情況以及相應(yīng)的處理措施。6）操作技術(shù)條件：有些軟件的操作可能需要一定的技術(shù)和經(jīng)驗，才能獲得滿意的結(jié)果，那么應(yīng)該在用戶手冊上盡量給出這些技術(shù)和經(jīng)驗的描述，或告訴用戶如何才能獲得這些技術(shù)和經(jīng)驗。例如，在操作SEAS系統(tǒng)作圖紙凈化處理時，如何選擇適當(dāng)?shù)拈y值就是需要一定的技術(shù)和經(jīng)驗的問題?！揪妗吭诰帉戃浖脩羰謨缘南到y(tǒng)操作說明時，我們在決定是否提供某種數(shù)據(jù)的格式時，應(yīng)以不泄漏公司的技術(shù)而且有利于用戶使用為準(zhǔn)則。2.2.8 系統(tǒng)及數(shù)據(jù)維護(hù)應(yīng)該給出用戶數(shù)據(jù)的后備、恢復(fù)、刪除、整理的詳細(xì)過程。如果必要，應(yīng)該給出系統(tǒng)數(shù)據(jù)、系統(tǒng)磁盤空間維護(hù)的詳細(xì)過程。2.2.9 例題條件有些軟件系統(tǒng)可以通過一個較為完整的例題演示系統(tǒng)的大部分功能的使用方法，在這個例題中，用戶應(yīng)該詳細(xì)地描述每一步的操作過程，用戶可以通過這個例題對系統(tǒng)的操作有一個初步的了解。2.2.10 各種附錄在用戶手冊中，有些知識和信息可以通過附錄的形式提供給用戶，以便于用戶查閱，這些內(nèi)容是：1）錯誤提示信息：通?？梢砸员淼男问桨凑找欢ǖ捻樞?，例如按出錯提示信息編號順序、或按出錯提示信息的字母順序，給出出錯提示信息的編號、提示信息、相應(yīng)的解釋、出錯原因和解決辦法。2）命令速查表條件：通?？梢砸员淼男问桨凑找欢ǖ捻樞蚪o出各種命令的概要(包括命令名稱、各種參數(shù)、及相應(yīng)的功能介紹)，以幫助有一定經(jīng)驗的用戶進(jìn)行快速查找所需信息。3）數(shù)據(jù)文件格式條件：可以通過附錄介紹用戶必須了解或可以了解的各種輸入數(shù)據(jù)文件、輸出結(jié)果文件、中間數(shù)據(jù)文件的格式、限制范圍、適當(dāng)?shù)慕忉尩取?）其它信息 條件：任何其它有利于用戶使用我們的軟件、方便用戶的信息都可以以附錄的形式提供給用戶?！咀⒁狻侩m然附錄所提供的信息可能均可以在系統(tǒng)操作說明中能夠查到，但提供附錄的目的就是為了方便用戶使用，這種重復(fù)還是必要的。2.3 用戶手冊的風(fēng)格1）用戶手冊的句子盡量簡捷：如果用一個句子表達(dá)起來比較復(fù)雜，定語多，則可以分成兩個甚至幾個句子來說明，這樣用戶在閱讀用戶手冊時會輕松些。2）每節(jié)、段的內(nèi)容明確：每節(jié)的內(nèi)容必須明確，這樣用戶可以通過目錄很方便地查到自己所需要的內(nèi)容；注意段的劃分，每段不要太長，突出重點，否則用戶不容易獲得其中的精華。3）用戶手冊的用詞要前后一致：在用戶手冊中使用的概念、術(shù)語的用詞要前后一致，否則用戶將不容易讀懂此手冊。4）用戶不一定是計算機專家：用戶手冊編寫人員應(yīng)該牢牢記住這一點，我們的大多數(shù)用戶都不是學(xué)計算機的，手冊中應(yīng)該盡量不使用較深奧的計算機術(shù)語。如果不可避免，我們應(yīng)該給予適當(dāng)?shù)慕忉尯驼f明。另外，不要以為我們的用戶什么都懂，所以在編寫用戶手冊的時候，應(yīng)該詳細(xì)地描述操作過程中的每一步。