1 引言
1.1編寫目的
說明編寫這份用戶手冊的目的,指出預期的讀者。
1.2背景
說明:
a.這份用戶手冊所描述的軟件系統(tǒng)的名稱;
b.該軟件項目的任務提出者、開發(fā)者、用戶(或首批用戶)及安裝此軟件的計算中心。
1.3定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有用的參考資料,如:
a.項目的經核準的計劃任務書或合同、上級機關的批文;
b.屬于本項目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標準。列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠取得這些文件資料的來源。
2 用途
2.1功能
結合本軟件的開發(fā)目的逐項地說明本軟件所具有各項功能以及它們的極限范圍。
2.2性能
2.2.1精度
逐項說明對各項輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達到的精度,包括傳輸中的精度要求。
2.2.2時間特性
定量地說明本軟件的時間特性,如響應時間,更新處理時間,數(shù)據(jù)傳輸、轉換時間,計算時間等。
2.2.3靈活性
說明本軟件所具有的靈活性,即當用戶需求(如對操作方式、運行環(huán)境、結果精度、時間特性等的要求)有某些變化時,本軟件的適應能力。
2. 3 安全保密
說明本軟件在安全、保密方面的設計考慮和實際達到的能力。
3 運行環(huán)境
3.1 硬設備
列出為運行本軟件所要求的硬設備的最小配置,如:
a.處理機的型號、內存容量;
b.所要求的外存儲器、媒體、記錄格式、設備的型號和臺數(shù)、聯(lián)機/脫機;
c. I/O設備(聯(lián)機/脫機?);
d.數(shù)據(jù)傳輸設備和轉換設備的型號、臺數(shù)。
3.2支持軟件
說明為運行本軟件所需要的支持軟件,如:
a.操作系統(tǒng)的名稱、版本號;
b.程序語言的編譯/匯編系統(tǒng)的名稱和版本號;
c.數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號;
d.其他支持軟件。
3.3數(shù)據(jù)結構
列出為支持本軟件的運行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。
4 使用過程
在本章,首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機構、輸出接收機構之間的關系。
4. 1安裝與初始化
一步一步地說明為使用本軟件而需進行的安裝與初始化過程,包括程序的存儲形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對這些命令的反應與答復。表征安裝工作完成的測試實例等。如果有的話,還應說明安裝過程中所需用到的專用軟件。
4.2輸入
規(guī)定輸入數(shù)據(jù)和參量的準備要求。
4.2.1輸入數(shù)據(jù)的現(xiàn)實背景
說明輸入數(shù)據(jù)的現(xiàn)實背景,主要是
a.情況--例如人員變動、庫存'缺貨;
b.情況出現(xiàn)的頻度--例如是周期性的、隨機的、一項操作狀態(tài)的函數(shù).
c.情況來源-一例如人事部門、倉庫管理部門;
d.輸入媒體---例如鍵盤、穿孔卡片、磁帶;
e.限制--出于安全、保密考慮而對訪問這些輸入數(shù)據(jù)所加的限制;
f.質量管理--例如對輸入數(shù)據(jù)合理性的檢驗以及當輸入數(shù)據(jù)有錯誤時應采取的措施,如建立出錯情況的記錄等;
g.支配--例如如何確定輸入數(shù)據(jù)是保留還是廢棄,是否要分配給其他的接受者等。
4.2.2輸入格式
說明對初始輸入數(shù)據(jù)和參量的格式要求,包括語法規(guī)則和有關約定,如:
a.長度-一例如字符數(shù)/行,字符數(shù)/項;
b.格式基準--例如以左面的邊沿為基準;
c.標號--例如標記或標識符;
d.順序--例如各個數(shù)據(jù)項的次序及位置;
e.標點--例如用來表示行、數(shù)據(jù)組等的開始或結束而使用的空格、斜線、星號、字符組等。
f.詞匯表--給出允許使用的字符組合的列表,禁止使用*的字符組合的列表等;
g.省略和重復--給出用來表示輸人元素可省略或重復的表示方式;
h.控制--給出用來表示輸入開始或結束的控制信息。
H.4.2.3輸入舉例
為每個完整的輸入形式提供樣本,包括:
a.控制或首部--例如用來表示輸入的種類和類型的信息,標識符輸入日期,正文起點和對所用編碼的規(guī)定;
b.主體--輸入數(shù)據(jù)的主體,包括數(shù)據(jù)文卷的輸入表述部分;
c.尾部--用來表示輸入結束的控制信息,累計字符總數(shù)等;
d.省略--指出哪些輸入數(shù)據(jù)是可省略的;
e.重復--指出哪些輸入數(shù)據(jù)是重復的。
4.3輸出對每項輸出作出說明.
4.3.1輸出數(shù)據(jù)的現(xiàn)實背景,
說明輸出數(shù)據(jù)的現(xiàn)實背景,主要是:
a.使用--這些輸出數(shù)據(jù)是給誰的,用來干什么;
b.使用頻度--例如每周的、定期的或備查閱的;
c.媒體--打印、CRI顯示、磁帶、卡片、磁盤,
d.質量管理-一例如關于合理性檢驗、出錯糾正的規(guī)定;
e.支配--例如如何確定輸出數(shù)據(jù)是保留還是廢棄,是否要分配給其他接受者等。
4.3.2輸出格式
給出對每一類輸出信息的解釋,主要是:
a.首部--如輸出數(shù)據(jù)的標識符,輸出日期和輸出編號;
b.主體--輸出信息的主體,包括分欄標題;
c.尾部--包括累計總數(shù),結束標記。
4.3.3輸出舉例
為每種輸出類型提供例子。對例子中的每一項,說明:
a.定義--每項輸出信息的意義和用途;
b.來源--是從特定的輸入中抽出、從數(shù)據(jù)庫文卷中取出、或從軟件的計算過程中得到;
c.特性--輸出的值域、計量單位、在什么情況下可缺省等。
4.4文卷查詢
這一條的編寫針對具有查詢能力的軟件,內容包括:同數(shù)據(jù)庫查詢有關的初始化、準備、及處理所需要的詳細規(guī)定,說明查詢的能力、方式,所使用的命令和所要求的控制規(guī)定。
4.5出錯處理和恢復
列出由軟件產生的出錯編碼或條件以及應由用戶承擔的修改糾正工作。指出為了確保再啟動和恢復的能力,用戶必須遵循的處理過程。
4.6終端操作
當軟件是在多終端系統(tǒng)上工作時,應編寫本條,以說明終端的配置安排、連接步釋、數(shù)據(jù)和參數(shù)輸入步驟以及控制規(guī)定.說明通過終端操作進行查詢、檢索、修改數(shù)據(jù)文卷的能力、語言、過程以及輔助性程序等。
1 引言
1.1 編寫目的
說明編寫這份操作手冊的目的,指出預期的讀者。
1.2 前景
說明:
a.這份操作手冊所描述的軟件系統(tǒng)的名稱;
b.該軟件項目的任務提出者、開發(fā)者、用戶(或首批用戶)及安裝該軟件的計算中心。
1.3定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有用的參考資料,如:
a.本項目的經核準的計劃任務書或合同、上級機關的批文;
b.屬于本項目的其他已發(fā)表的文件;
c.本文件中各處引用的文件、資料,包括所列出的這些文件資料的標題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
2 軟件征述
2.1軟件的結構
結合軟件系統(tǒng)所具有的功能包括輸入、處理和輸出提供該軟件的總體結構圖表。
2.2程序表
列出本系統(tǒng)內每個程序的標識符、編號和助記名。
2.3文卷表
列出將由本系統(tǒng)引用、建立或更新的每個永久性文卷,說明它們各自的標識符、編號、助記名、存儲媒體和存儲要求。
3 安裝與初始化
一步一步地說明為使用本軟件而需要進行的安裝與初始化過程,包括程序的存載形式,安裝與初始化過程中的全部操作命令,系統(tǒng)對這些命令的反應與答復,表征安裝工作完成的測試實例等。如果有的話,還應說明安裝過程中所需用到的專用軟件。
4 運行說明
所謂一個運行是指提供一個啟動控制信息后,直到計算機系統(tǒng)等待另一個啟動控制信息時為止的計算機系統(tǒng)執(zhí)行的全部過程。
4.1運行表
列出每種可能的運行,摘要說明每個運行的目的,指出每個運行各自所執(zhí)行的程序。
4.2運行步驟
說明從一個運行轉向另一個運行以完成整個系統(tǒng)運行的步驟。
4. 3運行1(標識符)說明
把運行1的有關信息,以對操作人員為最方便最有用的形式加以說明。
4.3.1運行控制
列出為本運行所需要"的運行流向控制的說明。
4.3.2操作信息
給出為操作中心的操作人員和管理人員所需要的信息,如:
a.運行目的;
b.操作要求;
c.啟動方法如應請啟動(由所遇到的請求信息啟動)、預定時間啟動、…,..等;
d.預計的運行時間和解題時間;操作命令;
f.與運行有聯(lián)系的其他事項。
4.3.3輸入一輸出文卷
提供被本運行建立、更新或訪問的數(shù)據(jù)文卷的有關信息,如:
a.文卷的標識符或標號;
b.記錄媒體;
c.存留的目錄表;
d.文卷的支配如確定保留或廢棄的準則、是否要分配給其他接受者、占用硬設備的優(yōu)先級以及保密控制等有關規(guī)定。
4.3.4輸出文段
提供本軟件輸出的每一一個用于提示、說明、或應答的文段(包括"菜單")的有關信息,如:
a.文段的標識符;
b.輸出媒體(屏幕顯示、打印、……);
c.文字容量;
d.分發(fā)對象;
e.保密要求。
4.3.5輸出文段的復制
對由計算機產生,而后需用其他方法復制的那些文段提供有關信息,如:
a.文段的標識符;
b.復制的技術手段;
c.紙張或其他媒體的規(guī)格;
d.裝訂要求;
e.分發(fā)對象;
f.復制份數(shù)。
4.3.6恢復過程
說明本運行故障后的恢復過程。
4.4運行2(標識符)說明
用與本手冊1.4.3條相類似的方式介紹另一個運行的有關信息。
5 非常規(guī)過程
提供有關應急操作或非常規(guī)操作的必要信息,如出錯處理操作、向后備系統(tǒng)的切換操作以及其他必須向程序維護人員交待的事項和步驟。
6 遠程操作
如果本軟件能夠通過遠程終端控制運行,則在本章說明通過遠程終端運行本軟件的操作過程。