用戶手冊(cè)編制規(guī)范東大阿爾派軟件公司-資料下載頁(yè)

【導(dǎo)讀】《用戶手冊(cè)編制規(guī)范》的版權(quán)歸沈陽(yáng)東大阿爾派軟件股份有限公司所有。手段、或?yàn)槿魏文康模M(jìn)行復(fù)制或擴(kuò)散。Copyright20xx沈陽(yáng)東大阿爾派軟件股份有限公司。版權(quán)所有，翻制必究。用戶手冊(cè)對(duì)于任何產(chǎn)品都是不可缺少的組成部分。手冊(cè)，也不能算作一個(gè)完備的產(chǎn)品。也就是說(shuō)，一個(gè)好的軟件產(chǎn)品除了具。由于時(shí)間倉(cāng)促，編者水平有限，希望大。家能夠提出寶貴意見，以逐步完善本規(guī)范手冊(cè)的內(nèi)容。及版面格式作一個(gè)初步的統(tǒng)一規(guī)定。由于實(shí)際情況千變?nèi)f化，本規(guī)定很難一次做到面面俱。到，需要逐漸完善。寫人員所編寫的。的意思是請(qǐng)讀者千萬(wàn)注意某些事項(xiàng)，否則將造成嚴(yán)重錯(cuò)誤。§節(jié)標(biāo)題的設(shè)置······································&#

　　

