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

1、附錄4-4用戶手冊(cè)1引言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 出錯(cuò)處理和恢復(fù)84.6 終端操作81引言1.1 編寫目的說明編寫這份用戶手冊(cè)的目的，指出預(yù)期的讀者。1.2 背景說明：1）這份用戶手冊(cè)所描述的軟件系統(tǒng)的名稱；2）該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計(jì)算中心。1.3 定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞

2、的原詞組。1.4 參考資料列出有用的參考資料，如：1）項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；2）屬于本項(xiàng)目的其他已發(fā)表文件；3）本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說明能夠取得這些文件資料的來源2用途2.1 功能結(jié)合本軟件的開發(fā)目的逐項(xiàng)地說明本軟件所具有各項(xiàng)功能以及它們的極限范圍。2.2 性能2.2.1 精度逐項(xiàng)說明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。2.2.2 時(shí)間特性定量地說明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)間等。2.2.3 靈活

3、性說明本軟件所具有的靈活性，即當(dāng)用戶需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求）有某些變化時(shí)，本軟件的適應(yīng)能力。2.3 安全保密說明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力3運(yùn)行環(huán)境3運(yùn)行環(huán)境3.1硬件設(shè)備列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如：1）處理機(jī)的型號(hào)、內(nèi)存容量；2）所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)/脫機(jī);3）I/O設(shè)備（聯(lián)機(jī)/脫機(jī)？）；4）數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3.2 支持軟件說明為運(yùn)行本軟件所需要的支持軟件，如：1）操作系統(tǒng)的名稱、版本號(hào)；2）程序語言的編譯/匯編系統(tǒng)的名稱和版本號(hào)；3）數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號(hào)

4、；4）其他支持軟件。3.3 數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。4使用過程在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。4.1 安裝與初始彳匕一步一步地說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包括程序的存儲(chǔ)形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。4.2 輸入規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4.2.1 輸入數(shù)據(jù)的現(xiàn)實(shí)背景說明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是1）情況-例如人員變動(dòng)、庫存缺貨；2）情況出現(xiàn)的頻度-例如是周期性的、隨機(jī)的、一項(xiàng)操

5、作狀態(tài)的函數(shù)-3）情況來源-一例如人事部門、倉庫管理部門；4）輸入媒體一例如鍵盤、穿孔卡片、磁帶；5）限制一出于安全、保密考慮而對(duì)訪問這些輸入數(shù)據(jù)所加的限制；6）質(zhì)量管理-例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等；7）支配一例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接as72-z.Afr支省寺°4.2.2 輸入格式說明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語法規(guī)則和有關(guān)約定，如：1）長(zhǎng)度一例如字符數(shù)/行，字符數(shù)/項(xiàng)；2）格式基準(zhǔn)-例如以左面的邊沿為基準(zhǔn)；3）標(biāo)號(hào)-例如標(biāo)記或標(biāo)識(shí)符；4）順序-例如各個(gè)數(shù)據(jù)項(xiàng)的次序及位置；5）標(biāo)點(diǎn)一例

6、如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號(hào)、字符組等。6）詞匯表一給出允許使用的字符組合的列表，禁止使用*的字符組合的列表等；7）省略和重復(fù)-給出用來表示輸人元素可省略或重復(fù)的表示方式；控制一給出用來表示輸入開始或結(jié)束的控制信息。4.2.3 輸入舉例為每個(gè)完整的輸入形式提供樣本，包括：1）控制或首部一例如用來表示輸入的種類和類型的信息，標(biāo)識(shí)符輸入日期，正文起點(diǎn)和對(duì)所用編碼的規(guī)定；2）主體一輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；3）尾部一用來表示輸入結(jié)束的控制信息，累計(jì)字符總數(shù)等；4）省略一指出哪些輸入數(shù)據(jù)是可省略的；5）重復(fù)一指出哪些輸入數(shù)據(jù)是重復(fù)的。4.3 輸出對(duì)每項(xiàng)輸

7、出作出說明-4.3.1 輸出數(shù)據(jù)的現(xiàn)實(shí)背景說明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：1）使用這些輸出數(shù)據(jù)是給誰的，用來干什么；2）使用頻度-例如每周的、定期的或備查閱的；3）媒體一打印、CRI顯示、磁帶、卡片、磁盤，4）質(zhì)量管理-一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定；5）支配一例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受。4.3.2 輸出格式給出對(duì)每一類輸出信息的解釋，主要是：1）首部一如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)；2）主體輸出信息的主體，包括分欄標(biāo)題；3）尾部-包括累計(jì)總數(shù)，結(jié)束標(biāo)記。4.3.3 輸出舉例為每種輸出類型提供例子。對(duì)例子中的每一項(xiàng)，說明：1）定義一每項(xiàng)輸出信息的意義和用途；2）來源一是從特定的輸入中抽出、從數(shù)據(jù)庫文卷中取出、或從軟件的計(jì)算過程中得到3）特性-輸出的值域、計(jì)量單位、在什么情況下可缺省等。4.4 文卷查詢這一條的編寫針對(duì)具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫查詢有關(guān)的初始化、準(zhǔn)備、及處理所需要的詳細(xì)規(guī)定，說明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。4.5 出錯(cuò)處理和恢復(fù)列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。指出為了確保再啟