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

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

(1)引言

①編寫目的：闡明編寫手冊的目的，指明讀者對象。

②項目背景：說明項目的來源、委托單位、開發(fā)單位及主管部門。

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

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

(2)軟件概述

①目標。

②功能。

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

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

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

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

(4)使用說明

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

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

③輸出：給出每項輸出數(shù)據(jù)的說明。

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

⑤求助查詢：說明如何操作。

(5)運行說明

①運行表：列出每種可能的運行情況，說明其運行目的。

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

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

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

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

(9)用戶操作舉例。

用戶手冊是用戶文檔中最重要的一部分，下面詳細介紹用戶手冊測試的要點。

1．用戶手冊的完整性

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

2．用戶手冊的描述與軟件實際功能的一致性

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

3．用戶手冊的易理解性

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

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

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

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

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

在對用戶手冊進行測試時，應(yīng)該拿著它坐在計算機前，認真的進行如下操作。

(1)準確按照手冊描述使用程序。

(2)嘗試每一條建議。

(3)檢查每條陳述。

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

案例：軟件產(chǎn)品“用戶手冊”的標準檔案

1.引言

1．1  編寫目的

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

1．2  背景

說明：

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

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

1．3定義

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

1．4  參考資料

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

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

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

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

2.用途

2．1  功能

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

2．2  性能

2．2．1精度

說明對各項輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達到的精度，包括傳輸中的精度要求。

2．2．2時間特性

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

2．2．3靈活性

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

2．3安全保密

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

3運行環(huán)境

3．1硬設(shè)備

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

(1)處理機的型號、內(nèi)存容量。

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

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

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

3．2  支持軟件

說明為運行本軟件所需要的支持軟件，例如：

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

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

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

(4)其他支持軟件。

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

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

4.使用過程

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

4．1  安裝與初始化

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

4．2輸入

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

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

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

(1)情況，如人員變動、庫存缺貨。

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

(3)情況來源，如人事部門、倉庫管理部門。

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

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

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

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

4．2．2輸入格式

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

(1)長度，如字符數(shù)(行)、字符數(shù)(項)。

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

(3)標號，如標記或標識符。

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

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

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

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

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

4．2．3  輸入舉例

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

(1)控制或首部，如用來表示輸入的種類和類型的[[信息]]、標識符輸入日期，正文起點和對所用編碼的規(guī)定。

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

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

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

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

4．3輸出

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

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

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

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

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

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

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

4.32 輸出格式

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

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

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

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

4.3.3輸出舉例

為每種輸出類型提供例子。對例子中的每一項進行說明：

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

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

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

4.4文件查詢

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

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

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

4.6終端操作

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