1 引言

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

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

1.3 定義：列出手冊中使用的專門術語的定義和縮寫詞的愿意。

1.4 參考資料：1.列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源2.項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；測試計劃3.文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規范。

2 軟件概述

2.1 目標2.2 功能2.3 性能2.4 數據精確度2.5 時間特性：如響應時間、處理時間、數據傳輸時間等。2.6 靈活性在操作方式、運行環境需做某些變更時軟件的適應能力。

3 運行環境

3.1 硬件1.列出軟件系統運行時所需的硬件最小配置，如計算機型號、主存容量2.外存儲器、媒體、記錄格式、設備型號及數量3. 輸入、輸出設備4.數據傳輸設備及數據轉換設備的型號及數量。

3.2 支持軟件，1.操作系統名稱及版本號；2.語言編譯系統或匯編系統的名稱及版本號；3.數據庫管理系統的名稱及版本號；4.其他必要的支持軟件

4 使用說明

4.1 安裝和初始化：給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。4.2 輸入：給出輸入數據或參數的要求。3.數據背景：說明數據來源、存儲媒體、出現頻度、限制和質量管理等。2.數據格式:如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。3.輸入舉例。4.3 輸出：給出每項輸出數據的說明。1.數據背景：說明輸出數據的去向、使用頻度、存放媒體及質量管理等。2.數據格式：詳細闡明每一輸出數據的格式，如首部、主體和尾部的具體形式。3. 舉例4.4 出錯和恢復：給出出錯信息及其含意；用戶應采取的措施，如修改、恢復、再啟動。4.5 求助查詢：說明如何操作。

5 運行說明

5.1 運行表：列出每種可能的運行情況，說明其運行目的。5.2 運行步驟：按順序說明每和運行的步驟，應包括：5.3 運行控制5.4 操作信息：運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項；5.5輸入/輸出文件：給出建立或更新文件的有關信息，如：文件的名稱及編號；記錄媒體；存留的目錄；文件的支配：說明確定保留文件或廢棄文件的準則，分發文件的對象，戰勝硬件的優先級及保密控制等。

5.6 啟動或恢復過程

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

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

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

9 用戶操作舉例