用戶手冊(cè)是詳細(xì)描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。

編寫內(nèi)容要求如下。

(1)引言

①編寫目的：闡明編寫手冊(cè)的目的，指明讀者對(duì)象。

②項(xiàng)目背景：說(shuō)明項(xiàng)目的來(lái)源、委托單位、開發(fā)單位及主管部門。

③定義：列出手冊(cè)中用到的專門術(shù)語(yǔ)定義和縮寫詞的原意。

④參考資料：列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，包括項(xiàng)目的計(jì)劃任務(wù)書，合同或批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說(shuō)明書；概要設(shè)計(jì)說(shuō)明書；詳細(xì)設(shè)計(jì)說(shuō)明書；測(cè)試計(jì)劃；手冊(cè)中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。

(2)軟件概述

①目標(biāo)。

②功能。

③性能。包括數(shù)據(jù)精確度(包括輸入、輸出及處理數(shù)據(jù)的精度)，時(shí)間特性(如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)問(wèn)等)，靈活性(在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力)。

(3)運(yùn)行環(huán)境

①硬件：列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如計(jì)算機(jī)型號(hào)、主存容量；外存儲(chǔ)器、媒體、記錄格式、設(shè)備型號(hào)及數(shù)量；輸入、輸出設(shè)備；數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量。

②支持軟件：操作系統(tǒng)名稱及版本號(hào)；語(yǔ)言編譯系統(tǒng)的名稱及版本號(hào)；數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱及版本號(hào)；其他必要的支持軟件。

(4)使用說(shuō)明

①安裝和初始化：給出程序的存儲(chǔ)形式、操作命令、反饋信息及其含義、表明安裝完成的測(cè)試實(shí)例以及安裝所需的軟件開發(fā)工具等。

②輸入：給出輸入數(shù)據(jù)或參數(shù)的要求。

③輸出：給出每項(xiàng)輸出數(shù)據(jù)的說(shuō)明。

④出錯(cuò)和恢復(fù)：出錯(cuò)信息及其含義、用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動(dòng)等。

⑤求助查詢：說(shuō)明如何操作。

(5)運(yùn)行說(shuō)明

①運(yùn)行表：列出每種可能的運(yùn)行情況，說(shuō)明其運(yùn)行目的。

②運(yùn)行步驟：按順序說(shuō)明每種運(yùn)行的步驟，應(yīng)包括運(yùn)行控制；操作信息(運(yùn)行目的、操作要求、啟動(dòng)方法、預(yù)計(jì)運(yùn)行時(shí)間、操作命令格式及說(shuō)明、其他事項(xiàng))；輸入／輸出文件(給出建立和更新文件的有關(guān)信息，如文件的名稱及編號(hào)、記錄媒體、存留的目錄、文件的支配[說(shuō)明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對(duì)象，占用硬件的優(yōu)先級(jí)及保密控制等])；啟動(dòng)或恢復(fù)過(guò)程。

(6)常規(guī)過(guò)程：提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。

(7)操作命令一覽表：按字母順序逐個(gè)列出全部操作命令的格式、功能及參數(shù)說(shuō)明。

(8)程序文件(或命令文件)和數(shù)據(jù)文件一覽表：按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱、標(biāo)識(shí)符及說(shuō)明。

(9)用戶操作舉例。

用戶手冊(cè)是用戶文檔中最重要的一部分，下面詳細(xì)介紹用戶手冊(cè)測(cè)試的要點(diǎn)。

1．用戶手冊(cè)的完整性

重點(diǎn)考察用戶手冊(cè)內(nèi)容的全面性與完整性，從總體上把握用戶手冊(cè)的質(zhì)量。這一項(xiàng)看似簡(jiǎn)單，但在實(shí)際測(cè)試中很多開發(fā)者還是無(wú)法做到這一基本標(biāo)準(zhǔn)。很多軟件由于開發(fā)過(guò)于倉(cāng)促，在付諸使用時(shí)，用戶手冊(cè)中缺少關(guān)于某些模塊的說(shuō)明，讓用戶使用起來(lái)比較困難。優(yōu)秀的用戶手冊(cè)內(nèi)容應(yīng)該是包括軟件的所有功能模塊。

2．用戶手冊(cè)的描述與軟件實(shí)際功能的一致性

考察用戶手冊(cè)與軟件實(shí)際功能的二致程度。當(dāng)確認(rèn)用戶手冊(cè)基本完整后，還要注意用戶手冊(cè)與實(shí)際功能描述是否一致。這種問(wèn)題往往是由于用戶手冊(cè)跟不上軟件版本的更新速度造成的。對(duì)用戶來(lái)說(shuō)，容易造成對(duì)描述不一致的功能的誤解和疑惑，進(jìn)而影響用戶對(duì)軟件的使用。優(yōu)秀的用戶手冊(cè)應(yīng)該根據(jù)軟件的升級(jí)而及時(shí)更新，手冊(cè)描述應(yīng)該與軟件實(shí)際功能保持一致。

