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