軟件維護(hù)手冊

1、.軟件維護(hù)手冊主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明，便于軟件的維護(hù)。1 引言 1.1 編寫目的闡明編寫手冊的目的并指明讀者對象。 1.2 項(xiàng)目背景說明項(xiàng)目的提出者、開發(fā)者、用戶和使用場所。 1.3 定義列出報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原意。 1.4 參考資料列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，及保密級別，可包括：用戶操作手冊；與本項(xiàng)目有關(guān)的其他文檔。 2 系統(tǒng)說明 2.1 系統(tǒng)用途說明系統(tǒng)具備的功能，輸入和輸出。 2.2 安全保密說明系統(tǒng)安全保密方面的考慮。 2.3 總體說明說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出

2、綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系。 2.4 程序說明說明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性。 2.4.1 程序1的說明 功能：說明程序的功能。 方法：說明實(shí)現(xiàn)方法。 輸入：說明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開始時(shí)使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求。 處理：處理特點(diǎn)和目的，如：用圖表說明程序的運(yùn)行的邏輯流程；程序主要轉(zhuǎn)移條件；對程序的約束條件；程序結(jié)束時(shí)的出口要求；與下一個(gè)程序的通信與聯(lián)結(jié)（運(yùn)行、控制）；由該程序產(chǎn)生并茶館處理程序段使用的輸出數(shù)據(jù)類型和存放單元；程序運(yùn)行存儲(chǔ)量、類型及存儲(chǔ)位置等。 輸出：程序的輸出。 接口：本程序與本系統(tǒng)其他部分

3、的接口。 表格：說明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對每張表的說明至少包括：表的標(biāo)識符；使用目的；使用此表的其他程序；邏輯劃分，如塊或部，不包括表項(xiàng)；表的基本結(jié)構(gòu)；設(shè)計(jì)安排，包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項(xiàng)的標(biāo)識、位置、用途、類型、編碼表示。 特有的運(yùn)行性質(zhì)：說明在用戶操作手冊中沒有提到的運(yùn)行性質(zhì)。 2.4.2 程序2的說明 與程序1的說明相同。以后的其他各程序的說明相同。 3 操作環(huán)境 3.1 設(shè)備逐項(xiàng)說明系統(tǒng)的設(shè)備配置及其特性。 3.2 支持軟件列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號。 3.3 數(shù)據(jù)庫說明每個(gè)數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮。 3.3.1

4、總體特征如標(biāo)識符、使用這些數(shù)據(jù)庫的程序、靜態(tài)數(shù)據(jù)、動(dòng)態(tài)數(shù)據(jù)；數(shù)據(jù)庫的存儲(chǔ)媒體；程序使用數(shù)據(jù)庫的限制。 3.3.2 結(jié)構(gòu)及詳細(xì)說明 說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項(xiàng)。 說明記錄的組成，包括首部或控制段、記錄體。 說明每個(gè)記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號、字段的字符長度和位數(shù)、該字段的允許值范圍。 擴(kuò)充：說明為記錄追加字段的規(guī)定。 4 維護(hù)過程 4.1 約定列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定，包括：程序、分程序、記錄、字段和存儲(chǔ)區(qū)的標(biāo)識或標(biāo)號助記符的使用規(guī)則；圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名；使用的軟件技術(shù)標(biāo)準(zhǔn)；標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征。 4.2 驗(yàn)證過程說明一個(gè)程序段修改后，對其進(jìn)行驗(yàn)證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期性驗(yàn)證的過程。 4.3 出錯(cuò)及糾正方法列出出錯(cuò)狀態(tài)及其糾正方法。 4.4 專門維護(hù)過程說明文檔其他地方?jīng)]有提到的專門維護(hù)過程。如：維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫）的要求、過程和驗(yàn)證方法；運(yùn)行程序庫維護(hù)系統(tǒng)所必需的要求、過程和驗(yàn)證方法；對閏年、世紀(jì)變更的所需要的臨時(shí)性修改等。 4.5 專用維護(hù)程序列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過時(shí)文件的程序等）的目錄，并加以說明，內(nèi)容包括：