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