信息技術(shù)有限公司用戶手冊編制規(guī)范(文件)
【正文】 ）、版權(quán)聲明界面、選擇安裝路徑界面、選擇程序文件夾（程序組）界面〖條件〗、安裝進程界面〖條件〗及安裝完成界面。如果系統(tǒng)由多個模塊組成，則不必單列出一節(jié)講述系統(tǒng)的啟動方法，只須在介紹各個模塊的操作時給出模塊的啟動方法即可。對于不同的軟件，其操作說明也應(yīng)有所不同，下面就幾種情況分別予以介紹。要求詳細給出操作過程及命令格式與功能，具體規(guī)定如下：1. 各種操作、命令和語言：軟件系統(tǒng)的使用過程都是使用軟件系統(tǒng)提供的各種操作、命令和語言的過程。如果輸出信息的意思本身不是很明顯，應(yīng)當給予解釋。為了讓用戶能夠操作我們的軟件，我們必須為用戶提供各種結(jié)構(gòu)以及每個數(shù)據(jù)元素的含義有些數(shù)據(jù)適合在系統(tǒng)操作說明中給出，有些適合在后面的附錄中給出，甚至有些除了在操作說明的同時給出外，還要在附錄中給予歸納，這些都由用戶手冊編寫人員根據(jù)實際情況來決定。3) 中間數(shù)據(jù)〖條件〗：如果我們告訴用戶在軟件的運行過程中所產(chǎn)生的中間數(shù)據(jù)的內(nèi)容和格式，有助于用戶理解軟件的使用，則應(yīng)當給予說明4) 數(shù)據(jù)限制〖條件〗：如果對數(shù)據(jù)有限制，如數(shù)據(jù)的大小限制，則應(yīng)當給予說明。4. 截圖內(nèi)容：目前，多數(shù)軟件已不再采用命令行輸入方式，而是采用對話框輸入方式。一般來說，在用戶手冊中應(yīng)該包括系統(tǒng)的主界面、各種操作的初始界面（點取命令后彈出的第一個界面，一般需要輸入信息）、操作中間過程界面、操作結(jié)果界面以及其它一些必要的界面。6. 現(xiàn)對系統(tǒng)操作說明的步驟總結(jié)如下，供編寫用戶手冊時參考：1) 進入相關(guān)界面。5) 繼續(xù)操作（點擊按鈕或選擇參數(shù)及鍵入按鍵等）。167。對于此類軟件的操作步驟總結(jié)如下：1. 啟動某一模塊，進入該模塊的主界面。5. 繼續(xù)操作（點擊按鈕）。例如，在操作SEAS系統(tǒng)作圖紙凈化處理時，如何選擇適當?shù)拈y值就需要一定的技術(shù)和經(jīng)驗。167。 例題〖條件〗有些軟件系統(tǒng)可以通過一個較為完整的例題演示系統(tǒng)部分功能的使用方法，在這個例題中，用戶應(yīng)該詳細地描述每一步的操作過程，用戶可以通過這個例題對系統(tǒng)的操作有一個初步的了解。 用戶手冊的風(fēng)格用戶手冊應(yīng)具有自己的風(fēng)格。3. 用戶手冊的用詞要前后一致：在用戶手冊中使用的概念、術(shù)語的用詞要前后一致，否則用戶將不容易讀懂此手冊。5. 用戶手冊各部分風(fēng)格應(yīng)該統(tǒng)一：一些較大的系統(tǒng)可能由多人開發(fā)和測試，如Universal Office ，從而造成用戶手冊各部分風(fēng)格各異，這就要求用戶手冊編排人員最終將各部分統(tǒng)一成風(fēng)格相同的一本手冊。如果不可避免，我們應(yīng)該給予適當?shù)慕忉尯驼f明。用戶手冊應(yīng)該具備如下特點：1. 用戶手冊的句子盡量簡潔：如果用一個句子表達起來比較復(fù)雜，定語多，則可以分成兩個甚至幾個句子來說明，這樣用戶在閱讀用戶手冊時會輕松些。 各種附錄在用戶手冊中，有些知識和信息可以通過附錄的形式提供給用戶，以便于用戶查閱，這些內(nèi)容是：1. 錯誤提示信息：通常可以以表的形式按照一定的順序，例如按出錯提示信息編號順序、或按出錯提示信息的字母順序，給出出錯提示信息的編號、提示信息、相應(yīng)的解釋、出錯原因和解決辦法2. 命令速查表〖條件〗：通常可以以表的形式按照一定的順序給出各種命令的概要(包括命令名稱、各種參數(shù)、及相應(yīng)的功能介紹)，以幫助有一定經(jīng)驗的用戶進行快速查找所需信息3. 數(shù)據(jù)文件格式〖條件〗：可以通過附錄介紹用戶必須了解或可以了解的各種輸入數(shù)據(jù)文件、輸出結(jié)果文件、中間數(shù)據(jù)文件的格式、限制范圍、適當?shù)慕忉尩?. 其它信息 〖條件〗：任何其它有利于用戶使用我們的軟件、方便用戶的信息都可以以附錄的形式提供給用戶【注意】雖然附錄所提供的信息可能均可以在系統(tǒng)操作說明中查到，但提供附錄的目的就是為了方便用戶使用，這種重復(fù)還是必要的。如果必要，應(yīng)該給出系統(tǒng)數(shù)據(jù)、系統(tǒng)磁盤空間維護的詳細過程。對于此類軟件，手冊中可以將操作說明歸納為一章，再按操作順序予以介紹。7. 對輸出信息予以說明。3. 彈出相關(guān)界面。對于此類系統(tǒng)，要求按照操作順序?qū)Ω鱾€模塊分別介紹。7) 對輸出信息給予說明。3) 彈出相應(yīng)的操作初始界面（或提示行）。另外，在同一本手冊中，應(yīng)避免重復(fù)截圖，對于不同輸入或輸出信息的同一界面在手冊中不應(yīng)重復(fù)（例題除外）。采用圖示方式講述軟件操作過程應(yīng)注意以下幾點：? 所截圖形的輸入、輸出信息中不應(yīng)包含本公司人員的真實姓名，且各種輸入、輸出信息以不泄漏公司機密為原則。如果對數(shù)據(jù)文件有所限制，例如每個文件的最大記錄數(shù)、每個磁盤的最大文件數(shù)等，應(yīng)當給予說明。如果輸入數(shù)據(jù)依賴于某特定數(shù)據(jù)介質(zhì)，則應(yīng)當給予說明。3) 程序設(shè)計語言〖條件〗：如果我們的軟件系統(tǒng)提供了某種語言，對其語言規(guī)則應(yīng)當給予說明。另外，必要時可以通過適當?shù)嘏e例講述各種操作和命令的使用方法，以幫助用戶理解。 CAD軟件CAD軟件的操作說明應(yīng)包括文件管理、圖紙尺寸設(shè)置、圖形繪制、圖形編輯、尺寸標注、圖層管理、圖庫調(diào)用〖條件〗、圖庫維護〖條件〗及附錄〖條件〗等內(nèi)容。 系統(tǒng)操作說明系統(tǒng)操作說明是所有用戶手冊的主體，它所包含的內(nèi)容相當廣泛。對于網(wǎng)絡(luò)版軟件，應(yīng)分別講述服務(wù)器和客戶端的配置過程。如果二者安裝過程相似，可以詳細介紹一種，另一種參考前一種即可。系統(tǒng)的安裝包括軟件的安裝過程及系統(tǒng)環(huán)境的配置〖條件〗，必要時還應(yīng)給出硬件的安裝〖條件〗。? 軟件環(huán)境要求說明：系統(tǒng)運行時所需軟件支持環(huán)境的描述。 系統(tǒng)安裝及啟動如果手冊中包括基礎(chǔ)知識介紹，應(yīng)把系統(tǒng)安裝及啟動作為第2章，否則，將其作為第1章首先向讀者予以介紹。在某些情況下，我們只需要用戶掌握用戶手冊中使用的那些概念，那么我們就有必要編寫一章“基礎(chǔ)知識介紹”來進行專門介紹。 基礎(chǔ)知識介紹〖條件〗這一部分內(nèi)容是在一定
公司管理相關(guān)推薦
鄂ICP備17016276號-1