用戶操作手冊(User Guide)
一.引言
1.編寫目的(闡明編寫手冊的目的,指明讀者對象。)
2.項目背景(說明項目的來源、委托單位、開發(fā)單位及主管部門。)
3.定義(列出手冊中用到的專門術(shù)語定義和縮寫詞的原意。)
4.參考資料(列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源,可包括:(1)項目的計劃任務書,合同或批文;(2)項目開發(fā)計劃;(3)需求規(guī)格說明書;(4)概要設計說明書;(5)詳細設計說明書;(6)測試計劃;(7)手冊中引用的其他資料、采用的軟件工程標準或軟件工程規(guī)范。)
二.軟件概述
1.目標
2.功能
3.性能
(1)數(shù)據(jù)精確度(包括輸入、輸出及處理數(shù)據(jù)的精度。)
(2)時間特性(如響應時間、處理時間、數(shù)據(jù)傳輸時間等。)
(3)靈活性(在操作方式、運行環(huán)境需做某些變更時軟件的適應能力。)
三.運行環(huán)境
1.硬件(列出軟件系統(tǒng)運行時所需的硬件最小配置,如:(1)計算機型號、主存容量;(2)外存儲器、媒體、記錄格式、設備型號及數(shù)量;(3)輸入、輸出設備;(4)數(shù)據(jù)傳輸設備及數(shù)據(jù)轉(zhuǎn)換設備的型號及數(shù)量。)
2.支持軟件(如:(1)操作系統(tǒng)名稱及版本號;(2)語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號;(3)數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號;(4)其他必要的支持軟件。)
四.使用說明
1.安裝和初始化(給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成的測試實例以及安裝所需的軟件工具等。)
2.輸入(給出輸入數(shù)據(jù)或參數(shù)的要求。)
(1)數(shù)據(jù)背景(說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。)
(2)數(shù)據(jù)格式(如:(1)長度(2)格式基準(3)標號(4)順序(5)分隔符(6)詞匯表(7)省略和重復(8)控制。)
(3)輸入舉例
3.輸出(給出每項輸出數(shù)據(jù)的說明。)
(1)數(shù)據(jù)背景(說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。)
(2)數(shù)據(jù)格式(詳細闡明每一輸出數(shù)據(jù)的格式,如:首部 主體和尾部的具體形式。)
(3)舉例
3.出錯和恢復(給出:(1)出錯信息及其含義(2)用戶應采取的措施,如修改、恢復、再啟動。)
4.求助查詢(說明如何操作。)
五.運行說明
1. 運行表 [列出每種可能的運行情況,說明其運行目的.]
2. 運行步驟 [按順序說明每種運行的步驟,應包括:]
(1) 運行控制
(2) 操作信息((1)運行目的(2)操作要求(3)啟動方法(4)預計運行時間(5)操作命令格式及說明(6)其他事項。)
(3) 輸入/輸出文件(給出建立和更新文件的有關信息,如:(1)文件的名稱及編號(2)記錄媒體(3)存留的目錄(4)文件的支配[說明確定保留文件或廢棄文件的準則,分發(fā)文件的對象,占用硬件的優(yōu)先級及保密控制等。)
(4) 啟動或恢復過程
六.非常規(guī)過程(提供應急或非常規(guī)操作的必要信息及操作步驟,如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項。)
七.操作命令一覽表
(按字母順序逐個列出全部操作命令的格式 功能及參數(shù)說明。)
八.程序文件(或命令文件)和數(shù)據(jù)文件一覽表(按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。)
九.用戶操作舉例