程序維護(hù)手冊編寫規(guī)范

程序維護(hù)手冊

XXXX有限公司

文件編號：

當(dāng)前版本：V2.0

機(jī)密等級：內(nèi)部公開

編制者：

審核者：

批準(zhǔn)者：

批準(zhǔn)日期：

XXXX有限公司對本文件資料享受著作權(quán)及其它專屬權(quán)利，未經(jīng)書面許可，不得將該等文件資料

（其全部或任何部分）披露予任何第三方，或進(jìn)行修改后使用。

文檔修改記錄:

日期版本修訂內(nèi)容修改人核定人

十一、程序維護(hù)手冊

1.弓【言.........................................................................3

1.1編寫目的................................................................3

1.2開發(fā)單位................................................................4

1.3定義....................................................................4

1.4參考資料................................................................4

2.系統(tǒng)說明....................................................................4

2.1系統(tǒng)用途................................................................4

2.2安全保密................................................................4

2.3總體說明................................................................4

2.4程序說明................................................................4

3.操作環(huán)境....................................................................5

3.1設(shè)備....................................................................5

3.2支持軟件................................................................6

3.3數(shù)據(jù)庫..................................................................6

4.維護(hù)過程....................................................................6

4.1約定....................................................................6

4.2驗(yàn)證過程.................................................................7

4.3出錯(cuò)及糾正方法...........................................................7

4.4專門維護(hù)過程.............................................................7

4.5專用維護(hù)程序.............................................................7

4.6程序清單和流程圖.........................................................7

1.引言

編寫目的

【闡明編寫手冊的目的，指明讀者對象?！?/p>

1.2開發(fā)單位

【說明項(xiàng)目的提出者、開發(fā)者、用戶和使用場所?！?/p>

L3定義

【列出報(bào)告中所用到的專門術(shù)語的定義和縮寫詞的原文?！?/p>

1.4參考資料

【列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，以及保密級別，可

包括：

a.用戶操作手冊；

b.與本項(xiàng)目有關(guān)的其他文檔?！?/p>

2.系統(tǒng)說明

2.1系統(tǒng)用途

【說明系統(tǒng)具備的功能，輸入和輸出?！?/p>

2.2安全保密

【說明系統(tǒng)安全保密方面的考慮?！?/p>

2.3總體說明

【說明系統(tǒng)的總體功能，對系統(tǒng)、子系統(tǒng)和作業(yè)做出綜合性的介紹，并用圖表的方式給出系

統(tǒng)主要部分的內(nèi)部關(guān)系

2.4程序說明

【說明系統(tǒng)中每一程序、分程序的細(xì)節(jié)和特性?！?/p>

2.4.1程序1的說明

2.4.1.1功能

【說明程序的功能門

2.4.1.2方法

【說明實(shí)現(xiàn)方法?！?/p>

2.4.1.3輸入

【說明程序的輸入、媒體、運(yùn)行數(shù)據(jù)記錄、運(yùn)行開始時(shí)使用的輸入數(shù)據(jù)的類型和存

放單元、與程序初始化有關(guān)的入口要求。】

2.4.1.4處理

【處理特點(diǎn)和目的，如：

a.用圖表說明程序中的運(yùn)行邏輯流程；

b.程序主要轉(zhuǎn)移條件；

c.對程序的約束條件；

d.程序結(jié)束時(shí)的出口要求；

e.與下一個(gè)程序的通信與聯(lián)結(jié)（運(yùn)行、控制）；

f.由該程序產(chǎn)生并供處理程序段使用的輸出數(shù)據(jù)類型和存放單元；

g.程序運(yùn)行所用存儲(chǔ)量、類型及存儲(chǔ)位置等?！?/p>

2.4.1.5輸出

【程序的輸山?！?/p>

2.4.1.6接口

［本程序與本系統(tǒng)其他部分的接口03

2.4.1.7表格

【說明程序內(nèi)部的各種表、項(xiàng)的細(xì)節(jié)和特性。對每張表的說明至少包括：

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í)、位置、用途、類型、編碼表示?！?/p>

2.4.1.8特有的運(yùn)行性質(zhì)

【說明在用戶操作手冊中沒有提到的運(yùn)行性質(zhì)?！?/p>

2.4.2程序2的說明

【與程序1的說明相同。以后其他各程序的說明相同?！?/p>

3.操作環(huán)境

3.1設(shè)備

【逐項(xiàng)說明系統(tǒng)的設(shè)備配置及其特性?！?/p>

3.2支持軟件

【列出系統(tǒng)使用的支持軟件，包括它們的名稱和版本號?！?/p>

3.3數(shù)據(jù)庫

【說明每個(gè)數(shù)據(jù)庫的性質(zhì)和內(nèi)容，包括安全考慮?！?/p>

3.3.1總體特征

【如：

a.標(biāo)識(shí)符；

b.使用這些數(shù)據(jù)庫的程序；

c.靜態(tài)數(shù)據(jù)；

d.動(dòng)態(tài)數(shù)據(jù)；

e,數(shù)據(jù)庫的存儲(chǔ)媒體；

f.程序使用數(shù)據(jù)庫的限制?！?/p>

3.3.2結(jié)構(gòu)及詳細(xì)說明

3.3.2.1說明該數(shù)據(jù)庫的結(jié)構(gòu)，包括其中的記錄和項(xiàng)；

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

3.3.2.3說明每個(gè)記錄結(jié)構(gòu)的字段，包括：標(biāo)記或標(biāo)號、字段的字符長度和位數(shù)、該字段的

充許值范圍。

3.3.2.4擴(kuò)充：說明為記錄追加字段的規(guī)定：

4.維護(hù)過程

4.1約定

【列出該軟件系統(tǒng)設(shè)計(jì)中所使用全部規(guī)則和約定，包括：

a.程序、分程序、記錄、字段和存儲(chǔ)區(qū)的標(biāo)識(shí)或標(biāo)號助記符的使用規(guī)則；

b.圖表的處理標(biāo)準(zhǔn)、卡片的連接順序、語句和記號中使用的縮寫、出現(xiàn)在圖表中的符號名;

c.使用的軟件技術(shù)標(biāo)準(zhǔn)；

d.標(biāo)準(zhǔn)化的數(shù)據(jù)元素及其特征?！?/p>

4.2驗(yàn)證過程

【說明一個(gè)程序段修改后，對其法行驗(yàn)證的要求和過程（包括測試程序和數(shù)據(jù)）及程序周期

性驗(yàn)證的過程?！?/p>

4.3出錯(cuò)及糾正方法

【列出出錯(cuò)狀態(tài)及其糾正方法?！?/p>

4.4專門維護(hù)過程

【說明文檔其他地方?jīng)]有提到的專門維護(hù)過程，如：

a.維護(hù)該軟件系統(tǒng)的輸入輸出部分（如數(shù)據(jù)