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

1、案卷號日期項目名稱操 作 手 冊 作 者： 完成日期： 簽 收 人： 簽收日期： 修改情況記錄：版本號修改批準(zhǔn)人修改人安裝日期簽收人 目錄 1 引言11.1 編寫目的11.2 背景11.3 定義11.4 參考資料12 軟件概述12.1 軟件的結(jié)構(gòu)12.2 程序表22.3 文卷表23 安裝與初始化24 運(yùn)行說明24.1 運(yùn)行表24.2 運(yùn)行步驟24.3 運(yùn)行1（標(biāo)識符）說明24.3.1 運(yùn)行控制34.3.2 操作信息34.3.3 輸入輸出文卷34.3.4 輸出文段34.3.5 輸出文段的復(fù)制44.3.6 恢復(fù)過程44.4 運(yùn)行2（標(biāo)識符）說明45 非常規(guī)過程46 遠(yuǎn)程操作45 / 7文檔可自由編

2、輯打印1 引言1.1 編寫目的 說明編寫這份操作手冊的目的，指出預(yù)期的讀者范圍。1.2 背景說明：a 這份操作手冊所描述的軟件系統(tǒng)的名稱；b 列出本項目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）以及安裝該軟件的單位。1.3 定義 列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組。1.4 參考資料列出要用到的參考資料，如：a 本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b 屬于本項目的其他已發(fā)表的文件；c 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2 軟件概述2.1 軟件的結(jié)構(gòu)結(jié)合軟件系統(tǒng)所具有

3、的功能包括輸入、處理和輸出提供該軟件的總體結(jié)構(gòu)圖表。2.2 程序表列出本系統(tǒng)內(nèi)每個程序的標(biāo)識符、編號和助記名。2.3 文卷表列出將由本系統(tǒng)引用、建立或更新的每個永久性文卷，說明它們各自的標(biāo)識符、編號、助記名、存儲媒體和存儲要求。3 安裝與初始化一步一步地說明為使用本軟件而需要進(jìn)行的安裝與初始化過程，包括程序的存在形式，安裝與初始化過程中的全部操作命令，系統(tǒng)對這些命令的反應(yīng)與答復(fù)，表征安裝工作完成的測試實(shí)例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。4 運(yùn)行說明所謂一個運(yùn)行是指提供一個啟動控制信息后，直到計算機(jī)系統(tǒng)等待另一個啟動控制信息時為止的計算機(jī)系統(tǒng)執(zhí)行的全部過程。4.1 運(yùn)行表列

4、出每種可能的運(yùn)行，摘要說明每個運(yùn)行的目的，指出每個運(yùn)行各自所執(zhí)行的程序。4.2 運(yùn)行步驟說明從一個運(yùn)行轉(zhuǎn)向另一個運(yùn)行以完成整個系統(tǒng)運(yùn)行的步驟。4.3 運(yùn)行1（標(biāo)識符）說明把運(yùn)行1的有關(guān)信息，以對操作人員為最方便最有用的形式加以說明。4.3.1 運(yùn)行控制列出為本運(yùn)行所需要的運(yùn)行流向控制的說明。4.3.2 操作信息給出為操作中心的操作人員和管理所需要的信息，如：a 運(yùn)行目的；b 操作要求；c 啟動方法：如應(yīng)請啟動（由所遇到的請示信息啟動）、預(yù)定時間啟動、等；d 預(yù)計的運(yùn)行時間和解題時間；e 操作命令；f 與運(yùn)行有聯(lián)系的其他事項。4.3.3 輸入輸出文卷提供被本運(yùn)行建立、更新或訪問的數(shù)據(jù)文卷的有關(guān)信

5、息，如：a 文卷的標(biāo)識符或標(biāo)號；b 記錄媒體；c 存留的目錄表；d 文卷的支配：如確定保留或廢棄的準(zhǔn)則、是否要分配給其他接受者、占用硬設(shè)備的優(yōu)先級以及保密控制等有關(guān)規(guī)定。4.3.4 輸出文段提供本軟件輸出的每一個用于提示、說明、或應(yīng)答的文段（包括“菜單”）的有關(guān)信息，如：a 文段的標(biāo)識符；b 輸出媒體（屏幕顯示、打印、）；c 文字容量；d 分發(fā)對象；e 保密要求。4.3.5 輸出文段的復(fù)制對由計算機(jī)產(chǎn)生，而后需用其他方法復(fù)制的那些文段提供有關(guān)信息，如：a 文段的標(biāo)識符；b 復(fù)制的技術(shù)手段；c 紙張或其他媒體的規(guī)格；d 裝訂要求；e 分發(fā)對象；f 復(fù)制份數(shù)。4.3.6 恢復(fù)過程說明本運(yùn)行故障后的恢復(fù)過程。4.4 運(yùn)行2（標(biāo)識符）說明用與手冊4.3條相類的方式介紹另一個運(yùn)行的有關(guān)信息。5 非常規(guī)過程提供有關(guān)應(yīng)急操作或非常規(guī)操作必要信息，如出錯處理