計算機軟件產(chǎn)品開發(fā)文件編制指南

1、附錄五國家標(biāo)準(zhǔn)計算機軟件產(chǎn)品開發(fā)文件編制指南國家標(biāo)準(zhǔn)計算機軟件產(chǎn)品開發(fā)文件編制指南(GB856788)是一份指導(dǎo)性文件。它建議在軟件的開發(fā)過程申編下述14個文件：可行性研究報告、項目開發(fā)計劃、軟件需求說明書、數(shù)據(jù)要求說明書、總體設(shè)計說明書、詳細(xì)設(shè)計說明、數(shù)據(jù)庫設(shè)計說明書、用戶手冊、操作手冊、模塊開發(fā)卷、測試計劃、測試分析報告、開發(fā)進(jìn)度表、項目開發(fā)總結(jié)。該指南給出了這14個文件的編制提示，它同時也是這14個文件編寫質(zhì)量的檢驗準(zhǔn)則。下面詳細(xì)介紹這14種文件的編寫目的與內(nèi)容要求。l、可行性研究報告可行性研究報告的目的是：說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)上、經(jīng)濟上和社會條上的可行性，論述為了合理地達(dá)到開

2、發(fā)目標(biāo)而可能選擇的各種方案，說明并論證所選定的方案?？尚行匝芯繄蟾娴木帉憙?nèi)容見表l。表l可行性研究報告對現(xiàn)有系統(tǒng)的分析數(shù)據(jù)流程和處理流程工作負(fù)荷消費開支人員1 .引言編寫目的背景定義參考資料2 .可行性研究的前提要求目標(biāo)條件、假定和限制進(jìn)行可行性研究的方法評價尺度3 .對系統(tǒng)運行的影響對開發(fā)的影響對地點和設(shè)施的影響對經(jīng)費開支的影響局限性技術(shù)條件方面的可行性5 .可選擇的其他系統(tǒng)方案可選擇的系統(tǒng)方案1可選擇的系統(tǒng)方案26 .投資及收益分析支出基本建設(shè)投資其他一次性支出非一次性支出收益一次性收益設(shè)備局限性4.所建議的系統(tǒng)對所建議系統(tǒng)的說明數(shù)據(jù)流程和處理流程改進(jìn)之處影響對設(shè)備的影響對軟件的影響對用戶

3、單位機構(gòu)的影響2、項目開發(fā)計劃非一次性收益不可定量的收益收益/投資比投資回收周期敏感性分析7 .社會條件方面的可行性法律方面的可行性使用方面的可行性8 .結(jié)論編制項目開發(fā)計劃的目的是用文件的形式，并在開發(fā)過程中各項工作的負(fù)責(zé)人員、開發(fā)進(jìn)度、經(jīng)費預(yù)算、所需軟硬件條件等問題做出的安排記錄下來，以便根據(jù)本計劃開展和檢查項目的開發(fā)工作。編制內(nèi)容要求如表2所示。表2項目開發(fā)計劃1 .引言編寫目的背景定義參考資料2 .項目概述工作內(nèi)容主要參加人員產(chǎn)品及成果程序文件服務(wù)非移交產(chǎn)品驗收標(biāo)準(zhǔn)3、軟件需求說明書完成項目的最遲期限本計劃的審批者與批準(zhǔn)者3 .實施總計劃工作任務(wù)的分析接口人員進(jìn)度預(yù)算關(guān)鍵問題4 .支持

4、條件計算機統(tǒng)支持需要用戶承擔(dān)的工作需由外單位提供的條件5 .專題計劃要點軟件需求說明書的編制是為了使用戶和軟件開發(fā)人員雙方對該軟件的初始規(guī)定有一個共同的理解，使之成為整個軟件開發(fā)工作的基礎(chǔ)。其內(nèi)容要求見表3表3軟件需求說明書1 .引言編寫目的背景定義參考資料2 .任務(wù)概述目標(biāo)用戶的特點假定的約束3 .需求規(guī)定對功能的規(guī)定對性能的規(guī)定精度時間特性要求靈活性輸入輸出要求數(shù)據(jù)管理要求故障處理要求其他專門要求4 .運行環(huán)境規(guī)定設(shè)備支撐軟件接口控制4、數(shù)據(jù)要求說明書數(shù)據(jù)要求說明書的編制目的是為了向整個軟件開發(fā)時期提供關(guān)于被處理數(shù)據(jù)的描述和數(shù)據(jù)采集要求的技術(shù)信息，其內(nèi)容要求列于表4中。表4數(shù)據(jù)要求說明書1

