軟件使用手冊模板

部門：項目：密級：日期：項目名稱顧客操作手冊編寫闡明類別：項目文檔密級：撰稿人：修改人：寄存位置：編輯軟件：版本信息：版本修改點闡明

目錄TOC\o"1-3"\h\z\t"部分標題,1"1 引言 1-11.1 編寫目的 1-11.2 項目背景 1-11.3 術語定義 1-11.4 參照資料 1-12 軟件概述 2-32.1 目的 2-32.2 功能 2-32.3 性能 2-33 運行環(huán)境 3-43.1 硬件 3-43.2 支持軟件 3-44 使用闡明 4-54.1 安裝和初始化 4-54.2 輸入 4-54.2.1 數(shù)據(jù)背景 4-54.2.2 數(shù)據(jù)格式 4-54.2.3 輸入舉例 4-64.3 輸出 4-64.3.1 數(shù)據(jù)背景 4-64.3.2 數(shù)據(jù)格式 4-64.3.3 舉例 4-64.4 出錯和恢復 4-64.5 求援查詢 4-65 運行闡明 5-75.1 運行表 5-75.2 運行環(huán)節(jié) 5-75.2.1 運行控制 5-75.2.2 操作信息 5-75.2.3 輸入／輸出文獻 5-75.2.4 啟動或恢復過程 5-86 非常規(guī)過程 6-97 操作命令一覽表 6-108 程序文獻(或命令文獻)和數(shù)據(jù)文獻一覽表 6-119 顧客操作舉例 6-12引言編寫目的闡明編寫手冊的目的，指明讀者對象。項目背景闡明項目來源、委托單位、開發(fā)單位及主管部門。術語定義列出手冊中使用的專門術語的定義和縮寫詞的原意。序號縮略語闡明/定義英文全稱中文譯名參照資料列出有關資料的作者、標題、編號、刊登日期、出版單位或資料來源，可包括：項目的計劃任務書、協(xié)議或批文；項目開發(fā)計劃；需求規(guī)格闡明書；概要設計闡明書；詳細設計闡明書；測試計劃；手冊中引用的其他資料、采用的軟件工程原則或軟件工程規(guī)范。文檔編號文檔名稱作者/修訂者版本號備注其他編號文檔名稱作者/修訂者公布日期出版單位備注軟件概述目的功能性能a.數(shù)據(jù)精確度[包括輸入、輸出及處理數(shù)據(jù)的精度]時間特性[如響應時間、處理時間、數(shù)據(jù)傳播時間等]靈活性[在操作方式、運行環(huán)境需做某些變更時軟件的適應能力]運行環(huán)境硬件列出軟件系統(tǒng)運行時所需的硬件最小配置，如計算機型號、主存容量外存儲器、媒體、記錄格式、設備型號及數(shù)量；輸入、輸出設備；數(shù)據(jù)傳播設備及數(shù)據(jù)轉換設備的型號及數(shù)量。支持軟件操作系統(tǒng)名稱及版本號；語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；其他必要的支持軟件；使用闡明安裝和初始化給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完畢的測試實例以及安裝所需的軟件工具等。輸入給出輸入數(shù)據(jù)或參數(shù)的規(guī)定。數(shù)據(jù)背景闡明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質量管理等。數(shù)據(jù)格式如：長度；格式基準；標號；次序；分隔符；詞匯表；省賂和反復；控制輸入舉例輸出給出每項輸出數(shù)據(jù)的闡明數(shù)據(jù)背景闡明輸出數(shù)據(jù)的去向、使用頻度、寄存媒體及質量管理等。數(shù)據(jù)格式詳細闡明每一輸出數(shù)據(jù)的格式，如：首部、主體和尾部的詳細形式。舉例出錯和恢復給出：出錯信息及其含意；顧客應采用的措施，如修改、恢復、再啟動。求援查詢闡明怎樣操作。運行闡明運行表列出每種也許的運行狀況，闡明其運行目的。運行環(huán)節(jié)按次序闡明每種運行的環(huán)節(jié)，應包括如下環(huán)節(jié)：運行控制操作信息運行目的；操作規(guī)定；啟動措施；估計運行時間；操作命令格式及闡明；其他事項。輸入／輸出文獻給出建立或更新文獻的有關信息，如：文獻的名稱及編號；記錄媒體；文獻的保留目錄；文獻的支配 闡明確定保留文獻或廢棄文獻的準則，分發(fā)文獻的對象，占用硬件的優(yōu)先級及保密控制等。啟動或恢復過程非常規(guī)過程提供應急或非常規(guī)操作的必要信息及操作環(huán)節(jié)，如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項。操作命令