軟件維護手冊
主要包括軟件系統說明、程序模塊說明、操作環境、支持軟件的說明、維護過程的說明,便於軟件的維護。
1 引言
1.1 編寫目的
闡明編寫手冊的目的並指明讀者對象。
1.2 項目背景
說明項目的提出者、開發者、用戶和使用場所。
1.3 定義
列出報告中所用到的專門術語的定義和縮寫詞的原意。
1.4 參考資料
列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,及保密級別,可包括:用戶操作手冊;與本項目有關的其他文檔。
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 程序清單和流程圖
引用或提供附錄給出程序清單和流程圖。
