軟體維護手冊模板

軟體維護手冊

1 引言

1.1 編寫目的：闡明編寫手冊的目的並指明讀者物件。

1.2 專案背景：說明專案的提出者、開發者、使用者和使用場所。

1.3 定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。

2 系統說明

2.1 系統用途：說明系統具備的功能，輸入和輸出。

2.2 安全保密：說明系統安全保密方面的考慮。

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

2.4 程式說明：說明系統中每一程式、分程式的細節和特性。

2.4.1 程式1的說明

● 功能：說明程式的功能。

● 方法：說明實現方法。

● 輸入：說明程式的輸入、**、執行資料記錄、執行開始時使用的輸入資料的型別和存放單元、與程式初始化有關的入口要求。

● 處理：處理特點和目的，如：用圖表說明程式的執行的邏輯流程；程式主要轉移條件；對程式的約束條件；程式結束時的出口要求；與下乙個程式的通訊與聯結（執行、控制）；由該程式產生並茶館處理程式段使用的輸出資料型別和存放單元；程式執行儲存量、型別及儲存位置等。

● 輸出：程式的輸出。

● 介面：本程式與本系統其他部分的介面。

●**：說明程式內部的各種表、項的細節和特性。對每張表的說明至少包括：表的識別符號；使用目的；使用此表的其他程式；邏輯劃分，如塊或部，不包括表項；表的基本結構；設計安排，包括表的控制資訊。表目結構細節、使用中的特有性質及各表項的標識、位置、用途、型別、編碼表示。

● 特有的執行性質：說明在使用者操作手冊中沒有提到的執行性質。

2.4.2程式2的說明

與程式1的說明相同。以後的其他各程式的說明相同。

3 操作環境

3.1 裝置：逐項說明系統的裝置配置及其特性。

3.2 支援軟體：列出系統使用的支援軟體，包括它們的名稱和版本號。

3.3 資料庫：說明每個資料庫的性質和內容，包括安全考慮。

3.3.1總體特徵：如識別符號、使用這些資料庫的程式、靜態資料、動態資料；資料庫的儲存**；程式使用資料庫的限制。

3.3.2結構及詳細說明

● 說明該資料庫的結構，包括其中的記錄和項。

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

● 說明每個記錄結構的字段，包括：標記或標號、欄位的字元長度和位數、該字段的允許值範圍。

● 擴充：說明為記錄追加欄位的規定。

4 維護過程

4.1 約定：列出該軟體系統設計中所使用全部規則和約定，包括：程式、分程式、記錄、欄位和儲存區的標識或標號助記符的使用規則；圖表的處理標準、卡片的連線順序、語句和記號中使用的縮寫、出現在圖表中的符號名；使用的軟體技術標準；標準化的資料元素及其特徵。

4.2 驗證過程：說明乙個程式段修改後，對其進行驗證的要求和過程（包括測試程式和資料）及程式週期性驗證的過程。

4.3 出錯及糾正方法：列出出錯狀態及其糾正方法。

4.4 專門維護過程：說明文件其他地方沒有提到的專門維護過程。如：維護該軟體系統的輸入輸出部分（如資料庫）的要求、過程和驗證方法；執行程式庫維護系統所必需的要求、過程和驗證方法；對閏年、世紀變更的所需要的臨時性修改等。

4.5 專用維護程式：列出維護軟體系統使用的後備技術和專用程式（如檔案恢復程式、淘汰過時檔案的程式等）的目錄，並加以說明，內容包括：維護作業的輸入輸出要求；輸入的詳細過程及在硬裝置上建立、執行並完成維護作業的操作步驟。

4.6 程式清單和流程圖：引用或提供附錄給出程式清單和流程圖。