用戶手冊

出自 MBA智库百科(https://wiki.mbalib.com/)

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

　　編寫內容要求如下。

　　(1)引言

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

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

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

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

　　(2)軟體概述

　　①目標。

　　②功能。

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

　　(3)運行環境

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

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

　　(4)使用說明

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

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

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

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

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

　　(5)運行說明

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

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

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

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

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

　　(9)用戶操作舉例。

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

　　1．用戶手冊的完整性

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

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

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

　　3．用戶手冊的易理解性

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

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

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

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

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

　　在對用戶手冊進行測試時，應該拿著它坐在電腦前，認真的進行如下操作。

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

　　(2)嘗試每一條建議。

　　(3)檢查每條陳述。

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

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

　　1.引言

　　1．1  編寫目的

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

　　1．2  背景

　　說明：

　　(1)用戶手冊所描述的軟體系統的名稱。

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

　　1．3定義

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

　　1．4  參考資料

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

　　(1)[[項目]]的經核准的計劃任務書或[[合同]]、上級機關的批文。

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

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

　　2.用途

　　2．1  功能

　　結合本軟體的開發目的逐項地說明本軟體所具有的各項功能以及它們的極限範圍。

　　2．2  性能

　　2．2．1精度

　　說明對各項輸入數據的精度要求和本軟體輸出數據達到的精度，包括傳輸中的精度要求。

　　2．2．2時間特性

　　定量地說明本軟體的時間特性，如響應時間、更新處理時間、數據傳輸和轉換時間以及計算時間等。

　　2．2．3靈活性

　　說明本軟體所具有的靈活性，即當用戶需求(如對操作方式、運行環境、結果精度、時間特性等的要求)發生變化時，本軟體的適應能力。

　　2．3安全保密

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

　　3運行環境

　　3．1硬設備

　　列出為運行本軟體所要求的硬設備的最小配置，例如：

　　(1)處理機的型號、記憶體容量。

　　(2)所要求的外存儲器、[[媒體]]、記錄格式、設備的型號和台數、[[聯機]]／[[離線]]。

　　(3)I／O設備(聯機／離線)。

　　(4)數據傳輸設備和轉換設備的型號、台數。

　　3．2  支持軟體

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

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

　　(2)程式語言的編譯／彙編系統的名稱和版本號。

　　(3)[[資料庫管理系統]]的名稱和版本號。

　　(4)其他支持軟體。

　　3．3[[數據結構]]

　　列出為支持本軟體的運行所需要的資料庫或數據文捲。

　　4.使用過程

　　在本章，首先用圖表的形式說明軟體的功能與系統的輸入源機構、輸出接收機乖之間的關係。

　　4．1  安裝與初始化

　　按步驟說明因使用本軟體而需進行的安裝與初始化過程，包括程式的存儲形式安裝與初始化過程中的全部操作命令、系統對這些命令的反應與答覆。
表徵安裝工千完成的測試實例等。如果有的話，還應說明安裝過程中用到的[[專用軟體]]。

　　4．2輸入

　　規定輸入數據和參量的準備要求。

　　4．2．1  輸入數據的現實背景    ’

　　說明輸入數據的現實背景，主要是：

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

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

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

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

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

　　(6)[[質量管理]]，如對輸入數據合理性的檢驗以及當輸入數據有錯誤時應採取的措施，建立出錯情況記錄等。

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

　　4．2．2輸入格式

　　說明對初始輸入數據和參量的格式要求，包括語法規則和有關的約定，主要是：

　　(1)長度，如字元數(行)、字元數(項)。

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

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

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

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

　　(6)辭彙表，如給出允許使用的字元組合的列表，禁止使用六的字元組合的列表等。

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

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

　　4．2．3  輸入舉例

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

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

　　(2)主體，輸入數據的主體，包括數據文捲的輸入表述部分。

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

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

　　(5)重覆，指出哪些輸入數據是重覆的。

　　4．3輸出

　　4．3．1輸出數據的現實背景

　　說明輸出數據的現實背景，主要是：

　　(1)使用，這些輸出數據是給誰的，用來乾什麼。

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

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

　　(4)[[質量管理]]，如關於合理性檢驗、出錯糾正的規定。

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

　　4.32 輸出格式

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

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

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

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

　　4.3.3輸出舉例

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

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

　　(2)來源，如從特定的輸入中抽出、從資料庫文捲中取出或從軟體的計算過程中得到的。

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

　　4.4文件查詢

　　文件查詢的編寫針對具有查詢功能的軟體，內容包括：與資料庫查詢有關的初始化、準備、處理所需要的詳細規定。說明查詢的能力、方式，所使用的命令和所要求的控制規定。

　　4.5出錯處理和恢復

　　列出由軟體產生的出錯編碼或條件以及應由用戶承擔的修改和糾正工作，指出為了確保再啟動和恢復的能力，用戶必須遵循的處理過程。

　　4.6終端操作

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