【正文】 說(shuō)明系統(tǒng)所需硬件環(huán)境的安裝過程， 其中包括軟件加密鎖的安裝。 ? 軟件安裝： 應(yīng)該用圖示方法詳細(xì)介紹軟件的安裝過程。對(duì)于網(wǎng)絡(luò)版軟件，應(yīng)對(duì)服務(wù)器端及客戶端的安裝分別予以介紹（可參考文檔管理系統(tǒng) SEAS20xxAMS ）。如果二者安裝過程相似，可以詳細(xì)介紹一種，另一種參考前一種即可。如果軟件由多個(gè)模塊構(gòu)成，且其中部分模塊需單獨(dú)安裝，如 Universal Office ，則應(yīng)分別給出安裝步驟。 所有產(chǎn)品的安裝包括以下界面：安裝快閃界面〖條件〗、安裝初始窗口（歡迎）、版權(quán)聲明界面、選擇安裝路徑界面、選擇程序文件夾（程序組）界面〖條件〗、安 裝進(jìn)程界面〖條件〗及安裝完成界面。 第 2 章 用戶手冊(cè)的內(nèi)容 27 ? 系統(tǒng)配置〖條件〗：應(yīng)給出系統(tǒng)配置的詳細(xì)過程，以便用戶能夠順利操作系統(tǒng)。對(duì)于網(wǎng)絡(luò)版軟件，應(yīng)分別講述服務(wù)器和客戶端的配置過程。 3. 系統(tǒng)的啟動(dòng)：應(yīng)給出系統(tǒng)啟動(dòng)的方法。如果系統(tǒng)由多個(gè)模塊組成，則不必單列出一節(jié)講述系統(tǒng)的啟動(dòng)方法，只須在介紹各個(gè)模塊的操作時(shí)給出模塊的啟動(dòng)方法即可。 對(duì)于系統(tǒng)的安裝及啟動(dòng)的結(jié)構(gòu)總結(jié)如下，供編寫用戶手冊(cè)時(shí)參考： |系統(tǒng)的運(yùn)行環(huán)境 |硬件環(huán)境 | |軟件環(huán)境 | 系統(tǒng)的安裝及啟動(dòng) | |硬件安裝 |系統(tǒng)的安裝 |軟件安裝 | |系統(tǒng)的配置 | |系統(tǒng)的啟動(dòng) 167。 系統(tǒng)操作說(shuō)明 系統(tǒng)操作說(shuō)明是所有用戶手冊(cè)的主體，它所包含的內(nèi)容相當(dāng)廣泛。主要包括：輸入的命令和數(shù)據(jù)、軟件的功能、輸出結(jié)果、出錯(cuò)信息及其矯正和恢復(fù)方法。 對(duì)于不同的軟件，其操作說(shuō)明也應(yīng)有所不同，下面就幾種情況分別予以介紹。 167。 CAD軟件 CAD軟件的操作說(shuō)明應(yīng)包括文 件管理、圖紙尺寸設(shè)置、圖形繪制、圖形編輯、尺寸標(biāo)注、圖層管理、圖庫(kù)調(diào)用〖條件〗、圖庫(kù)維護(hù)〖條件〗及附錄〖條件〗等內(nèi)容。 在用戶手冊(cè)中應(yīng)按操作順序或界面中菜單順序分別對(duì)上述內(nèi)容中的每一項(xiàng)操作予以介紹。要求詳細(xì)給出操作過程及命令格式與功能，具體規(guī)定如下： 1. 各種操作、命令和語(yǔ)言： 軟件系統(tǒng)的使用過程都是使用軟件系統(tǒng)提供的各種操作、命令和語(yǔ)言的過程。所以，我們必須做到： 1) 操作和命令 ：在用戶手冊(cè)中詳細(xì)給出各種操作的過程和功能、命令的格式和功能；應(yīng)當(dāng)描述在使用上的各種限制，如，操作狀態(tài)、操作條件、操作序列等。另外，必要時(shí) 可以通過適當(dāng)?shù)嘏e例講述各種操作和命令的使用方法，以幫助用戶理解。 2) 輸出信息 ：應(yīng)該詳細(xì)列出與操作、命令相關(guān)的各種輸出信息。如果輸出信息的意思本身不是很明顯，應(yīng)當(dāng)給予解釋。另外還應(yīng)當(dāng)說(shuō)明對(duì)于這些信息所采取的操作。 3) 程序設(shè)計(jì)語(yǔ)言〖條件〗： 如果我們的軟件系統(tǒng)提供了某種語(yǔ)言，對(duì)其語(yǔ)言規(guī)則應(yīng)當(dāng)給予說(shuō)明。 用戶手冊(cè)編制規(guī)范 28 2. 各種數(shù)據(jù)： 在軟件的使用過程中，用戶必須與各種數(shù)據(jù)和信息打交道。為了讓用戶 能 夠操作我們的軟件，我們必須為用戶提供各種結(jié)構(gòu)以及每個(gè)數(shù)據(jù)元素的含義 有些數(shù)據(jù)適合在系統(tǒng)操作說(shuō)明中給出，有些適合在后面的附錄中給出，甚至有些除了在 操作說(shuō)明的同時(shí)給出外，還要在附錄中給予歸納，這些都由用戶手冊(cè)編寫人員根據(jù)實(shí)際情況來(lái)決定。這些數(shù)據(jù)包括： 1) 輸入數(shù)據(jù)〖條件〗： 應(yīng)該給出數(shù)據(jù)的內(nèi)容、邏輯結(jié)構(gòu)、格式以及每一個(gè)數(shù)據(jù)元素的意思。如果輸入數(shù)據(jù)依賴于某特定數(shù)據(jù)介質(zhì)，則應(yīng)當(dāng)給予說(shuō)明。 2) 輸出數(shù)據(jù)： 應(yīng)當(dāng)給出軟件以何種形式輸出的數(shù)據(jù)的內(nèi)容和格式，并要求以例樣的形式給予說(shuō)明。 3) 中間數(shù)據(jù)〖條件〗： 如果我們告訴用戶在軟件的運(yùn)行過程中所產(chǎn)生的中間數(shù)據(jù)的內(nèi)容和格式，有助于用戶理解軟件的使用，則應(yīng)當(dāng)給予說(shuō)明 4) 數(shù)據(jù)限制〖條件〗： 如果對(duì)數(shù)據(jù)有限制，如數(shù)據(jù)的 大小限制，則應(yīng)當(dāng)給予說(shuō)明。 5) 數(shù)據(jù)文件〖條件〗： 如果要告訴用戶我們的軟件所使用的某些數(shù)據(jù)文件的結(jié)構(gòu)有助于用戶理解我們軟件的使用，則應(yīng)給予說(shuō)明，但應(yīng)該注意技術(shù)保密。如果對(duì)數(shù)據(jù)文件有所限制，例如每個(gè)文件的最大記錄數(shù)、每個(gè)磁盤的最大文件數(shù)等，應(yīng)當(dāng)給予說(shuō)明。 3. 處理過程〖條件〗： 如果我們簡(jiǎn)要地給用戶描述我們軟件對(duì)用戶的操作、輸入的命令和輸入數(shù)據(jù)的處理過程，有助于用戶了解我們軟件的使用，則應(yīng)給予說(shuō)明。 4. 截圖內(nèi)容 ：目前，多數(shù)軟件已不再采用命令行輸入方式，而是采用對(duì)話框輸入方式。在此情況下，應(yīng)該以圖示方式對(duì)軟件的操作過 程予以介紹。采用圖示方式講述軟件操作過程應(yīng)注意以下幾點(diǎn)： ? 所截圖形的輸入、輸出信息中不應(yīng)包含本公司人員的真實(shí)姓名，且各種輸入、輸出信息以不泄漏公司機(jī)密為原則。 ? 截圖是為使敘述更加明確、簡(jiǎn)潔，所以應(yīng)盡量避免不必要的截圖。一般來(lái)說(shuō)，在用戶手冊(cè)中應(yīng)該包括系統(tǒng)的主界面、各種操作的初始界面（點(diǎn)取命令后彈出的第一個(gè)界面，一般需要輸入信息）、操作中間過程界面、操作結(jié)果界面以及其它一些必要的界面。沒有必要為下拉菜單、快捷菜單等內(nèi)容截圖，因?yàn)檫@些操作都比較簡(jiǎn)單，只要用語(yǔ)言敘述用戶即可明確其操作方法。另外，在同一本手冊(cè)中，應(yīng)避 免重復(fù)截圖，對(duì)于不同輸入或輸出信息的同一界面在手冊(cè)中不應(yīng)重復(fù)（例題除外）。 5. 出錯(cuò)處理： 應(yīng)當(dāng)給出各種出錯(cuò)情況以及相應(yīng)的處理措施。 6. 現(xiàn)對(duì)系統(tǒng)操作說(shuō)明的步驟總結(jié)如下，供編寫用戶手冊(cè)時(shí)參考： 1) 進(jìn)入相關(guān)界面。 第 2 章 用戶手冊(cè)的內(nèi)容 29 2) 調(diào)用命令（選擇菜單、鍵入命令或點(diǎn)擊工具按鈕）。 3) 彈出相應(yīng)的操作初始界面（或提示行）。 4) 對(duì)輸入信息給予說(shuō)明。 5) 繼續(xù)操作（點(diǎn)擊按鈕或選擇參數(shù)及鍵入按鍵等）。 6) 結(jié)果界面（或結(jié)果提示行）。 7) 對(duì)輸出信息給予說(shuō)明。 【警告】 在編寫軟件用戶手冊(cè)的系統(tǒng)操作說(shuō)明時(shí)，我們?cè)跊Q定是否提供某種數(shù)據(jù)的格式時(shí)，應(yīng)以不泄漏公司的技術(shù)而且有利 于用戶使用為準(zhǔn)則。 167。 其它軟件 對(duì)于一些比較復(fù)雜的軟件，一般包括多個(gè)模塊。對(duì)于此類系統(tǒng)，要求按照操作順序?qū)Ω鱾€(gè)模塊分別介紹。一般按模塊分成若干章，在各章中對(duì)相關(guān)模塊的操作予以介紹。對(duì)于此類軟件的操作步驟總結(jié)如下： 1. 啟動(dòng)某一模塊，進(jìn)入該模塊的主界面。 2. 執(zhí)行某一功能（選擇菜單或工具按鈕）。 3. 彈出相關(guān)界面。 4. 對(duì)輸入信息予以說(shuō)明。 5. 繼續(xù)操作（點(diǎn)擊按鈕）。 6. 結(jié)果界面。 7. 對(duì)輸出信息予以說(shuō)明。 有些軟件的操作可能需要一定的技術(shù)和經(jīng)驗(yàn)才能獲得滿意的結(jié)果，那么應(yīng)該在用戶手冊(cè)上盡量給出這些技術(shù)和經(jīng)驗(yàn)的描述，或告 訴用戶如何才能獲得這些技術(shù)和經(jīng)驗(yàn)。例如，在操作 SEAS系統(tǒng)作圖紙凈化處理時(shí)，如何選擇適當(dāng)?shù)拈y值就需要一定的技術(shù)和經(jīng)驗(yàn)。 一些比較簡(jiǎn)單的系統(tǒng)，如 NetEye、 OpenVideo等其系統(tǒng)操作比較簡(jiǎn)單，操作說(shuō)明內(nèi)容比較少。對(duì)于此類軟件，手冊(cè)中可以將操作說(shuō)明歸納為一章，再按操作順序予以介紹。 另外，對(duì)于各種操作、命令、語(yǔ)言、數(shù)據(jù)及截圖內(nèi)容的規(guī)定同 CAD軟件。 167。 系統(tǒng)及數(shù)據(jù)維護(hù) 用戶手冊(cè)編制規(guī)范 210 應(yīng)該給出用戶數(shù)據(jù)的備份、恢復(fù)、刪除、整理的詳細(xì)過程。如果必要，應(yīng)該給出系統(tǒng)數(shù)據(jù)、系統(tǒng)磁盤空間維護(hù)的詳細(xì)過程。 167。 例題 〖條件〗 有些軟件系統(tǒng)可以通過一個(gè)較為完整的例題演示系統(tǒng)部分功能的使用方法，在這個(gè)例題中，用戶應(yīng)該詳細(xì)地描述每一步的操作過程，用戶可以通過這個(gè)例題對(duì)系統(tǒng)的操作有一個(gè)初步的了解。 167。 各種附錄 在用戶手冊(cè)中，有些知識(shí)和信息可以通過附錄的形式提供給用戶，以便于用戶查閱，這些內(nèi)容是： 1. 錯(cuò)誤提示信息： 通常可以以表的形式按照一定的順序，例如按出錯(cuò)提示信息編號(hào)順序、或按出錯(cuò)提示信息的字母順序，給出出錯(cuò)提示信息的編號(hào)、提示信息、相應(yīng)的解釋、出錯(cuò)原因和解決辦法 2. 命令速查表〖條件〗： 通常可以以表的 形式按照一定的順序給出各種命令的概要 (包括命令名稱、各種參數(shù)、及相應(yīng)的功能介紹 )，以幫助有一定經(jīng)驗(yàn)的用戶進(jìn)行快速查找所需信息 3. 數(shù)據(jù)文件格式〖條件〗： 可以通過附錄介紹用戶必須了解或可以了解的各種輸入數(shù)據(jù)文件、輸出結(jié)果文件、中間數(shù)據(jù)文件的格式、限制范圍、適當(dāng)?shù)慕忉尩? 4. 其它信息 〖條件〗： 任何其它有利于用戶使用我們的軟件、方便用戶的信息都可以以附錄的形式提供給用戶 【 注意】 雖然附錄所提供的信息可能均可以在系統(tǒng)操作說(shuō)明中查到，但提供附錄的目的就是為了方便用戶使用，這種重復(fù)還是必要的。 第 2 章 用戶手冊(cè)的內(nèi)容 211 167。 用戶手 冊(cè)的風(fēng)格 用戶手冊(cè)應(yīng)具有自己的風(fēng)格。有的人喜歡用比較深?yuàn)W的概念和語(yǔ)言來(lái)說(shuō)明問題，有的人喜歡用比較長(zhǎng)的句子來(lái)表達(dá)思想，在編制用戶手冊(cè)的過程中這些都是不可取的。用戶手冊(cè)應(yīng)該具備如下特點(diǎn)： 1. 用戶手冊(cè)的句子盡量簡(jiǎn)潔 ： 如果用一個(gè)句子表達(dá)起來(lái)比較復(fù)雜，定語(yǔ)多，則可以分成兩個(gè)甚至幾個(gè)句子來(lái)說(shuō)明，這樣用戶在閱讀用戶手冊(cè)時(shí)會(huì)輕松些。 2. 每節(jié)、段的內(nèi)容明確：每節(jié)的內(nèi)容必須明確，這樣用戶可以通過目錄很方便地查到自己所需要的內(nèi)容；注意段的劃分，每段不要太長(zhǎng)，突出重點(diǎn)，否則用戶不容易獲得其中的精華。 3. 用戶手冊(cè)的用詞要前后一致：在用戶手 冊(cè)中使用的概念、術(shù)語(yǔ)的用詞要前后一致，否則用戶將不容易讀懂此手冊(cè)。 4. 用戶不一定是計(jì)算機(jī)專家：用戶手冊(cè)編寫人員應(yīng)該牢牢記住這一點(diǎn)，我們的大多數(shù)用戶都不是學(xué)計(jì)算機(jī)的，手冊(cè)中應(yīng)該盡量不使用較深?yuàn)W的計(jì)算機(jī)術(shù)語(yǔ)。如果不可避免，我們應(yīng)該給予適當(dāng)?shù)慕忉尯驼f(shuō)明。另外，不要以為我們的用戶什么都懂，所以在編寫用戶手冊(cè)的時(shí)候，應(yīng)該詳細(xì)地描述操作過程中的每一步。 5. 用戶手冊(cè)各部分風(fēng)格應(yīng)該統(tǒng)一：一些較大的系統(tǒng)可能由多人開發(fā)和測(cè)試，如Universal Office ，從而造成用戶手冊(cè)各部分風(fēng)格各異，這就要求用戶手冊(cè)編排人員最終將 各部分統(tǒng)一成風(fēng)格相同的一本手冊(cè)。