5、 .引言編寫目的背景定義參考資料2 .數(shù)據(jù)的邏輯描述靜態(tài)數(shù)據(jù)動態(tài)輸入數(shù)據(jù)動態(tài)輸出數(shù)據(jù)內(nèi)部生成數(shù)據(jù)數(shù)據(jù)約定3.數(shù)據(jù)的采集要求的范圍輸入的承擔(dān)者處理影響5、概要設(shè)計說明書概要設(shè)計說明書又稱為總體設(shè)計說明書，編制目的是說明對項目系統(tǒng)的設(shè)計考慮，包括基本處理流程、組織結(jié)構(gòu)、模塊結(jié)構(gòu)、功能配置、接口設(shè)計、運行設(shè)計、系統(tǒng)配置、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為程序的詳細(xì)設(shè)計提供基礎(chǔ)。其內(nèi)容要求見表5表5概要設(shè)計說明書1 .引言編寫目的背景定義參考資料2 .總體設(shè)計運行環(huán)境基本設(shè)計概念和處理流程結(jié)構(gòu)功能需求與程序的關(guān)系人工處理過程外部接口內(nèi)部接口4 .運行設(shè)計運行模塊組合運行控制運行時間5 .系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計

6、邏輯結(jié)構(gòu)設(shè)計要點物理結(jié)構(gòu)設(shè)計要點數(shù)據(jù)結(jié)構(gòu)設(shè)計要點6 .系統(tǒng)出錯處理設(shè)計出錯信息尚未解決的問題3.接口設(shè)計用戶接口補救措施系統(tǒng)維護(hù)設(shè)計6、詳細(xì)設(shè)計說明書詳細(xì)設(shè)計說明書又稱為程序設(shè)計說明，編制目的是說明一個軟件系統(tǒng)各個層次中的每一個程序（模塊）的設(shè)計考慮。如果軟件系統(tǒng)比較簡單，層次少，本文件可以不單獨編寫，有關(guān)內(nèi)容可并入概要設(shè)計說明書。詳細(xì)設(shè)計說明書的內(nèi)容要求見表6。表6詳細(xì)設(shè)計說明書1 .引言編寫目的背景定義參考資料2 .程序系統(tǒng)的組織結(jié)構(gòu)3 .程序1（結(jié)構(gòu)符）設(shè)計說明輸出項算法流程邏輯接口存儲分配注釋設(shè)計限制條件程序描述功能性能輸入項測試設(shè)計尚未解決的問題4.程序2（標(biāo)識符）設(shè)計說明書7、數(shù)據(jù)

7、庫設(shè)計說明書數(shù)據(jù)庫設(shè)計說明書的編制目的是對于設(shè)計中的數(shù)據(jù)的所有標(biāo)識、邏輯結(jié)表7數(shù)據(jù)庫設(shè)計說明書1 .引言編寫目的背景定義參考資料2 .外部設(shè)計標(biāo)識符和狀態(tài)專門指導(dǎo)支撐軟件3 .結(jié)構(gòu)設(shè)計概念結(jié)構(gòu)設(shè)計邏輯物理結(jié)構(gòu)設(shè)計4 .運用設(shè)計使用它的程序數(shù)據(jù)字典設(shè)計安全保密設(shè)計構(gòu)和物理結(jié)構(gòu)做出具體的設(shè)計規(guī)定。內(nèi)容要求見表78、用戶手冊用戶手冊的編制是使用非專業(yè)術(shù)語的語言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法。使用戶通過本手冊能夠了解該軟件的用途，并能夠確定在什么情況下、如何使用它。具體的內(nèi)容要求見表8。表8用戶手冊1 .引言編寫目的背景定義參考資料2 .用途數(shù)據(jù)結(jié)構(gòu)4.使用過程安全與初始化輸入輸入

8、數(shù)據(jù)的現(xiàn)實背景輸入格式功能性能精度時間特性靈活性3.運行環(huán)境硬環(huán)境支撐軟件輸入舉例輸出輸出數(shù)據(jù)的現(xiàn)實背景輸出格式輸出舉例文卷查詢出錯處理與恢復(fù)終端操作9、操作手冊操作手冊的編制是為了向操作人員提供該軟件每個運行的具體過程的有關(guān)知識，包括操作方法的細(xì)節(jié)。內(nèi)容要求見表9。表9操作手冊1.引言編寫目的背景運行步驟運行1（標(biāo)識符）說明運行控制定義參考資料2 .軟件概述軟件的結(jié)構(gòu)程序表文卷表3 .安裝與初始化4 .運行說明操作信息輸出文段輸出文段輸出文段的復(fù)制啟動恢復(fù)過程運行2（標(biāo)識符）說明5 .非常規(guī)過程6 .遠(yuǎn)程過程運行表10、模塊開發(fā)卷宗模塊開發(fā)卷宗是在模塊開發(fā)過程中逐步編寫出來的。每完成一個模塊

