如何寫(xiě)程序維護(hù)手冊(cè)

字號(hào):

------------------------------------------------------------------------
    文檔編號(hào)
    版 本 號(hào)
    密 級(jí)
    文檔名稱(chēng) XXXX程序維護(hù)手冊(cè)
    項(xiàng)目編號(hào):
    項(xiàng)目名稱(chēng):
    開(kāi)發(fā)部門(mén):
    項(xiàng)目負(fù)責(zé)人:
    編寫(xiě) 年 月 日
    校對(duì) 年 月 日
    審核 年 月 日
    批準(zhǔn) 年 月 日
    程序維護(hù)手冊(cè)
    1引言
    1.1 編寫(xiě)目的
    [ 闡明編寫(xiě)維護(hù)手冊(cè)的目的,簡(jiǎn)述其內(nèi)容。指出讀者對(duì)象(程序維護(hù)人員、研發(fā)人員)。]
    1.2 開(kāi)發(fā)單位
    [說(shuō)明項(xiàng)目的提出者、項(xiàng)目的委托單位、開(kāi)發(fā)單位和使用場(chǎng)所。]
    1.3 定義
    [ 列出本文擋中用到的專(zhuān)業(yè)術(shù)語(yǔ)的定義和縮寫(xiě)詞的原文。]
    1.4 參考資料
    [ 可包括:a.用戶(hù)操作手冊(cè);b.于本項(xiàng)目有關(guān)的文檔。列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源以及保密級(jí)別。]
    2 系統(tǒng)說(shuō)明
    2.1 系統(tǒng)用途
    [ 說(shuō)明系統(tǒng)具備的功能,輸入和輸出。]
    2.2 安全保密
    [ 說(shuō)明系統(tǒng)安全保密方面的考慮。]
    2.3 總體說(shuō)明
    [ 說(shuō)明系統(tǒng)的總體功能、對(duì)子系統(tǒng)和作業(yè)作出綜合性的介紹,并用圖表方式給出系統(tǒng)主要部分的內(nèi)部關(guān)系。]
    2.4 程序說(shuō)明
    [ 說(shuō)明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性。]
    2.4.1 程序1的說(shuō)明
    2.4.1.1 功能 [ 說(shuō)明程序的功能。]
    2.4.1.2 方法 [ 說(shuō)明實(shí)現(xiàn)方法。]
    2.4.1.3 輸入 [ 說(shuō)明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開(kāi)始時(shí)使用的輸入數(shù)據(jù)的類(lèi)型和存放單元、與程序初始化有關(guān)的入口要求。]
    2.4.1.4 處理 [ 處理特點(diǎn)和目的,如:a. 用圖表說(shuō)明程序的運(yùn)行的邏輯流程; b. 程序主要轉(zhuǎn)移條件;c. 對(duì)程序的約束條件;d. 程序結(jié)束時(shí)的出口要求;e.與下一個(gè)程序的通信與聯(lián)結(jié)(運(yùn)行、控制); f. 由該程序產(chǎn)生并供處理使用的輸出數(shù)據(jù)類(lèi)型和存放單元。g.程序運(yùn)行所用存儲(chǔ)量、類(lèi)型及存儲(chǔ)位置等。]
    2.4.1.5 輸出 [ 程序的輸出。]
    2.4.1.6 接口 [ 本程序與本系統(tǒng)其他部分的接口。]
    2.4.1.7 表格 [ 說(shuō)明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對(duì)每張表的說(shuō)明至少包括:a. 表的標(biāo)識(shí)符;b. 使用目的;c. 使用此表的其他程序;d. 邏輯劃分,如塊或部,不包括表項(xiàng);e. 表的基本結(jié)構(gòu);f. 設(shè)計(jì)安排,包括表的控制信息。表目結(jié)構(gòu)細(xì)節(jié)、使用中的特有性質(zhì)及各表項(xiàng)的標(biāo)識(shí)、位置、用途、類(lèi)型、編碼表示。]
    2.4.1.8 特有的運(yùn)行性質(zhì) [ 說(shuō)明在用戶(hù)操作手冊(cè)中沒(méi)有提到的運(yùn)行性質(zhì)。]
    2.4.2 程序2 的說(shuō)明 [ 與程序1 的說(shuō)明相同。以后其他各程序的說(shuō)明相同。]
    3 操作環(huán)境
    3.1 設(shè)備
    [ 逐步說(shuō)明系統(tǒng)的設(shè)備配置極其特性 ]
    3.2 支持文件
    [ 列出系統(tǒng)使用的支持軟件、包括他們的名稱(chēng)和版本號(hào)。]
    3.3 數(shù)據(jù)庫(kù)
    [ 說(shuō)明每個(gè)數(shù)據(jù)庫(kù)的性質(zhì)和內(nèi)容,包括安全考慮。]
    3.3.1 總體特征
    [ 如:a. 標(biāo)識(shí)符 b. 使用這些數(shù)據(jù)庫(kù)的程序;c. 靜態(tài)數(shù)據(jù);d. 動(dòng)態(tài)數(shù)據(jù);e. 數(shù)據(jù)庫(kù)的存儲(chǔ)媒體;f. 程序使用數(shù)據(jù)庫(kù)的限制。]
    3.3.2 結(jié)構(gòu)及詳細(xì)說(shuō)明
    3.3.2.1 說(shuō)明該數(shù)據(jù)庫(kù)的結(jié)構(gòu),包括其中的記錄和項(xiàng);
    3.3.2.2 說(shuō)明記錄的組成,包括首部或或控制段、記錄體;
    3.3.2.3 說(shuō)明每個(gè)記錄結(jié)構(gòu)的字段,包括:標(biāo)記或標(biāo)號(hào)、字段的字符長(zhǎng)度和位數(shù)該字段的允許值范圍。
    3.3.2.4 擴(kuò)充:說(shuō)明為記錄追加字段的規(guī)定;
    4 維護(hù)過(guò)程
    4.1 約定
    [ 列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定,包括:a. 程序、分程序、記錄、字段和存儲(chǔ)區(qū)的標(biāo)識(shí)或標(biāo)號(hào)助記符的使用規(guī)則;b. 圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語(yǔ)句和記號(hào)中使用的縮寫(xiě)、出現(xiàn)在圖表中的符號(hào)名;c. 使用軟件的技術(shù)標(biāo)準(zhǔn);d. 標(biāo)準(zhǔn)化的數(shù)據(jù)元素極其特征。]
    4.2 驗(yàn)證過(guò)程
    [ 說(shuō)明一個(gè)程序修改后,對(duì)其進(jìn)行驗(yàn)證的要求和過(guò)程(包括測(cè)試程序和數(shù)據(jù))及程序周期性驗(yàn)證的過(guò)程。]
    4.3 出錯(cuò)及糾正方法
    [ 列出出錯(cuò)狀態(tài)及其糾正方法。]
    4.4 專(zhuān)門(mén)維護(hù)過(guò)程
    [ 說(shuō)明文檔其他地方?jīng)]有提到的專(zhuān)門(mén)維護(hù)過(guò)程,如:a. 維護(hù)該軟件系統(tǒng)的輸入部分(如數(shù)據(jù)庫(kù))的要求、過(guò)程和驗(yàn)證方法;b. 運(yùn)行程序庫(kù)維護(hù)系統(tǒng)所必須的要求、過(guò)程和驗(yàn)證方法;c. 對(duì)閏年、世紀(jì)變更所需要的臨時(shí)性修改等。]
    4.5 專(zhuān)用維護(hù)程序
    [ 列出維護(hù)軟件系統(tǒng)使用的后備技術(shù)和專(zhuān)用程序(如文件恢復(fù)程序、淘汰過(guò)時(shí)文件的程序等)的目錄,并加以說(shuō)明,內(nèi)容包括:a. 維護(hù)作業(yè)的輸入輸出要求;b. 輸入的詳細(xì)過(guò)程及硬件設(shè)備上建立、運(yùn)行并完成維護(hù)作業(yè)的操作步驟。]
    4.6 程序清單和流程圖
    [ 引用資料或提供附錄給出程序清單和流程圖。]
    -------------------------------------------------------------------------