1 目的 2
2 范圍 2
3 文件的使用者 3
4 軟件生存周期與各種文件的編制 4
6 文件編制的管理工作 6
6.1文件的形成 6
6.2文件的分類與標(biāo)識 7
6•3文件的控制 7
6.4文件的修改管理 8
7 可行性研究報告 9
8 項(xiàng)目開發(fā)計劃 10
9 軟件需求說明書 11
10 數(shù)據(jù)要求說明書 12
11 概要設(shè)計說明書 12
12詳細(xì)設(shè)計說明書 13
13 數(shù)據(jù)庫設(shè)計說明書 14
14 用戶手冊 14
15 操作手冊 15
16 模塊開發(fā)卷宗 16
17測試計劃 17
18 測試分析報告 18
19 開發(fā)進(jìn)度月報 19
20 項(xiàng)目開發(fā)總結(jié)報告 19
附錄A 可行性研究報告的編寫提示(參考件) 20
附錄B 項(xiàng)目開發(fā)計劃的編寫提示(參考件) 27
附錄C 軟件需求說明書的編寫提示(參考件) 30
附錄D數(shù)據(jù)要求說明書的編寫提示(參考件) 32
附錄E概要設(shè)計說明書的編寫提示(參考件) 34
附錄F詳細(xì)設(shè)計說明書的編寫提示(參考件) 38
附錄G數(shù)據(jù)庫設(shè)計說明書的編寫提示(參考件) 40
附錄H用戶手冊的編寫提示(參考件) 42
附錄I 操作手冊的編寫提示(參考件) 46
附錄J模塊開發(fā)卷宗的編寫提示(參考件) 49
附錄K測試計劃的編寫提示(參考件) 50
中華人民共和國國家標(biāo)準(zhǔn) UDC 681. 3
計算機(jī)軟件產(chǎn)品開發(fā)文件編制指南 GB 8567-88
Guidelines for computer software product development documentation
引言
1 目的
一項(xiàng)計算機(jī)軟件的籌劃、研制及實(shí)現(xiàn),構(gòu)成一個軟件開發(fā)項(xiàng)目。一個軟件開發(fā)項(xiàng)目的進(jìn)行,一般需要在人力和自動化資源等方面作重大的投資。為了保證項(xiàng)目開發(fā)的成功,最經(jīng)濟(jì)地花費(fèi)這些投資,并且便于運(yùn)行和維護(hù),在開發(fā)工作的每一階段,都需要編制一定的文件。這些文件連同計算機(jī)程序及數(shù)據(jù)一起,構(gòu)成為計算機(jī)軟件。文件是計算機(jī)軟件中不可缺少的組成部分,它的作用是:
a.作為開發(fā)人員在一定階段內(nèi)的工作成果和結(jié)束標(biāo)志;
b.向管理人員提供軟件開發(fā)過程中的進(jìn)展和情況,把軟件開發(fā)過程中的一些“不可見的”事物轉(zhuǎn) 換成“可見的”文字資料。以便管理人員在各個階段檢查開發(fā)計劃的實(shí)施進(jìn)展,使之能夠判斷原定目標(biāo)是否已達(dá)到,還將繼續(xù)耗用資源的種類和數(shù)量;
C.記錄開發(fā)過程中的技術(shù)信息,便于協(xié)調(diào)以后的軟件開發(fā)、使用和修改;
d.提供對軟件的有關(guān)運(yùn)行、維護(hù)和培訓(xùn)的信息,便于管理人員、開發(fā)人員、操作人員和用戶之間相互了解彼此的工作;
e.向潛在用戶報導(dǎo)軟件的功能和性能,使他們能判定該軟件能否服務(wù)于自己的需要。
換言之,本指南認(rèn)為:文件的編制必須適應(yīng)計算機(jī)軟件整個生存周期的需要。
計算機(jī)軟件所包含的文件有兩類:一類是開發(fā)過程中填寫的各種圖表,可稱之為工作表格;另一類則是應(yīng)編制的技術(shù)資料或技術(shù)管理資料,可稱之為文件。本指南規(guī)定軟件文件的編制形式,并提供對這些規(guī)定的解釋。本指南的目的是使得所編制的軟件文件確實(shí)能夠起到軟件文件應(yīng)該發(fā)揮的作用。
2 范圍
本指南是一份指導(dǎo)性文件。本指南建議,在一項(xiàng)計算機(jī)軟件的開發(fā)過程中,一般地說,應(yīng)該產(chǎn)生十四種文件。這十四種文件是:
可行性研究報告;
項(xiàng)目開發(fā)計劃;
軟件需求說明書;
數(shù)據(jù)要求說明書;
概要設(shè)計說明書;
詳細(xì)設(shè)計說明書;
數(shù)據(jù)庫設(shè)計說明書;
用戶手冊;
操作手冊;
模塊開發(fā)卷宗;
測試計劃;
測試分析報告;
開發(fā)進(jìn)度月報;
項(xiàng)目開發(fā)總結(jié)報告。
本指南將給出開發(fā)過程中建議產(chǎn)生的這十四種文件的編制指導(dǎo),同時,本指南也是這十四種文件的編寫質(zhì)量的檢驗(yàn)準(zhǔn)則。但是,本指南并未涉及軟件開發(fā)過程中如何填寫工作表格的問題。
一般地說,一個軟件總是一個計算機(jī)系統(tǒng)(包括硬件、固件和軟件)的組成部分。鑒于計算機(jī)系統(tǒng)的多樣性,本指南一般不涉及整個系統(tǒng)開發(fā)中的文件編制問題,本指南僅僅是軟件開發(fā)過程中的文件編制指南。
3 文件的使用者
對于使用文件的人員而言,他們所關(guān)心的文件的種類,隨他們所承擔(dān)的工作而異。
管理人員:可行性研究報告,
項(xiàng)目開發(fā)計劃,
模塊開發(fā)卷宗,
開發(fā)進(jìn)度月報,
項(xiàng)目開發(fā)總結(jié)報告;
開發(fā)人員:可行性研究報告,
項(xiàng)目開發(fā)計劃,
軟件需求說明書,
數(shù)據(jù)要求說明書,
概要設(shè)計說明書,
詳細(xì)設(shè)計說明書,
數(shù)據(jù)庫設(shè)計說明書,
測試計劃,
測試分析報告;
維護(hù)人員:設(shè)計說明書,
測試分析報告,
模塊開發(fā)卷宗;
用戶:用戶手冊,
操作手冊。
盡管本指南提出了在軟件開發(fā)中文件編制的要求,但并不意味著這些文件都必須交給用戶。一項(xiàng)軟件的用戶應(yīng)該得到的文件的種類由供應(yīng)者與用戶之間簽訂的合同規(guī)定。
第一篇 文件的編制指導(dǎo)
4 軟件生存周期與各種文件的編制
一項(xiàng)計算機(jī)軟件,從出現(xiàn)一個構(gòu)思之日起,經(jīng)過這項(xiàng)軟件開發(fā)成功投入使用,直到最后決定停止使用,并被另一項(xiàng)軟件代替之時止,被認(rèn)為是該軟件的一個生存周期。一般地說這個軟件生存周期可以分成以下六個階段:
可行性與計劃研究階段
|
|