某軟件公司用戶手冊(cè)編制規(guī)范-資料下載頁(yè)
2025-04-12 22:10本頁(yè)面
【正文】 使用的某些數(shù)據(jù)文件的結(jié)構(gòu)有助于用戶理解我們軟件的使用，則應(yīng)給予說(shuō)明，但應(yīng)該注意技術(shù)保密。如果對(duì)數(shù)據(jù)文件有所限制，例如每個(gè)文件的最大記錄數(shù)、每個(gè)磁盤的最大文件數(shù)等，應(yīng)當(dāng)給予說(shuō)明。處理過(guò)程〖條件〗：如果我們簡(jiǎn)要地給用戶描述我們軟件對(duì)用戶的操作、輸入的命令和輸入數(shù)據(jù)的處理過(guò)程，有助于用戶了解我們軟件的使用，則應(yīng)給予說(shuō)明。截圖內(nèi)容：目前，多數(shù)軟件已不再采用命令行輸入方式，而是采用對(duì)話框輸入方式。在此情況下，應(yīng)該以圖示方式對(duì)軟件的操作過(guò)程予以介紹。采用圖示方式講述軟件操作過(guò)程應(yīng)注意以下幾點(diǎn)：所截圖形的輸入、輸出信息中不應(yīng)包含本公司人員的真實(shí)姓名，且各種輸入、輸出信息以不泄漏公司機(jī)密為原則。截圖是為使敘述更加明確、簡(jiǎn)潔，所以應(yīng)盡量避免不必要的截圖。一般來(lái)說(shuō)，在用戶手冊(cè)中應(yīng)該包括系統(tǒng)的主界面、各種操作的初始界面（點(diǎn)取命令后彈出的第一個(gè)界面，一般需要輸入信息）、操作中間過(guò)程界面、操作結(jié)果界面以及其它一些必要的界面。沒(méi)有必要為下拉菜單、快捷菜單等內(nèi)容截圖，因?yàn)檫@些操作都比較簡(jiǎn)單，只要用語(yǔ)言敘述用戶即可明確其操作方法。另外，在同一本手冊(cè)中，應(yīng)避免重復(fù)截圖，對(duì)于不同輸入或輸出信息的同一界面在手冊(cè)中不應(yīng)重復(fù)（例題除外）。出錯(cuò)處理：應(yīng)當(dāng)給出各種出錯(cuò)情況以及相應(yīng)的處理措施?，F(xiàn)對(duì)系統(tǒng)操作說(shuō)明的步驟總結(jié)如下，供編寫(xiě)用戶手冊(cè)時(shí)參考：進(jìn)入相關(guān)界面。調(diào)用命令（選擇菜單、鍵入命令或點(diǎn)擊工具按鈕）。彈出相應(yīng)的操作初始界面（或提示行）。對(duì)輸入信息給予說(shuō)明。繼續(xù)操作（點(diǎn)擊按鈕或選擇參數(shù)及鍵入按鍵等）。結(jié)果界面（或結(jié)果提示行）。對(duì)輸出信息給予說(shuō)明?！揪妗吭诰帉?xiě)軟件用戶手冊(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é)如下：?jiǎn)?dòng)某一模塊，進(jìn)入該模塊的主界面。執(zhí)行某一功能（選擇菜單或工具按鈕）。彈出相關(guān)界面。對(duì)輸入信息予以說(shuō)明。繼續(xù)操作（點(diǎn)擊按鈕）。結(jié)果界面。對(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ù)應(yīng)該給出用戶數(shù)據(jù)的備份、恢復(fù)、刪除、整理的詳細(xì)過(guò)程。如果必要，應(yīng)該給出系統(tǒng)數(shù)據(jù)、系統(tǒng)磁盤空間維護(hù)的詳細(xì)過(guò)程。167。 例題〖條件〗有些軟件系統(tǒng)可以通過(guò)一個(gè)較為完整的例題演示系統(tǒng)部分功能的使用方法，在這個(gè)例題中，用戶應(yīng)該詳細(xì)地描述每一步的操作過(guò)程，用戶可以通過(guò)這個(gè)例題對(duì)系統(tǒng)的操作有一個(gè)初步的了解。167。 各種附錄在用戶手冊(cè)中，有些知識(shí)和信息可以通過(guò)附錄的形式提供給用戶，以便于用戶查閱，這些內(nèi)容是：1. 錯(cuò)誤提示信息：通?？梢砸员淼男问桨凑找欢ǖ捻樞?，例如按出錯(cuò)提示信息編號(hào)順序、或按出錯(cuò)提示信息的字母順序，給出出錯(cuò)提示信息的編號(hào)、提示信息、相應(yīng)的解釋、出錯(cuò)原因和解決辦法2. 命令速查表〖條件〗：通?？梢砸员淼男问桨凑找欢ǖ捻樞蚪o出各種命令的概要(包括命令名稱、各種參數(shù)、及相應(yīng)的功能介紹)，以幫助有一定經(jīng)驗(yàn)的用戶進(jìn)行快速查找所需信息3. 數(shù)據(jù)文件格式〖條件〗：可以通過(guò)附錄介紹用戶必須了解或可以了解的各種輸入數(shù)據(jù)文件、輸出結(jié)果文件、中間數(shù)據(jù)文件的格式、限制范圍、適當(dāng)?shù)慕忉尩?. 其它信息 〖條件〗：任何其它有利于用戶使用我們的軟件、方便用戶的信息都可以以附錄的形式提供給用戶【注意】雖然附錄所提供的信息可能均可以在系統(tǒng)操作說(shuō)明中查到，但提供附錄的目的就是為了方便用戶使用，這種重復(fù)還是必要的。 167。 用戶手冊(cè)的風(fēng)格用戶手冊(cè)應(yīng)具有自己的風(fēng)格。有的人喜歡用比較深?yuàn)W的概念和語(yǔ)言來(lái)說(shuō)明問(wèn)題，有的人喜歡用比較長(zhǎng)的句子來(lái)表達(dá)思想，在編制用戶手冊(cè)的過(guò)程中這些都是不可取的。用戶手冊(cè)應(yīng)該具備如下特點(diǎn)：用戶手冊(cè)的句子盡量簡(jiǎn)潔：如果用一個(gè)句子表達(dá)起來(lái)比較復(fù)雜，定語(yǔ)多，則可以分成兩個(gè)甚至幾個(gè)句子來(lái)說(shuō)明，這樣用戶在閱讀用戶手冊(cè)時(shí)會(huì)輕松些。每節(jié)、段的內(nèi)容明確：每節(jié)的內(nèi)容必須明確，這樣用戶可以通過(guò)目錄很方便地查到自己所需要的內(nèi)容；注意段的劃分，每段不要太長(zhǎng)，突出重點(diǎn)，否則用戶不容易獲得其中的精華。用戶手冊(cè)的用詞要前后一致：在用戶手冊(cè)中使用的概念、術(shù)語(yǔ)的用詞要前后一致，否則用戶將不容易讀懂此手冊(cè)。用戶不一定是計(jì)算機(jī)專家：用戶手冊(cè)編寫(xiě)人員應(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ō)明。另外，不要以為我們的用戶什么都懂，所以在編寫(xiě)用戶手冊(cè)的時(shí)候，應(yīng)該詳細(xì)地描述操作過(guò)程中的每一步。用戶手冊(cè)各部分風(fēng)格應(yīng)該統(tǒng)一：一些較大的系統(tǒng)可能由多人開(kāi)發(fā)和測(cè)試，如Universal Office ，從而造成用戶手冊(cè)各部分風(fēng)格各異，這就要求用戶手冊(cè)編排人員最終將各部分統(tǒng)一成風(fēng)格相同的一本手冊(cè)。來(lái)自 ....資料搜索
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1