用戶操做手冊

1．引言

1.1編寫目的

【闡明編寫手冊的目的，指明讀者對象。】

 

1.2項目背景

【應包括項目的來源、委託單位、開發單位和主管部門。】

1.3定義

【列出手冊中所用到的專門術語的定義和縮寫詞的原文。】

1.4參考資料

【列出有關資料的做者、標題、編號、發表日期、出版單位或資料來源，可包括：

a.  項目的計劃任務書、合同或批文；

b.  項目開發計劃；

c.  需求規格說明書；

d.  概要設計說明書；

e.  詳細設計說明書；

f.  測試計劃；

g.  手冊中引用的其餘資料、採用的軟件工程標準或軟件工程規範。】

2．軟件概述

2.1目標

2.2功能

2.3性能

a.  數據精確度【包括輸入、輸出及處理數據的精度。】

b.  時間特性【如響應時間、處理時間、數據傳輸時間等。】

c.  靈活性【在操做方式、運行環境需作某些變動時軟件的適應能力。】

3．運行環境

3.1硬件

【列出軟件系統運行時所需的硬件最小配置，如

a.  計算機型號、主存容量；

b.  外存儲器、媒體、記錄格式、設備型號及數量；

c.  輸入、輸出設備；

d.  數據傳輸設備及數據轉換設備的型號及數量。】

3.2支持軟件

【如：

a.  操做系統名稱及版本號；

b.  語言編譯系統或彙編系統的名稱及版本號；

c.  數據庫管理系統的名稱及版本號；

d.  其餘必要的支持軟件。】

4.使用說明

4.1安裝和初始化

【給出程序的存儲形式、操做命令、反饋信息及其含意、代表安裝完成的測試實例以及安裝所需的軟件工具等。】

4.2輸入

【給出輸入數據或參數的要求。】

4.2.1數據背景

【說明數據來源、存儲媒體、出現頻度、限制和質量管理等。】

4.2.2數據格式

【如：

a.  長度；

b.  格式基準；

c.  標號；

d.  順序；

e.  分隔符；

f.  詞彙表；

g.  省略和重複；

h.  控制。】

4.2.3輸入舉例

4.3輸出

【給出每項輸出數據的說明。】

4.3.1數據背景

【說明輸出數據的去向、使用頻度、存放媒體及質量管理等。】

4.3.2數據格式

【詳細闡明每一輸出數據的格式，如：首部、主體和尾部的具體形式。】

4.3.3舉例

4.4出錯和恢復

【給出：

a.  出錯信息及其含意；

b.  用戶應採起的措施，如修改、恢復、再啓動。】

4.5求助查詢

【說明如何操做。】

5.運行說明

5.1運行表

【列出每種可能的運行狀況，說明其運行目的。】

5.2運行步驟

【按順序說明每種運行的步驟，應包括：】

5.2.1運行控制

5.2.2操做信息

a.  運行目的；

b.  操做要求；

c.  啓動方法；

d.  預計運行時間；

e.  操做命令格式及說明；

f.  其餘事項。

5.2.3輸入/輸出文件

【給出創建或更新文件的有關信息，如：】

a.  文件的名稱及編號；

b.  記錄媒體；

c.  存留的目錄；

d.  文件的支配【說明肯定保留文件或廢棄文件的準則，分發文件的對象，佔用硬件的優先級及保密控制等。】

5.2.4啓動或恢復過程

6.很是規過程

【提供應急或很是規操做的必要信息及操做步驟，如出錯處理操做、向後備系統切換操做以及維護人員須知的操做和注意事項。】

7.操做命令一覽表

【按字母順序逐個列出所有操做命令的格式、功能及參數說明。】

8.程序文件（或命令文件）和數據文件一覽表

【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。】

9.用戶操做舉例