用戶操作手冊編寫規(guī)范

XXXXXXXX公司#用戶操作手冊XXXX有限公司文件編號當(dāng)前版本V2.0機密等級內(nèi)部公開編制者審核者批準(zhǔn)者批準(zhǔn)日期XXXX有限公司對本文件資料享受著作權(quán)及其它專屬權(quán)利，未經(jīng)書面許可，不得將該等文件資料

（其全部或任何部分）披露予任何第三方，或進行修改后使用。

文檔修改記錄：六、用戶操作手冊TOC\o"1-5"\h\z1．引言3編寫目的3項目背景4定義4參考資料42．軟件概述4目標(biāo)4功能4性能43．運行環(huán)境4硬件4支持軟件54.使用說明54.1安裝和初始化5輸入5輸出6出錯和恢復(fù)6求助查詢65.運行說明65.1運行表6運行步驟66.非常規(guī)過程77.操作命令一覽表78.程序文件（或命令文件）和數(shù)據(jù)文件一覽表79.用戶操作舉例81．引言編寫目的【闡明編寫手冊的目的，指明讀者對象。】項目背景【應(yīng)包括項目的來源、委托單位、開發(fā)單位和主管部門?！慷x【列出手冊中所用到的專門術(shù)語的定義和縮寫詞的原文?！繀⒖假Y料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括項目的計劃任務(wù)書、合同或批文；項目開發(fā)計劃；需求規(guī)格說明書；概要設(shè)計說明書；詳細設(shè)計說明書；測試計劃；手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范?！磕繕?biāo)功能性能數(shù)據(jù)精確度【包括輸入、輸出及處理數(shù)據(jù)的精度?！繒r間特性【如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等?！快`活性【在操作方式、運行環(huán)境需做某些變更時軟件的適應(yīng)能力。】3．運行環(huán)境硬件列出軟件系統(tǒng)運行時所需的硬件最小配置，如計算機型號、主存容量；外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量輸入、輸出設(shè)備；數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。】支持軟件【如：操作系統(tǒng)名稱及版本號；語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；其他必要的支持軟件?！渴褂谜f明4.1安裝和初始化【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實例以及安裝所需的軟件工具等?！枯斎虢o出輸入數(shù)據(jù)或參數(shù)的要求?！繑?shù)據(jù)背景【說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。】數(shù)據(jù)格式如：長度；格式基準(zhǔn)；標(biāo)號；順序；分隔符；詞匯表；省略和重復(fù)控制?！枯斎肱e例輸出【給出每項輸出數(shù)據(jù)的說明。】4.3.1數(shù)據(jù)背景【說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等?！?.3.2數(shù)據(jù)格式【詳細闡明每一輸出數(shù)據(jù)的格式，如：首部、主體和尾部的具體形式。】舉例出錯和恢復(fù)【給出：出錯信息及其含意；用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動?！壳笾樵儭菊f明如何操作?！窟\行說明5.1運行表【列出每種可能的運行情況，說明其運行目的?！窟\行步驟【按順序說明每種運行的步驟，應(yīng)包括：】5.2.1運行控制5.2.2操作信息運行目的；操作要求；啟動方法；預(yù)計運行時間；操作命令格式及說明；其他事項。輸入/輸出文件【給出建立或更新文件的有關(guān)信息，如：】a.文件的名稱及編號；b.記錄媒體；存留的目錄；文件的支配【說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對象，占用硬件的優(yōu)先級及保密控制等?！繂踊蚧謴?fù)過程非常規(guī)過程【提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項?！坎僮髅钜挥[表按字母順序逐個列出全部操作命令