3．用戶手冊(cè)的易理解性

考察用戶手冊(cè)對(duì)關(guān)鍵、重要的操作有無(wú)圖文說(shuō)明，文字、圖表是否易于理解。對(duì)于關(guān)鍵、重要的操作僅僅只有文字說(shuō)明肯定是不夠的，應(yīng)該附以圖表使說(shuō)明更為直觀、明了。優(yōu)秀的用戶手冊(cè)應(yīng)該是圖文并舉，易于理解。

4．用戶手冊(cè)提供學(xué)習(xí)操作的實(shí)例

考察對(duì)主要功能和關(guān)鍵操作提供的應(yīng)用實(shí)例是否豐富，提供的實(shí)例描述是否詳細(xì)。當(dāng)前大量軟件的用戶手冊(cè)只有簡(jiǎn)單的圖文說(shuō)明，而無(wú)應(yīng)用實(shí)例。這樣的用戶手冊(cè)看起來(lái)就像是軟件界面的簡(jiǎn)單復(fù)制，對(duì)于用戶來(lái)說(shuō)，實(shí)際上沒(méi)有什么幫助。例如財(cái)務(wù)軟件，用戶手冊(cè)就應(yīng)該提供具體建賬實(shí)例及具體賬務(wù)處理的實(shí)例，這樣才能使用戶看完用戶手冊(cè)后，能夠獨(dú)立完成新賬簿的建立并逐漸學(xué)會(huì)使用軟件處理賬務(wù)信息。優(yōu)秀的用戶手冊(cè)不僅要對(duì)主要功能和關(guān)鍵操作提供應(yīng)用實(shí)例，而且對(duì)實(shí)例的描述應(yīng)做到詳細(xì)、充分，易于用戶理解。

5．用戶手冊(cè)的印刷與包裝質(zhì)量

考察用戶手冊(cè)包裝的商品化程度，印刷質(zhì)量。有些用戶手冊(cè)是簡(jiǎn)單打印、裝訂而成，過(guò)于粗糙，不易于用戶保存。優(yōu)秀的用戶手冊(cè)應(yīng)提供商品化包裝，并且印刷精美。

在對(duì)用戶手冊(cè)進(jìn)行測(cè)試時(shí)，應(yīng)該拿著它坐在計(jì)算機(jī)前，認(rèn)真的進(jìn)行如下操作。

(1)準(zhǔn)確按照手冊(cè)描述使用程序。

(2)嘗試每一條建議。

(3)檢查每條陳述。

(4)查找容易誤導(dǎo)用戶的內(nèi)容。

案例：軟件產(chǎn)品“用戶手冊(cè)”的標(biāo)準(zhǔn)檔案

1.引言

1．1  編寫目的

說(shuō)明編寫用戶手冊(cè)的目的，指出預(yù)期的讀者。

1．2  背景

說(shuō)明：

(1)用戶手冊(cè)所描述的軟件系統(tǒng)的名稱。

(2)該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶(或首批用戶)及安裝此軟件的計(jì)算中心。

1．3定義

列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。

1．4  參考資料

列出有用的參考資料，例如：

(1)[[項(xiàng)目]]的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或[[合同]]、上級(jí)機(jī)關(guān)的批文。

(2)屬于本項(xiàng)目的其他已發(fā)表文件。

(3)本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件資料的來(lái)源。

2.用途

2．1  功能

結(jié)合本軟件的開發(fā)目的逐項(xiàng)地說(shuō)明本軟件所具有的各項(xiàng)功能以及它們的極限范圍。

2．2  性能

2．2．1精度

說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。

2．2．2時(shí)間特性

定量地說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間、更新處理時(shí)間、數(shù)據(jù)傳輸和轉(zhuǎn)換時(shí)間以及計(jì)算時(shí)間等。

2．2．3靈活性

說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶需求(如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求)發(fā)生變化時(shí)，本軟件的適應(yīng)能力。

2．3安全保密

說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。

3運(yùn)行環(huán)境

3．1硬設(shè)備

列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，例如：

(1)處理機(jī)的型號(hào)、內(nèi)存容量。

(2)所要求的外存儲(chǔ)器、[[媒體]]、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)／脫機(jī)。

(3)I／O設(shè)備(聯(lián)機(jī)／脫機(jī))。

(4)數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。

3．2  支持軟件

說(shuō)明為運(yùn)行本軟件所需要的支持軟件，例如：

(1)操作系統(tǒng)的名稱和版本號(hào)。

(2)程序語(yǔ)言的編譯／匯編系統(tǒng)的名稱和版本號(hào)。

(3)[[數(shù)據(jù)庫(kù)管理系統(tǒng)]]的名稱和版本號(hào)。

