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

1、案卷號日期V項目名稱操作手冊作 者：完成日期：簽收人：簽收日期：修改情況記錄:版本號修改批準人修改人安裝日期簽收人目錄1引言11.1編寫目的11.2背景11.3定義11.4參考資料12軟件概述12.1軟件的結構12. 2程序農22.3文卷表23安裝與初始化24運行說明24.1運行農24.2運行步驟24.3運行1 （標識符）說明24. 3.1運行控制34. 3.2操作信息34. 3.3輸入一輸出文卷34.3.4輸出文段34.3.5輸出文段的復制44.3.6恢復過程44.4運行2 （標識符）說明45非常規(guī)過程46遠程操作41引言1.1編寫目的說明編寫這份操作手冊的目的，指出預期的讀者范用。1.2背

2、景說明：a這份操作手冊所描述的軟件系統(tǒng)的名稱；b. 列出本項目的任務提岀者、開發(fā)者、用戶（或首批用戶）以及安裝該軟件的單位。1.3定義列岀本文件中用到的專門術語的左義和縮寫詞的原詞組。1. 4參考資料列出要用到的參考資料，如：a本項目的經(jīng)核準的計劃任務書或合同、上級機關的批文；b. 屬于本項目的其他已發(fā)表的文件；c. 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。列岀這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的 來源。2軟件概述2. 1軟件的結構結合軟件系統(tǒng)所具有的功能包括輸入.處理和輸岀提供該軟件的總體結構圖表。2. 2程序表列出本系統(tǒng)內每個程序的標識

3、符、編號和助記冬。2. 3文卷表列岀將由本系統(tǒng)引用、建立或更新的每個永久性文卷，說明它們各自的標識符、編號、 助記名、存儲媒體和存儲要求。3安裝與初始化一步一步地說明為使用本軟件而需要進行的安裝與初始化過程，包括程序的存在形式, 安裝與初始化過程中的全部操作命令，系統(tǒng)對這些命令的反應與答復，表征安裝工作完成的 測試實例等。如果有的話，還應說明安裝過程中所需用到的專用軟件。4運行說明所謂一個運行是指提供一個啟動控制信息后，直到計算機系統(tǒng)等待另一個啟動控制信息 時為止的計算機系統(tǒng)執(zhí)行的全部過程。4. 1運行表列出每種可能的運行，摘要說明每個運行的目的，指出每個運行各自所執(zhí)行的程序。4. 2運行步驟

4、說明從一個運行轉向另一個運行以完成整個系統(tǒng)運行的步驟。4. 3運行1 （標識符）說明把運行1的有關信息，以對操作人員為最方便最有用的形式加以說明。4. 3.1運行控制列岀為本運行所需要的運行流向控制的說明。4. 3. 2操作信息給岀為操作中心的操作人員和管理所需要的信息，如：a. 運行目的：b. 操作要求：c. 啟動方法：如應請啟動（由所遇到的請示信息啟動）、預定時間啟動 等；d. 預計的運行時間和解題時間：e. 操作命令：f. 與運行有聯(lián)系的其他事項。4. 3. 3輸入一輸出文卷提供被本運行建立、更新或訪問的數(shù)據(jù)文卷的有關信息，如：a. 文卷的標識符或標號：b. 記錄媒體；c. 存留的目錄表

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