程序維護手冊

1．引言

1.1編寫目的

【闡明編寫手冊的目的，指明讀者對象。】

 

1.2開發單位

【說明項目的提出者、開發者、用戶和使用場所。】

1.3定義

【列出報告中所用到的專門術語的定義和縮寫詞的原文。】

1.4參考資料

【列出有關資料的做者、標題、編號、發表日期、出版單位或資料來源，以及保密級別，可包括：

a.  用戶操做手冊；

b.  與本項目有關的其餘文檔。】

2．系統說明

2.1系統用途

【說明系統具有的功能，輸入和輸出。】

2.2安全保密

【說明系統安全保密方面的考慮。】

2.3整體說明

【說明系統的整體功能，對系統、子系統和做業作出綜合性的介紹，並用圖表的方式給出系統主要部分的內部關係。】

2.4程序說明

【說明系統中每一程序、分程序的細節和特性。】

2.4.1程序1的說明

2.4.1.1功能

【說明程序的功能。】

2.4.1.2方法

【說明實現方法。】

2.4.1.3輸入

【說明程序的輸入、媒體、運行數據記錄、運行開始時使用的輸入數據的類型和存放單元、與程序初始化有關的入口要求。】

2.4.1.4處理

【處理特色和目的，如：

a.  用圖表說明程序中的運行邏輯流程；

b.  程序主要轉移條件；

c.  對程序的約束條件；

d.  程序結束時的出口要求；

e.  與下一個程序的通訊與聯結（運行、控制）；

f.  由該程序產生並供處理程序段使用的輸出數據類型和存放單元；

g.  程序運行所用存儲量、類型及存儲位置等。】

2.4.1.5輸出

【程序的輸出。】

2.4.1.6接口

【本程序與本系統其餘部分的接口。】

2.4.1.7表格

【說明程序內部的各類表、項的細節和特性。對每張表的說明至少包括：

a.  表的標識符；

b.  使用目的；

c.  使用此表的其餘程序；

d.  邏輯劃分，如塊或部，不包括表項；

e.  表的基本結構；

f.  設計安排，包括表的控制信息。表目結構細節、使用中的特有性質及各表項的標識、位置、用途、類型、編碼表示。】

2.4.1.8特有的運行性質

【說明在用戶操做手冊中沒有提到的運行性質。】

2.4.2程序2的說明

【與程序1的說明相同。之後其餘各程序的說明相同。】

3．操做環境

3.1設備

【逐項說明系統的設備配置及其特性。】

3.2支持軟件

【列出系統使用的支持軟件，包括它們的名稱和版本號。】

3.3數據庫

【說明每一個數據庫的性質和內容，包括安全考慮。】

3.3.1整體特徵

【如：

a.  標識符；

b.  使用這些數據庫的程序；

c.  靜態數據；

d.  動態數據；

e.  數據庫的存儲媒體；

f.  程序使用數據庫的限制。】

3.3.2結構及詳細說明

3.3.2.1說明該數據庫的結構，包括其中的記錄和項；

 

3.3.2.2說明記錄的組成，包括首部或控制段、記錄體；

 

3.3.2.3說明每一個記錄結構的字段，包括：標記或標號、字段的字符長度和位數、該字段的充許值範圍。

 

3.3.2.4擴充：說明爲記錄追加字段的規定；

4．維護過程

4.1約定

【列出該軟件系統設計中所使用所有規則和約定，包括：

a.  程序、分程序、記錄、字段和存儲區的標識或標號助記符的使用規則；

b.  圖表的處理標準、卡片的鏈接順序、語句和記號中使用的縮寫、出如今圖表中的符號名；

c.  使用的軟件技術標準；

d.  標準化的數據元素及其特徵。】

4.2驗證過程

【說明一個程序段修改後，對其進行驗證的要求和過程（包括測試程序和數據）及程序週期性驗證的過程。】

4.3出錯及糾正方法

【列出出錯狀態及其糾正方法。】

4.4專門維護過程

【說明文檔其餘地方沒有提到的專門維護過程，如：

a.  維護該軟件系統的輸入輸出部分（如數據庫）的要求、過程和驗證方法；

b.  運行程序庫維護系統所必需的要求、過程和驗證方法；

c.  對閏年、世紀變動所需的臨時性修改等。】

4.5專用維護程序

【列出維護軟件系統使用的後備技術和專用程序（如文件恢復程序、淘汰過期文件的程序等）的目錄，並加以說明，內容包括：

a.  維護做業的輸入輸出要求；

b.  輸入的詳細過程及在硬設備上創建、運行並完成維護做業的操做步驟。】

4.6程序清單和流程圖

【引用資料或提供附錄給出程序清單和流程圖。】