十一、程序維護(hù)手冊(軟件開發(fā)文檔模板)(共5頁)

1、精選優(yōu)質(zhì)文檔-傾情為你奉上十一、程序維護(hù)手冊1引言1.1編寫目的【闡明編寫手冊的目的，指明讀者對象?！?.2開發(fā)單位【說明項目的提出者、開發(fā)者、用戶和使用場所?！?.3定義【列出報告中所用到的專門術(shù)語的定義和縮寫詞的原文?！?.4參考資料【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，以及保密級別，可包括： a. 用戶操作手冊；b. 與本項目有關(guān)的其他文檔?！?系統(tǒng)說明2.1系統(tǒng)用途【說明系統(tǒng)具備的功能，輸入和輸出?！?.2安全保密【說明系統(tǒng)安全保密方面的考慮?！?.3總體說明【說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系。

2、】2.4程序說明【說明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性?！?.4.1程序1的說明2.4.1.1功能【說明程序的功能。】2.4.1.2方法【說明實現(xiàn)方法?！?.4.1.3輸入【說明程序的輸入、媒體、運行數(shù)據(jù)記錄、運行開始時使用的輸入數(shù)據(jù)的類型和存放單元、與程序初始化有關(guān)的入口要求?！?.4.1.4處理【處理特點和目的，如：a. 用圖表說明程序中的運行邏輯流程；b. 程序主要轉(zhuǎn)移條件；c. 對程序的約束條件；d. 程序結(jié)束時的出口要求； e. 與下一個程序的通信與聯(lián)結(jié)（運行、控制）；f. 由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元；g. 程序運行所用存儲量、類型及存儲位置等?！?.4

3、.1.5輸出【程序的輸出?！?.4.1.6接口【本程序與本系統(tǒng)其他部分的接口。】2.4.1.7表格【說明程序內(nèi)部的各種表、項的細(xì)節(jié)和特性。對每張表的說明至少包括：a. 表的標(biāo)識符；b. 使用目的；c. 使用此表的其他程序；d. 邏輯劃分，如塊或部，不包括表項；e. 表的基本結(jié)構(gòu)；f. 設(shè)計安排，包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項的標(biāo)識、位置、用途、類型、編碼表示。】2.4.1.8特有的運行性質(zhì)【說明在用戶操作手冊中沒有提到的運行性質(zhì)?！?.4.2程序2的說明【與程序1的說明相同。以后其他各程序的說明相同?！?操作環(huán)境3.1設(shè)備【逐項說明系統(tǒng)的設(shè)備配置及其特性。】3.2支持

4、軟件【列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號。】3.3數(shù)據(jù)庫【說明每個數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮?！?.3.1總體特征【如：a. 標(biāo)識符；b. 使用這些數(shù)據(jù)庫的程序；c. 靜態(tài)數(shù)據(jù)；d. 動態(tài)數(shù)據(jù)；e. 數(shù)據(jù)庫的存儲媒體；f. 程序使用數(shù)據(jù)庫的限制?！?.3.2結(jié)構(gòu)及詳細(xì)說明3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項；3.3.2.2說明記錄的組成，包括首部或控制段、記錄體；3.3.2.3說明每個記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號、字段的字符長度和位數(shù)、該字段的充許值范圍。3.3.2.4擴(kuò)充：說明為記錄追加字段的規(guī)定；4維護(hù)過程4.1約定【列出該軟件系統(tǒng)設(shè)計中所使用全部規(guī)則

5、和約定，包括：a. 程序、分程序、記錄、字段和存儲區(qū)的標(biāo)識或標(biāo)號助記符的使用規(guī)則；b. 圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名；c. 使用的軟件技術(shù)標(biāo)準(zhǔn)；d. 標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征?！?.2驗證過程【說明一個程序段修改后，對其進(jìn)行驗證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期性驗證的過程。】4.3出錯及糾正方法【列出出錯狀態(tài)及其糾正方法?！?.4專門維護(hù)過程【說明文檔其他地方?jīng)]有提到的專門維護(hù)過程，如：a. 維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫）的要求、過程和驗證方法；b. 運行程序庫維護(hù)系統(tǒng)所必需的要求、過程和驗證方法；c. 對閏年、世紀(jì)變更所需的臨時性修改等?！?.5專用維護(hù)程序【列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過時文件的程序等）的目錄，并加以說明，內(nèi)容包括：a. 維護(hù)作業(yè)的輸