9、或一組密切相關(guān)的模塊，復(fù)審時編寫出一份，應(yīng)該把所有的模塊開發(fā)卷宗匯集在一起。編寫的目的是記錄和匯總低層次開發(fā)的進(jìn)度和結(jié)果；以便于對整個系統(tǒng)開發(fā)工作進(jìn)行管理的復(fù)審，并為將來的維護(hù)提供有用的技術(shù)信息。具體內(nèi)容要求見表10。11、測試計劃表10模塊開發(fā)卷宗1 .標(biāo)題2 .模塊開發(fā)情況表(見附表3 .功能說明4 .設(shè)計說明5 .源代碼清單6 .測試說明7 .復(fù)審的結(jié)論表10a模塊開發(fā)情況表梢竹檸；口竹伙從“小Tz、小J古比，七AAt士此24,回大74N吳子代碼口:jn出也I工個4小"Jir|ttn甘R-口XU)又口口助寸T-17T力Zx甘口頭環(huán)川如口期“劃兀欣國現(xiàn)17t-4Ir甘口0Cv模塊

10、頭網(wǎng)、Fr元阪口坳川人U乂口刈寸*r-inrr力Z甘口頭伽、”如日期、1.41-74LT廿口“劃兀欣口期17一、r44-rt惻M組裝、Ff兀歐口煙“乂U刀以口口坳6a|7一nnr4rA1t+Hl頭際開始日期、rr、tj-t_rxi_r"rtn知兀歐口煙測皿頭團(tuán)、r-r兀成日期1q嗎旻宜口源代碼行數(shù)期/簽十曰懷俁吠大小八.tXLw.Ui、項目負(fù)責(zé)人批準(zhǔn)日期/簽字這里所說的測試是指整個軟件系統(tǒng)的組裝測試和確認(rèn)測試，本文件的編制是為了提供一個對該軟件的測試計戈h包括對每項測試活動的內(nèi)容、進(jìn)度安排、設(shè)計考慮、測試數(shù)據(jù)的整體性方法及評價準(zhǔn)則。具體內(nèi)容見表11。表11測試計劃1 .引言編寫目的背

11、景定義參考資料2 .計劃軟件說明測試內(nèi)容測試1（標(biāo)識符）進(jìn)度安排測試2（標(biāo)識符）3.測試設(shè)計說明測試1（標(biāo)識符）控制輸入輸出過程測試2（標(biāo)識符）條件測試資料測試培訓(xùn)4.評價準(zhǔn)則范圍數(shù)據(jù)整理尺度12、測試分析報告測試分析報告的編寫是為了把組裝測試和確認(rèn)測試的結(jié)果、發(fā)現(xiàn)的問題以及分析結(jié)果寫出成文件形式加以保存，具體編寫內(nèi)容要求見表12。表12測試分析報告1 .引言編寫目的背景定義參考資料2 .測試概要功能1（標(biāo)識符）能力限制功能2（標(biāo)識符）5.分析摘要3 .測試結(jié)果及發(fā)現(xiàn)測試1（標(biāo)識符）測試2（標(biāo)識符）4 .對軟件功能的結(jié)論能力缺陷和限制建議評價6.測試資源消耗13、開發(fā)進(jìn)度月報開發(fā)進(jìn)度月報的編制目的是及時向有關(guān)管理部匯報項目開發(fā)的進(jìn)度和情況，以便及時發(fā)現(xiàn)和處理開發(fā)過程中出現(xiàn)的問題。一般來說，開發(fā)進(jìn)度月報是以項目組為單位每月編寫的，具體內(nèi)容要求見表13。表13開發(fā)進(jìn)度月報1 .標(biāo)題2 .工程進(jìn)度與狀態(tài)進(jìn)度態(tài)度狀態(tài)4.經(jīng)費支出與狀態(tài)經(jīng)費支出支出性費用3.資源耗用與狀態(tài)資源耗用工時機時設(shè)備購置費狀態(tài)5 .下個月的工作計