《計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南》

附錄五國(guó)家標(biāo)準(zhǔn)《計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南》國(guó)家標(biāo)準(zhǔn)《計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南》（GB8567—88）是一份指導(dǎo)性文件。它建議在軟件的開(kāi)發(fā)過(guò)程申編下述14個(gè)文件：可行性研究報(bào)告、項(xiàng)目開(kāi)發(fā)計(jì)劃、軟件需求說(shuō)明書(shū)、數(shù)據(jù)要求說(shuō)明書(shū)、總體設(shè)計(jì)說(shuō)明書(shū)、詳細(xì)設(shè)計(jì)說(shuō)明、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)、用戶(hù)手冊(cè)、操作手冊(cè)、模塊開(kāi)發(fā)卷、測(cè)試計(jì)劃、測(cè)試分析報(bào)告、開(kāi)發(fā)進(jìn)度表、項(xiàng)目開(kāi)發(fā)總結(jié)。該指南給出了這14個(gè)文件的編制提示，它同時(shí)也是這14個(gè)文件編寫(xiě)質(zhì)量的檢驗(yàn)準(zhǔn)則。下面詳細(xì)介紹這14種文件的編寫(xiě)目的與內(nèi)容要求。l、可行性研究報(bào)告可行性研究報(bào)告的目的是：說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)條上的可行性，論述為了合理地達(dá)到開(kāi)發(fā)目標(biāo)而可能選擇的各種方案，說(shuō)明并論證所選定的方案。可行性研究報(bào)告的編寫(xiě)內(nèi)容見(jiàn)表l。表l可行性研究報(bào)告1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.可行性研究的前提2.1要求2.2目標(biāo)2.3條件、假定和限制2.4進(jìn)行可行性研究的方法2.5評(píng)價(jià)尺度3.對(duì)現(xiàn)有系統(tǒng)的分析3.1數(shù)據(jù)流程和處理流程3.2工作負(fù)荷3.3消費(fèi)開(kāi)支3.4人員3.5設(shè)備3.6局限性4.所建議的系統(tǒng)4.1對(duì)所建議系統(tǒng)的說(shuō)明4.2數(shù)據(jù)流程和處理流程4.3改進(jìn)之處4.4影響4.4.1對(duì)設(shè)備的影響4.4.2對(duì)軟件的影響4.4.3對(duì)用戶(hù)單位機(jī)構(gòu)的影響4.4.4對(duì)系統(tǒng)運(yùn)行的影響4.4.5對(duì)開(kāi)發(fā)的影響4.4.6對(duì)地點(diǎn)和設(shè)施的影響4.4.7對(duì)經(jīng)費(fèi)開(kāi)支的影響4.5局限性4.6技術(shù)條件方面的可行性5.可選擇的其他系統(tǒng)方案5.1可選擇的系統(tǒng)方案15.2可選擇的系統(tǒng)方案26.投資及收益分析6.1支出6.1.1基本建設(shè)投資6.1.2其他一次性支出6.1.3非一次性支出6.2收益6.2.1一次性收益6.2.2非一次性收益6.2.3不可定量的收益6.3收益/投資比6.4投資回收周期6.5敏感性分析7.社會(huì)條件方面的可行性7.1法律方面的可行性7.2使用方面的可行性8.結(jié)論2、項(xiàng)目開(kāi)發(fā)計(jì)劃編制項(xiàng)目開(kāi)發(fā)計(jì)劃的目的是用文件的形式，并在開(kāi)發(fā)過(guò)程中各項(xiàng)工作的負(fù)責(zé)人員、開(kāi)發(fā)進(jìn)度、經(jīng)費(fèi)預(yù)算、所需軟硬件條件等問(wèn)題做出的安排記錄下來(lái)，以便根據(jù)本計(jì)劃開(kāi)展和檢查項(xiàng)目的開(kāi)發(fā)工作。編制內(nèi)容要求如表2所示。表2項(xiàng)目開(kāi)發(fā)計(jì)劃1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.項(xiàng)目概述2.1工作內(nèi)容2.2主要參加人員2.3產(chǎn)品及成果2.3.1程序2.3.2文件2.3.3服務(wù)2.3.4非移交產(chǎn)品2.4驗(yàn)收標(biāo)準(zhǔn)2.5完成項(xiàng)目的最遲期限2.6本計(jì)劃的審批者與批準(zhǔn)者3.實(shí)施總計(jì)劃3.1工作任務(wù)的分析3.2接口人員3.3進(jìn)度3.4預(yù)算3.5關(guān)鍵問(wèn)題4.支持條件4.1計(jì)算機(jī)統(tǒng)支持4.2需要用戶(hù)承擔(dān)的工作4.3需由外單位提供的條件5.專(zhuān)題計(jì)劃要點(diǎn)3、軟件需求說(shuō)明書(shū)軟件需求說(shuō)明書(shū)的編制是為了使用戶(hù)和軟件開(kāi)發(fā)人員雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解，使之成為整個(gè)軟件開(kāi)發(fā)工作的基礎(chǔ)。其內(nèi)容要求見(jiàn)表3。表3軟件需求說(shuō)明書(shū)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.任務(wù)概述2.1目標(biāo)2.2用戶(hù)的特點(diǎn)2.3假定的約束3.需求規(guī)定3.1對(duì)功能的規(guī)定3.2對(duì)性能的規(guī)定3.2.1精度3.2.2時(shí)間特性要求3.2.3靈活性3.3輸入輸出要求3.4數(shù)據(jù)管理要求3.5故障處理要求3.6其他專(zhuān)門(mén)要求4.運(yùn)行環(huán)境規(guī)定4.1設(shè)備4.2支撐軟件4.3接口4.4控制4、數(shù)據(jù)要求說(shuō)明書(shū)數(shù)據(jù)要求說(shuō)明書(shū)的編制目的是為了向整個(gè)軟件開(kāi)發(fā)時(shí)期提供關(guān)于被處理數(shù)據(jù)的描述和數(shù)據(jù)采集要求的技術(shù)信息，其內(nèi)容要求列于表4中。表4數(shù)據(jù)要求說(shuō)明書(shū)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.數(shù)據(jù)的邏輯描述2.1靜態(tài)數(shù)據(jù)2.2動(dòng)態(tài)輸入數(shù)據(jù)2.3動(dòng)態(tài)輸出數(shù)據(jù)2.4內(nèi)部生成數(shù)據(jù)2.5數(shù)據(jù)約定3.數(shù)據(jù)的采集3.1要求的范圍3.2輸入的承擔(dān)者3.3處理3.4影響5、概要設(shè)計(jì)說(shuō)明書(shū)概要設(shè)計(jì)說(shuō)明書(shū)又稱(chēng)為總體設(shè)計(jì)說(shuō)明書(shū)，編制目的是說(shuō)明對(duì)項(xiàng)目系統(tǒng)的設(shè)計(jì)考慮，包括基本處理流程、組織結(jié)構(gòu)、模塊結(jié)構(gòu)、功能配置、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、系統(tǒng)配置、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。其內(nèi)容要求見(jiàn)表5。表5概要設(shè)計(jì)說(shuō)明書(shū)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.總體設(shè)計(jì)2.1運(yùn)行環(huán)境2.2基本設(shè)計(jì)概念和處理流程2.3結(jié)構(gòu)2.4功能需求與程序的關(guān)系2.5人工處理過(guò)程2.6尚未解決的問(wèn)題3.接口設(shè)計(jì)3.1用戶(hù)接口3.2外部接口3.3內(nèi)部接口4.運(yùn)行設(shè)計(jì)4.1運(yùn)行模塊組合4.2運(yùn)行控制4.3運(yùn)行時(shí)間5.系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)5.3數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)要點(diǎn)6.系統(tǒng)出錯(cuò)處理設(shè)計(jì)6.1出錯(cuò)信息6.2補(bǔ)救措施6.3系統(tǒng)維護(hù)設(shè)計(jì)6、詳細(xì)設(shè)計(jì)說(shuō)明書(shū)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)又稱(chēng)為程序設(shè)計(jì)說(shuō)明，編制目的是說(shuō)明一個(gè)軟件系統(tǒng)各個(gè)層次中的每一個(gè)程序（模塊）的設(shè)計(jì)考慮。如果軟件系統(tǒng)比較簡(jiǎn)單，層次少，本文件可以不單獨(dú)編寫(xiě)，有關(guān)內(nèi)容可并入概要設(shè)計(jì)說(shuō)明書(shū)。詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的內(nèi)容要求見(jiàn)表6。表6詳細(xì)設(shè)計(jì)說(shuō)明書(shū)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.程序系統(tǒng)的組織結(jié)構(gòu)3.程序1（結(jié)構(gòu)符）設(shè)計(jì)說(shuō)明3.1程序描述3.2功能3.3性能3.4輸入項(xiàng)3.5輸出項(xiàng)3.6算法3.7流程邏輯3.8接口3.9存儲(chǔ)分配3.10注釋設(shè)計(jì)3.11限制條件3.12測(cè)試設(shè)計(jì)3.13尚未解決的問(wèn)題4.程序2（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明書(shū)7、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)的編制目的是對(duì)于設(shè)計(jì)中的數(shù)據(jù)的所有標(biāo)識(shí)、邏輯結(jié)表7數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.外部設(shè)計(jì)2.1標(biāo)識(shí)符和狀態(tài)2.2使用它的程序2.3約定2.4專(zhuān)門(mén)指導(dǎo)2.4支撐軟件3.結(jié)構(gòu)設(shè)計(jì)3.1概念結(jié)構(gòu)設(shè)計(jì)3.2邏輯3.3物理結(jié)構(gòu)設(shè)計(jì)4.運(yùn)用設(shè)計(jì)4.1數(shù)據(jù)字典設(shè)計(jì)4.2安全保密設(shè)計(jì)構(gòu)和物理結(jié)構(gòu)做出具體的設(shè)計(jì)規(guī)定。內(nèi)容要求見(jiàn)表7。8、用戶(hù)手冊(cè)用戶(hù)手冊(cè)的編制是使用非專(zhuān)業(yè)術(shù)語(yǔ)的語(yǔ)言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法。使用戶(hù)通過(guò)本手冊(cè)能夠了解該軟件的用途，并能夠確定在什么情況下、如何使用它。具體的內(nèi)容要求見(jiàn)表8。表8用戶(hù)手冊(cè)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.用途2.1功能2.2性能2.2.1精度2.2.2時(shí)間特性2.2.3靈活性3.運(yùn)行環(huán)境3.1硬環(huán)境3.2支撐軟件3.3數(shù)據(jù)結(jié)構(gòu)4.使用過(guò)程4.1安全與初始化4.2輸入4.2.1輸入數(shù)據(jù)的現(xiàn)實(shí)背景4.2.2輸入格式4.2.3輸入舉例4.3輸出4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景4.3.2輸出格式4.3.3輸出舉例4.4文卷查詢(xún)4.5出錯(cuò)處理與恢復(fù)4.6終端操作9、操作手冊(cè)操作手冊(cè)的編制是為了向操作人員提供該軟件每個(gè)運(yùn)行的具體過(guò)程的有關(guān)知識(shí)，包括操作方法的細(xì)節(jié)。內(nèi)容要求見(jiàn)表9。表9操作手冊(cè)1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.軟件概述2.1軟件的結(jié)構(gòu)2.2程序表2.3文卷表3.安裝與初始化4.運(yùn)行說(shuō)明4.1運(yùn)行表4.2運(yùn)行步驟4.3運(yùn)行1(標(biāo)識(shí)符)說(shuō)明4.3.1運(yùn)行控制4.3.2操作信息4.3.3輸出文段4.3.4輸出文段4.3.5輸出文段的復(fù)制4.3.6啟動(dòng)恢復(fù)過(guò)程4.4運(yùn)行2(標(biāo)識(shí)符)說(shuō)明……5.非常規(guī)過(guò)程6.遠(yuǎn)程過(guò)程10、模塊開(kāi)發(fā)卷宗模塊開(kāi)發(fā)卷宗是在模塊開(kāi)發(fā)過(guò)程中逐步編寫(xiě)出來(lái)的。每完成一個(gè)模塊或一組密切相關(guān)的模塊，復(fù)審時(shí)編寫(xiě)出一份，應(yīng)該把所有的模塊開(kāi)發(fā)卷宗匯集在一起。編寫(xiě)的目的是記錄和匯總低層次開(kāi)發(fā)的進(jìn)度和結(jié)果；以便于對(duì)整個(gè)系統(tǒng)開(kāi)發(fā)工作進(jìn)行管理的復(fù)審，并為將來(lái)的維護(hù)提供有用的技術(shù)信息。具體內(nèi)容要求見(jiàn)表10。11、測(cè)試計(jì)劃表10模塊開(kāi)發(fā)卷宗1.標(biāo)題2.模塊開(kāi)發(fā)情況表(見(jiàn)附表S10.10a)3.功能說(shuō)明4.設(shè)計(jì)說(shuō)明5.源代碼清單6.測(cè)試說(shuō)明7.復(fù)審的結(jié)論表10a模塊開(kāi)發(fā)情況表模塊標(biāo)識(shí)符模塊的描述性名稱(chēng)代碼設(shè)計(jì)計(jì)劃開(kāi)始日期實(shí)際開(kāi)始日期計(jì)劃完成日期實(shí)際完成日期模塊測(cè)試計(jì)劃開(kāi)始日期實(shí)際開(kāi)始日期計(jì)劃完成日期實(shí)際完成日期組裝測(cè)試計(jì)劃開(kāi)始日期實(shí)際開(kāi)始日期計(jì)劃完成日期實(shí)際完成日期代碼復(fù)查日期/簽字源代碼行數(shù)目標(biāo)模塊大小項(xiàng)目負(fù)責(zé)人批準(zhǔn)日期/簽字這里所說(shuō)的測(cè)試是指整個(gè)軟件系統(tǒng)的組裝測(cè)試和確認(rèn)測(cè)試，本文件的編制是為了提供一個(gè)對(duì)該軟件的測(cè)試計(jì)劃，包括對(duì)每項(xiàng)測(cè)試活動(dòng)的內(nèi)容、進(jìn)度安排、設(shè)計(jì)考慮、測(cè)試數(shù)據(jù)的整體性方法及評(píng)價(jià)準(zhǔn)則。具體內(nèi)容見(jiàn)表11。表11測(cè)試計(jì)劃1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.計(jì)劃2.1軟件說(shuō)明2.2測(cè)試內(nèi)容2.3測(cè)試1(標(biāo)識(shí)符)2.3.1進(jìn)度安排2.3.2條件2.3.3測(cè)試資料2.3.4測(cè)試培訓(xùn)2.4測(cè)試2(標(biāo)識(shí)符)……3.測(cè)試設(shè)計(jì)說(shuō)明3.1測(cè)試1(標(biāo)識(shí)符)3.1.1控制3.1.2輸入3.1.3輸出3.1.4過(guò)程3.2測(cè)試2(標(biāo)識(shí)符)……4.評(píng)價(jià)準(zhǔn)則4.1范圍4.2數(shù)據(jù)整理4.3尺度12、測(cè)試分析報(bào)告測(cè)試分析報(bào)告的編寫(xiě)是為了把組裝測(cè)試和確認(rèn)測(cè)試的結(jié)果、發(fā)現(xiàn)的問(wèn)題以及分析結(jié)果寫(xiě)出成文件形式加以保存，具體編寫(xiě)內(nèi)容要求見(jiàn)表12。表12測(cè)試分析報(bào)告1.引言1.1編寫(xiě)目的1.2背景1.3定義1.4參考資料2.測(cè)試概要3.測(cè)試結(jié)果及發(fā)現(xiàn)3.1測(cè)試1(標(biāo)識(shí)符)3.2測(cè)試2(標(biāo)識(shí)符)……4.對(duì)軟件功能的結(jié)論4.1功能1(標(biāo)識(shí)符)4.1.1能力4.1.2限制4.2功能2(標(biāo)識(shí)符)……5.分析摘要5.1能力5.2缺陷和限制5.3建議5.4評(píng)價(jià)6.測(cè)試資源消耗13、開(kāi)發(fā)進(jìn)度月報(bào)開(kāi)發(fā)進(jìn)度月報(bào)的編制目的是及時(shí)向有關(guān)管理部匯報(bào)項(xiàng)目開(kāi)發(fā)的進(jìn)度和情況,以便及時(shí)發(fā)現(xiàn)和處理開(kāi)發(fā)過(guò)程中出現(xiàn)的問(wèn)題。一般來(lái)說(shuō)，開(kāi)發(fā)進(jìn)度月報(bào)是以項(xiàng)目組為單位每月編寫(xiě)的，具體內(nèi)容要求見(jiàn)表13。表13開(kāi)發(fā)進(jìn)度月報(bào)1.標(biāo)題2.工程進(jìn)度與狀態(tài)2.1進(jìn)度2.2態(tài)度3.資源耗用與狀態(tài)3.1資源耗用3.1.1工時(shí)3.1.2機(jī)時(shí)3.2狀態(tài)4.經(jīng)費(fèi)支出與狀態(tài)4.1經(jīng)費(fèi)支出4.1.1支出性費(fèi)用4.1.2設(shè)備購(gòu)置費(fèi)4.2狀態(tài)5.下個(gè)月的工作計(jì)劃6.建議14、項(xiàng)目