軟件系統(tǒng)用戶手冊模板

附錄4-4用戶手冊TOC\o"1-2"\h\z\u1 引言 21.1 編寫目的 21.2 背景 21.3 定義 21.4 參考資料 22 用途 32.1 功能 32.2 性能 32.3 安

全保密 33 運(yùn)行環(huán)境 43.1 硬件設(shè)備 43.2 支持軟件 43.3 數(shù)據(jù)結(jié)構(gòu) 44 使用過程 54.1 安裝與初始化 54.2 輸入 54.3 輸出 74.4 文卷查詢 84.5 出錯處理和恢復(fù) 84.6 終端操作 8

引言

編寫目的

說明編寫這份用戶手冊的目的，指出預(yù)期的讀者。

背景

說明：

1）這份用戶手冊所描述的軟件系統(tǒng)的名稱；

2）該軟件項目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計算中心。

定義

列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。

參考資料

列出有用的參考資料，如：

1）項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文；

2）屬于本項目的其他已發(fā)表文件；

3）本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。

列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件使用過程

在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。

安裝與初始化

一步一步地說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包括程序的存儲形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測試實例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。輸入

規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。

輸入數(shù)據(jù)的現(xiàn)實背景說明輸入數(shù)據(jù)的現(xiàn)實背景，主要是1）情況--例如人員變動、庫存‘缺貨；

2）情況出現(xiàn)的頻度--例如是周期性的、隨機(jī)的、一項操作狀態(tài)的函數(shù)．

3）情況來源-一例如人事部門、倉庫管理部門；4）輸入媒體例如鍵盤、穿孔卡片、磁帶；

5）限制--出于安全、保密考慮而對訪問這些輸入數(shù)據(jù)所加的限制；

6）質(zhì)量管理--例如對輸入數(shù)據(jù)合理性的檢驗以及當(dāng)輸入數(shù)據(jù)有錯誤時應(yīng)采取的措施，如建立出錯情況的記錄等；

7）支配--例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。

輸入格式

說明對初始輸入數(shù)據(jù)和參量的格式要求，包括語法規(guī)則和有關(guān)約定，如：

1）長度-一例如字符數(shù)／行，字符數(shù)／項；2）格式基準(zhǔn)--例如以左面的邊沿為基準(zhǔn)；3）標(biāo)號--例如標(biāo)記或標(biāo)識符；

4）順序--例如各個數(shù)據(jù)項的次序及位置；

5）標(biāo)點--例如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號、字符組等。

6）詞匯表--給出允許使用的字符組合的列表，禁止使用＊的字符組合的列表等；7）省略和重復(fù)--給出用來表示輸人元素可省略或重復(fù)的表示方式；

8）控制--給出用來表示輸入開始或結(jié)束的控制信息。

輸入舉例

為每個完整的輸入形式提供樣本，包括：

1）控制或首部--例如用來表示輸入的種類和類型的信息，標(biāo)識符輸入日期，正文起點和對所用編碼的規(guī)定；

2）主體--輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；3）尾部--用來表示輸入結(jié)束的控制信息，累計字符總數(shù)等；4）省略--指出哪些輸入數(shù)據(jù)是可省略的；5）重復(fù)--指出哪些輸入數(shù)據(jù)是重復(fù)的。輸出

對每項輸出作出說明．

輸出數(shù)據(jù)的現(xiàn)實背景說明輸出數(shù)據(jù)的現(xiàn)實背景，主要是：

1）使用--這些輸出數(shù)據(jù)是給誰的，用來干什么；2）使用頻度--例如每周的、定期的或備查閱的；3）媒體--打印、CRI顯示、磁帶、卡片、磁盤，4）質(zhì)量管理-一例如關(guān)于合理性檢驗、出錯糾正的規(guī)定；

5）支配--例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。

輸出格式給出對每一類輸出信息的解釋，主要是：

1）首部--如輸出數(shù)據(jù)的標(biāo)識符，輸出日期和輸出編號；2）主體--輸出信息的主體，包括分欄標(biāo)題；3）尾部--包括累計總數(shù)，結(jié)束標(biāo)記。

輸出舉例

為每種輸出類型提供例子。對例子中的每一項，說明：1）定義--每項輸出信息的意義和用途；

2）來源--是從特定的輸入中抽出、從數(shù)據(jù)庫文卷中取出、或從軟件的計算過程中得到

3）特性--輸出的值域、計量單位、在什么情況下可缺省等。文卷查詢

這一條的編寫針對具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫查詢有關(guān)的初始化、準(zhǔn)備、及處理所需

要的詳細(xì)規(guī)定，說明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。出錯處理和恢復(fù)

列出由軟件產(chǎn)生