用戶手冊

用戶手冊

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

內容

編寫內容要求如下。

(1)引言

①編寫目的:闡明編寫手冊的目的,指明讀者對象。

②項目背景:說明項目的來源、委託單位、開發單位及主管部門。

用戶手冊 用戶手冊

③定義:列出手冊中用到的專門術語定義和縮寫詞的原意。

④參考資料:列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源,包括項目的計畫任務書,契約或批文;項目開發計畫;需求規格說明書;概要設計說明書;詳細設計說明書;測試計畫;手冊中引用的其他資料、採用的軟體工程標準或軟體工程規範。

(2)軟體概述

①目標。

②功能。

③性能。包括數據精確度(包括輸入、輸出及處理數據的精度),時間特性(如回響時間、處理時間、數據傳輸時問等),靈活性(在操作方式、運行環境需做某些變更時軟體的適應能力)。

(3)運行環境

①硬體:列出軟體系統運行時所需的硬體最小配置,如計算機型號、主存容量;外存儲器、媒體、記錄格式、設備型號及數量;輸入、輸出設備;數據傳輸設備及數據轉換設備的型號及數量。

②支持軟體:作業系統名稱及版本號;語言編譯系統的名稱及版本號;資料庫管理系統的名稱及版本號;其他必要的支持軟體。

(4)使用說明

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

②輸入:給出輸入數據或參數的要求。

③輸出:給出每項輸出數據的說明。

④出錯和恢復:出錯信息及其含義、用戶應採取的措施,如修改、恢復、再啟動等。

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

(5)運行說明

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

②運行步驟:按順序說明每種運行的步驟,應包括運行控制;操作信息(運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項);輸入/輸出檔案(給出建立和更新檔案的有關信息,如檔案的名稱及編號、記錄媒體、存留的目錄、檔案的支配[說明確定保留檔案或廢棄檔案的準則,分發檔案的對象,占用硬體的優先權及保密控制等]);啟動或恢復過程。

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

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

(8)程式檔案(或命令檔案)和數據檔案一覽表:按檔案名稱字母順序或按功能與模組分類順序逐個列出檔案名稱稱、標識符及說明。

(9)用戶操作舉例。

測試

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

1.用戶手冊的完整性

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

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

考察用戶手冊與軟體實際功能的一致程度。當確認用戶手冊基本完整後,還要注意用戶手冊與實際功能描述是否一致。這種問題往往是由於用戶手冊跟不上軟體版本的更新速度造成的。對用戶來說,容易造成對描述不一致的功能的誤解和疑惑,進而影響用戶對軟體的使用。優秀的用戶手冊應該根據軟體的升級而及時更新,手冊描述應該與軟體實際功能保持一致。

3.用戶手冊的易理解性

考察用戶手冊對關鍵、重要的操作有無圖文說明,文字、圖表是否易於理解。對於關鍵、重要的操作僅僅只有文字說明肯定是不夠的,應該附以圖表使說明更為直觀、明了。優秀的用戶手冊應該是圖文並舉,易於理解。

4.用戶手冊提供學習操作的實例

考察對主要功能和關鍵操作提供的套用實例是否豐富,提供的實例描述是否詳細。當前大量軟體的用戶手冊只有簡單的圖文說明,而無套用實例。這樣的用戶手冊看起來就像是軟體界面的簡單複製,對於用戶來說,實際上沒有什麼幫助。例如財務軟體,用戶手冊就應該提供具體建賬實例及具體賬務處理的實例,這樣才能使用戶看完用戶手冊後,能夠獨立完成新賬簿的建立並逐漸學會使用軟體處理賬務信息。優秀的用戶手冊不僅要對主要功能和關鍵操作提供套用實例,而且對實例的描述應做到詳細、充分,易於用戶理解。

5.用戶手冊的印刷與包裝質量

考察用戶手冊包裝的商品化程度,印刷質量。有些用戶手冊是簡單列印、裝訂而成,過於粗糙,不易於用戶保存。優秀的用戶手冊應提供商品化包裝,並且印刷精美。

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

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

(2)嘗試每一條建議。

(3)檢查每條陳述。

(4)查找容易誤導用戶的內容。

案例

案例:軟體產品“用戶手冊”的標準檔案

相關詞條

相關搜尋

熱門詞條

聯絡我們