國際軟件設計文檔——操作手冊
1 引言
1.1 編寫目的
說明編寫這份操作手冊的目的,指出預期的讀者。
1.2 前景
說明:
a. 這份操作手冊所描述的軟件系統的名稱;
b. 該軟件項目的任務提出者、開發者、用戶(或首批用戶)及安裝該軟件的計算中心。
1.3 定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
1.4 參考資料
列出有用的參考資料,如:
a. 本項目的經核準的計劃任務書或合同、上級機關的批文;
b. 屬於本項目的其他已發表的文件;
c. 本文件中各處引用的文件、資料,包括所列出的這些文件資料的標題、文件編號、發表日期和出版單位,說明能夠得到這些文件資料的來源。
2 軟件征述
2.1 軟件的結構
結合軟件系統所具有的功能包括輸入、處理和輸出提供該軟件的總體結構圖表。
2.2 程序表
列出本系統內每個程序的標識符、編號和助記名。
2.3 文卷表
列出將由本系統引用、建立或更新的每個永久性文卷,說明它們各自的標識符、編號、助記名、存儲媒體和存儲要求。
3 安裝與初始化
一步一步地說明為使用本軟件而需要進行的安裝與初始化過程,包括程序的存載形式,安裝與初始化過程中的全部操作命令,系統對這些命令的反應與答復,表征安裝工作完成的測試實例等。如果有的話,還應說明安裝過程中所需用到的專用軟件。
4 運行說明
所謂一個運行是指提供一個啟動控制信息後,直到計算機系統等待另一個啟動控制信息時為止的計算機系統執行的全部過程。
4.1 運行表
列出每種可能的運行,摘要說明每個運行的目的,指出每個運行各自所執行的程序。
4.2 運行步驟
說明從一個運行轉向另一個運行以完成整個系統運行的步驟。
4.3 運行1(標識符)說明
把運行1的有關信息,以對操作人員為最方便最有用的形式加以說明。
4.3.1 運行控制
列出為本運行所需要”的運行流向控制的說明。
4.3.2 操作信息
給出為操作中心的操作人員和管理人員所需要的信息,如:
- 運行目的;
- 操作要求;
- 啟動方法 如應請啟動(由所遇到的請求信息啟動)、預定時間啟動、…,··等;
- 預計的運行時間和解題時間;
- 操作命令;
- 與運行有聯系的其他事項。
4.3.3 輸入一輸出文卷
提供被本運行建立、更新或訪問的數據文卷的有關信息,如:
- 文卷的標識符或標號;
- 記錄媒體;
- 存留的目錄表;
- 文卷的支配如確定保留或廢棄的準則、是否要分配給其他接受者、占用硬設備的優先級以及保密控制等有關規定。
4.3.4 輸出文段
提供本軟件輸出的每一一個用於提示、說明、或應答的文段(包括“菜單”)的有關信息,如:
- 文段的標識符;
- 輸出媒體(屏幕顯示、打印、……);
- 文字容量;
- 分發對象;
- 保密要求。
4.3.5 輸出文段的復制
對由計算機產生,而後需用其他方法復制的那些文段提供有關信息,如:
- 文段的標識符;
- 復制的技術手段;
- 紙張或其他媒體的規格;
- 裝訂要求;
- 分發對象;
- 復制份數。
4.3.6 恢復過程
說明本運行故障後的恢復過程。
4.4 運行2(標識符)說明
用與本手冊4.3條相類似的方式介紹另一個運行的有關信息。
5 非常規過程
提供有關應急操作或非常規操作的必要信息,如出錯處理操作、向後備系統的切換操作以及其他必須向程序維護人員交待的事項和步驟。
6 遠程操作
如果本軟件能夠通過遠程終端控制運行,則在本章說明通過遠程終端運行本軟件的操作過程。
國際軟件設計文檔——操作手冊