(4)其他支持軟件。

3．3數(shù)據(jù)結(jié)構(gòu)

列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。

4.使用過(guò)程

在本章，首先用圖表的形式說(shuō)明軟件的功能與系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)乖之間的關(guān)系。

4．1  安裝與初始化

按步驟說(shuō)明因使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，包括程序的存儲(chǔ)形式安裝與初始化過(guò)程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。
表征安裝工千完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中用到的專用軟件。

4．2輸入

規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。

4．2．1  輸入數(shù)據(jù)的現(xiàn)實(shí)背景’

說(shuō)明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：

(1)情況，如人員變動(dòng)、庫(kù)存缺貨。

(2)情況出現(xiàn)的頻度，如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù)。

(3)情況來(lái)源，如人事部門、倉(cāng)庫(kù)管理部門。

(4)輸入媒體，如鍵盤、穿孔卡片、磁帶。

(5)限制，即出于安全和保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制。

(6)[[質(zhì)量管理]]，如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，建立出錯(cuò)情況記錄等。

(7)支配，如確定輸入數(shù)據(jù)是保留還是廢棄、是否要分配給其他的接受者等。

4．2．2輸入格式

說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則和有關(guān)的約定，主要是：

(1)長(zhǎng)度，如字符數(shù)(行)、字符數(shù)(項(xiàng))。

(2)格式基準(zhǔn)，如以左面的邊沿為基準(zhǔn)。

(3)標(biāo)號(hào)，如標(biāo)記或標(biāo)識(shí)符。

(4)順序，如各個(gè)數(shù)據(jù)項(xiàng)的次序和位置。

(5)標(biāo)點(diǎn)，如因表示行、數(shù)據(jù)組的開始或結(jié)束而使用的空格、斜線、星號(hào)和字符組等。

(6)詞匯表，如給出允許使用的字符組合的列表，禁止使用六的字符組合的列表等。

(7)省略和重復(fù)，如給出用來(lái)表示輸入元素可省略或重復(fù)的表示方式。

(8)控制，如給出用來(lái)表示輸入開始或結(jié)束的[[控制信息]]。

4．2．3  輸入舉例

為每個(gè)完整的輸入形式提供樣本，包括：

(1)控制或首部，如用來(lái)表示輸入的種類和類型的[[信息]]、標(biāo)識(shí)符輸入日期，正文起點(diǎn)和對(duì)所用編碼的規(guī)定。

(2)主體，輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分。

(3)尾部，用來(lái)表示輸入結(jié)束的[[控制信息]]，如累計(jì)字符總數(shù)等。

(4)省略，指出哪些輸入數(shù)據(jù)是可省略的。

(5)重復(fù)，指出哪些輸入數(shù)據(jù)是重復(fù)的。

4．3輸出

4．3．1輸出數(shù)據(jù)的現(xiàn)實(shí)背景

說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：

(1)使用，這些輸出數(shù)據(jù)是給誰(shuí)的，用來(lái)干什么。

(2)使用頻度，如每周的、定期的被查閱的[[次數(shù)]]。

(3)媒體，如打印、CRI顯示、磁帶、卡片、磁盤。

(4)[[質(zhì)量管理]]，如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定。

(5)支配，如確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。

4.32 輸出格式

給出對(duì)每一類輸出信息的解釋，主要是：

(1)首部，如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)。

(2)主體，輸出信息的主體，包括分欄標(biāo)題。

(3)尾部，包括累計(jì)總數(shù)和結(jié)束標(biāo)記。

4.3.3輸出舉例

為每種輸出類型提供例子。對(duì)例子中的每一項(xiàng)進(jìn)行說(shuō)明：

(1)定義，如每項(xiàng)輸出信息的意義和用途。

(2)來(lái)源，如從特定的輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出或從軟件的計(jì)算過(guò)程中得到的。

(3)特性，如輸出的值域、計(jì)量單位、在什么情況下可默認(rèn)等。

4.4文件查詢

文件查詢的編寫針對(duì)具有查詢功能的軟件，內(nèi)容包括：與數(shù)據(jù)庫(kù)查詢有關(guān)的初始化、準(zhǔn)備、處理所需要的詳細(xì)規(guī)定。說(shuō)明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。

4.5出錯(cuò)處理和恢復(fù)

列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶承擔(dān)的修改和糾正工作，指出為了確保再啟動(dòng)和恢復(fù)的能力，用戶必須遵循的處理過(guò)程。

4.6終端操作

當(dāng)軟件是在多終端系統(tǒng)上工作時(shí)，應(yīng)編寫本條來(lái)說(shuō)明[[終端]]的配置安排，連接步驟、數(shù)據(jù)和參數(shù)輸入步驟以及控制規(guī)定、說(shuō)明通過(guò)終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文件的[[能力]]、語(yǔ)言、過(guò)程和輔助性程序等。