軟件寫作文檔 用戶手冊（GB8567-88）

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