軟件程序維護(hù)手冊(cè)

PAGE1PAGE4程序維護(hù)手冊(cè)概述編寫目的編寫者可照抄下列語句，說明程序維護(hù)手冊(cè)的編寫目的，也可進(jìn)行適當(dāng)修改?！熬帉懗绦蚓S護(hù)手冊(cè)的目的是為程序維護(hù)人員有效的維護(hù)×××××（軟件名稱）系統(tǒng)提供必要的信息。”參考資料列出本文檔引用到的參考資料，包括作者、來源、編號(hào)、標(biāo)題、出版日期和保密級(jí)別。如：用戶手冊(cè)；操作手冊(cè)；與本項(xiàng)目有關(guān)的其它文檔。術(shù)語和縮寫詞列出本文檔中專用的術(shù)語、定義和縮寫詞。開發(fā)單位說明該項(xiàng)目的提出者、開發(fā)者、用戶和運(yùn)行該軟件系統(tǒng)的場所。系統(tǒng)說明系統(tǒng)用途說明系統(tǒng)具備的功能，如用于控制戰(zhàn)斗的系統(tǒng)要接收專門的輸入（如勢態(tài)報(bào)告、緊急警報(bào)等）并從輸入中提取一些數(shù)據(jù)，再由此導(dǎo)出一些數(shù)據(jù)，從而形成具體戰(zhàn)斗任務(wù)的信息和簡報(bào)。安全保密說明系統(tǒng)數(shù)據(jù)的安全保密考慮。總體說明根據(jù)系統(tǒng)的總體功能，對(duì)系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的形式給出系統(tǒng)主要部分的內(nèi)部關(guān)系。程序說明說明系統(tǒng)中每個(gè)程序、分程序的細(xì)節(jié)和特性，以幫助維護(hù)人員理解各個(gè)程序及它們之間的關(guān)系。系統(tǒng)的專用維護(hù)程序?qū)⒃诘?.5節(jié)（專用維護(hù)程序）中說明。程序1（標(biāo)識(shí)符）說明功能說明程序的功能2.4.1.2方法說明實(shí)現(xiàn)該程序的功能所使用的方法。輸入說明程序的輸入、所用介質(zhì)、運(yùn)行時(shí)用到的數(shù)據(jù)記錄、運(yùn)行開始時(shí)使用的輸入數(shù)據(jù)的類型及存放單元、與程序初始化有關(guān)的入口要求等。處理介紹程序維護(hù)人員需要了解的處理特點(diǎn)及目的，如：產(chǎn)要的運(yùn)行，用圖表說明該程序的一系列運(yùn)行的邏輯流程，例如讀一個(gè)輸入，訪問一個(gè)數(shù)據(jù)記錄、一個(gè)判斷和一次打印輸出，這些運(yùn)行可用程序內(nèi)部的程序段或子程序來表示，也可用圖表分別詳細(xì)表示每個(gè)重要的運(yùn)行；本程序的主要轉(zhuǎn)移條件；對(duì)程序運(yùn)行的約束條件；程序運(yùn)行結(jié)束時(shí)的出口要求；與下個(gè)程序的通信和聯(lián)接（運(yùn)行、控制）；由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型及存放單元；程序運(yùn)行需要的存儲(chǔ)器容量、類型及存儲(chǔ)位置等主要參數(shù)。輸出用便于程序維護(hù)人員理解的方式說明該程序的輸出。接口說明該程序與本系統(tǒng)其它部分的接口。2.4.1.7表格說明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性，對(duì)每張表的說明至少包括：表的標(biāo)識(shí)符；使用目的；使用此表的其它程序；邏輯劃分，如塊或部，不包括表項(xiàng)；基本結(jié)構(gòu)，包括固定長或可變長、固定表目或可變表目；設(shè)計(jì)安排，包括表的控制信息、每類表目的結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及表內(nèi)各項(xiàng)的標(biāo)識(shí)符、位置信息、用途、類型及編碼表示。2.4.1.8特有的運(yùn)行性質(zhì)說明在操作手冊(cè)中沒有提到的運(yùn)行性質(zhì)。程序2（標(biāo)識(shí)符）說明用與第2.4.1款相同的方法，說明第2個(gè)到第N個(gè)程序。操作環(huán)境設(shè)備逐項(xiàng)說明系統(tǒng)的設(shè)備配置及其特性。支持軟件列出本系統(tǒng)使用的全部支持軟件，包括它們的名稱和版本號(hào)。數(shù)據(jù)庫全面說明每個(gè)數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮?？傮w特征如：標(biāo)識(shí)符；使用這些數(shù)據(jù)庫的程序；靜態(tài)數(shù)據(jù)；動(dòng)態(tài)數(shù)據(jù)；數(shù)據(jù)庫的存儲(chǔ)介質(zhì)（如磁帶、磁盤和內(nèi)存）的規(guī)格及容量；系統(tǒng)中程序使用數(shù)據(jù)庫時(shí)受到的限制。結(jié)構(gòu)及詳細(xì)說明說明數(shù)據(jù)庫的內(nèi)部結(jié)構(gòu)。3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項(xiàng)。3.3.2.2說明一個(gè)物理記錄是一個(gè)邏輯記錄，還是組成一個(gè)邏輯記錄的若干個(gè)物理記錄之一。說明一個(gè)記錄的組成部分，如首部或控制段、記錄體。說明每個(gè)記錄結(jié)構(gòu)的域，需要時(shí)解釋它的目的。對(duì)每個(gè)域應(yīng)包括下述內(nèi)容：標(biāo)記或標(biāo)號(hào)；指明每個(gè)數(shù)據(jù)域的字符長度和位數(shù)；指明該域的允許值范圍。3.3.2.4擴(kuò)充，說明為記錄增添附加數(shù)據(jù)域的規(guī)定。維護(hù)過程約定列出該軟件系統(tǒng)設(shè)計(jì)中使用的全部規(guī)則和約定，包括：程序、分程序、記錄、數(shù)據(jù)域和存儲(chǔ)區(qū)的標(biāo)識(shí)或標(biāo)號(hào)助記符的使用規(guī)則；圖表的處理和標(biāo)準(zhǔn)、卡片的連接順序、語句和記號(hào)中使用的縮寫、出現(xiàn)在圖表中的符號(hào)名；使用的軟件技術(shù)標(biāo)準(zhǔn)；標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征。驗(yàn)證過程說明一個(gè)程序段修改后，對(duì)其性能進(jìn)行驗(yàn)證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期性驗(yàn)征的過程。出錯(cuò)及糾正方法列出出錯(cuò)狀態(tài)及其糾正方法。專門維護(hù)過程說明本文檔其它地方?jīng)]有提到的專門維護(hù)過程，例如：維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)庫）的要求、過程和驗(yàn)證方法；運(yùn)行程序庫維護(hù)系統(tǒng)所必需的要求、過程和驗(yàn)證方法；對(duì)閏年、世紀(jì)變更需要的臨時(shí)性修改等。專用維護(hù)程序列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專用程序（如文件恢復(fù)程序、淘汰過時(shí)文件的程序等）的目錄，并加以說明，內(nèi)容包括：維護(hù)作業(yè)的輸入輸出要求；輸入的詳細(xì)過程及在硬設(shè)備上建立、運(yùn)行并完成維護(hù)作業(yè)的操作步驟。程序清單和流程圖引用資料或提供附錄給出程序清單和流程圖。程序維護(hù)手冊(cè)TOC\o"1-3"1概述 11.1 編寫目的 11.2 參考資料 11.3 術(shù)語和縮寫詞 11.4 開發(fā)單位 12系統(tǒng)說明 12.1 系統(tǒng)用途 12.2 安全保密 12.3 總體說明 12.4 程序說明 12.4.1 程序1（標(biāo)識(shí)符）說明 12.4.2 程序2（標(biāo)識(shí)符）說明 23操作環(huán)境 23.1 設(shè)備 23.2 支持軟件 23.3 數(shù)據(jù)庫 23.3.1 總體特征 23.3.2 結(jié)構(gòu)及詳細(xì)說明 34維護(hù)過程 34.1 約定 34.2 驗(yàn)證過程 34.3 出錯(cuò)及糾正方法 P