GB8567-88 軟件設(shè)計(jì)文檔國家標(biāo)準(zhǔn)-操作手冊
1引言
1.1編寫目的
說明編寫這份操作手冊的目的,指出預(yù)期的讀者。
1.2前景
說明:
a.這份操作手冊所描述的軟件系統(tǒng)的名稱;
b.該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶(或首批用戶)及安裝該軟件的計(jì)算中心。
1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有用的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用的文件、資料,包括所列出的這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
2軟件征述
2.1軟件的結(jié)構(gòu)
結(jié)合軟件系統(tǒng)所具有的功能包括輸入、處理和輸出提供該軟件的總體結(jié)構(gòu)圖表。
2.2程序表
列出本系統(tǒng)內(nèi)每個(gè)程序的標(biāo)識符、編號和助記名。
2.3文卷表
列出將由本系統(tǒng)引用、建立或更新的每個(gè)永久性文卷,說明它們各自的標(biāo)識符、編號、助記名、存儲媒體和存儲要求。
3安裝與初始化
一步一步地說明為使用本軟件而需要進(jìn)行的安裝與初始化過程,包括程序的存載形式,安裝與初始化過程中的全部操作命令,系統(tǒng)對這些命令的反應(yīng)與答復(fù),表征安裝工作完成的測試實(shí)例等。如果有的話,還應(yīng)說明安裝過程中所需用到的專用軟件。
4運(yùn)行說明
所謂一個(gè)運(yùn)行是指提供一個(gè)啟動控制信息后,直到計(jì)算機(jī)系統(tǒng)等待另一個(gè)啟動控制信息時(shí)為止的計(jì)算機(jī)系統(tǒng)執(zhí)行的全部過程。
4.1運(yùn)行表
列出每種可能的運(yùn)行,摘要說明每個(gè)運(yùn)行的目的,指出每個(gè)運(yùn)行各自所執(zhí)行的程序。
4.2運(yùn)行步驟
說明從一個(gè)運(yùn)行轉(zhuǎn)向另一個(gè)運(yùn)行以完成整個(gè)系統(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ù)定時(shí)間啟動、…,··等;
d. 預(yù)計(jì)的運(yùn)行時(shí)間和解題時(shí)間;
e. 操作命令;
f.與運(yùn)行有聯(lián)系的其他事項(xiàng)。
4.3.3輸入一輸出文卷
提供被本運(yùn)行建立、更新或訪問的數(shù)據(jù)文卷的有關(guān)信息,如:
a. 文卷的標(biāo)識符或標(biāo)號;
b. 記錄媒體;
c. 存留的目錄表;
d. 文卷的支配如確定保留或廢棄的準(zhǔn)則、是否要分配給其他接受者、占用硬設(shè)備的優(yōu)先級以及保密控制等有關(guān)規(guī)定。
4.3.4輸出文段
提供本軟件輸出的每一一個(gè)用于提示、說明、或應(yīng)答的文段(包括“菜單”)的有關(guān)信息,如:
a. 文段的標(biāo)識符;
b. 輸出媒體(屏幕顯示、打印、……);
c. 文字容量;
d. 分發(fā)對象;
e. 保密要求。
4.3.5輸出文段的復(fù)制
對由計(jì)算機(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條相類似的方式介紹另一個(gè)運(yùn)行的有關(guān)信息。
5非常規(guī)過程
提供有關(guān)應(yīng)急操作或非常規(guī)操作的必要信息,如出錯處理操作、向后備系統(tǒng)的切換操作以及其他必須向程序維護(hù)人員交待的事項(xiàng)和步驟。
6遠(yuǎn)程操作
如果本軟件能夠通過遠(yuǎn)程終端控制運(yùn)行,則在本章說明通過遠(yuǎn)程終端運(yùn)行本軟件的操作過程。








