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