軟件開(kāi)發(fā)文檔模板-軟件產(chǎn)品開(kāi)發(fā)文件編制指南

〔產(chǎn)品治理〕軟件開(kāi)發(fā)文檔模板-軟件產(chǎn)品開(kāi)發(fā)文件編制指南〔產(chǎn)品治理〕軟件開(kāi)發(fā)文檔模板-軟件產(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è)文件：可行性爭(zhēng)論方案、工程開(kāi)發(fā)打算、軟件需求說(shuō)明書(shū)、數(shù)據(jù)要求說(shuō)明書(shū)、總體設(shè)計(jì)說(shuō)明書(shū)、具體設(shè)計(jì)說(shuō)明、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)、用戶手冊(cè)、操作手冊(cè)、模塊開(kāi)發(fā)卷、測(cè)試打算、測(cè)試分析方案、開(kāi)發(fā)進(jìn)度表、工程開(kāi)發(fā)總結(jié)。該指南給出了這14個(gè)文件的編制提示，它同時(shí)也是這14個(gè)文件編寫(xiě)質(zhì)量的檢驗(yàn)準(zhǔn)則。下面具體介紹這14種文件的編寫(xiě)目的和內(nèi)容要求。l、可行性爭(zhēng)論方案可行性爭(zhēng)論方案的目的是：說(shuō)明該軟件開(kāi)發(fā)工程的實(shí)當(dāng)下技術(shù)上、經(jīng)濟(jì)上和社會(huì)條上的可行性，論述為了合理地到達(dá)開(kāi)發(fā)目標(biāo)而可能選擇的各種方案，說(shuō)明且論證所選定的方案。可行性爭(zhēng)論方案的編寫(xiě)內(nèi)容見(jiàn)表l。表l可行性爭(zhēng)論方案1.引言編寫(xiě)目的背景定義參考資料可行性爭(zhēng)論的前提要求目標(biāo)條件、假定和限制進(jìn)展可行性爭(zhēng)論的方法評(píng)價(jià)尺度對(duì)現(xiàn)有系統(tǒng)的分析數(shù)據(jù)流程和處理流程工作負(fù)荷消費(fèi)開(kāi)支人員設(shè)備局限性所建議的系統(tǒng)對(duì)所建議系統(tǒng)的說(shuō)明數(shù)據(jù)流程和處理流程改進(jìn)之處影響對(duì)設(shè)備的影響對(duì)軟件的影響對(duì)用戶單位機(jī)構(gòu)的影響,4.4.4對(duì)系統(tǒng)運(yùn)行的影響4.4.5對(duì)開(kāi)發(fā)的影響對(duì)地點(diǎn)和設(shè)施的影響對(duì)經(jīng)費(fèi)開(kāi)支的影響局限性技術(shù)條件方面的可行性5.可選擇的其他系統(tǒng)方案可選擇的系統(tǒng)方案1可選擇的系統(tǒng)方案26.投資及收益分析支出根本建設(shè)投資其他壹次性支出非壹次性支出收益壹次性收益非壹次性收益不行定量的收益收益/投資比投資回收周期敏感性分析社會(huì)條件方面的可行性法律方面的可行性使用方面的可行性8.結(jié)論2、工程開(kāi)發(fā)打算編制工程開(kāi)發(fā)打算的目的是用文件的形式，且于開(kāi)發(fā)過(guò)程中各項(xiàng)工作的負(fù)責(zé)人員、開(kāi)發(fā)進(jìn)度、經(jīng)費(fèi)預(yù)算、所需軟硬件條件等問(wèn)題做出的安排記錄下來(lái)，以便依據(jù)本打算開(kāi)展和檢查工程的開(kāi)發(fā)工作。編制221.引言編寫(xiě)目的背景定義參考資料2.工程概述工作內(nèi)容主要參與人員產(chǎn)品及成果程序文件效勞非移交產(chǎn)品驗(yàn)收標(biāo)準(zhǔn),2.5完成工程的最遲期限2.6實(shí)施總打算工作任務(wù)的分析接口人員進(jìn)度預(yù)算關(guān)鍵問(wèn)題4.支持條件計(jì)算機(jī)統(tǒng)支持需要用戶擔(dān)當(dāng)?shù)墓ぷ餍栌赏鈫挝还┙o的條件5.專(zhuān)題打算要點(diǎn)3、軟件需求說(shuō)明書(shū)軟件需求說(shuō)明書(shū)的編制是為了使用戶和軟件開(kāi)發(fā)人員雙方對(duì)該軟件的初始規(guī)定有壹個(gè)共同的理解，使之成為整個(gè)軟件開(kāi)發(fā)工作的根底。3。表3軟件需求說(shuō)明書(shū)1.引言編寫(xiě)目的背景定義參考資料2.任務(wù)概述目標(biāo)用戶的特點(diǎn)假定的約束3.需求規(guī)定對(duì)功能的規(guī)定對(duì)性能的規(guī)定,3.2.1精度時(shí)間特性要求敏捷性輸入輸出要求數(shù)據(jù)治理要求故障處理要求其他特地要求4.運(yùn)行環(huán)境規(guī)定設(shè)備支撐軟件接口掌握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.引言編寫(xiě)目的背景定義參考資料數(shù)據(jù)的規(guī)律描述靜態(tài)數(shù)據(jù)動(dòng)態(tài)輸入數(shù)據(jù),2.3動(dòng)態(tài)輸出數(shù)據(jù)內(nèi)部生成數(shù)據(jù)數(shù)據(jù)商定3.數(shù)據(jù)的采集要求的范圍輸入的擔(dān)當(dāng)者處理影響5、概要設(shè)計(jì)說(shuō)明書(shū)概要設(shè)計(jì)說(shuō)明書(shū)又稱(chēng)為總體設(shè)計(jì)說(shuō)明書(shū)，編制目的是說(shuō)明對(duì)工程系統(tǒng)的設(shè)計(jì)考慮，包括根本處理流程、組織構(gòu)造、模塊構(gòu)造、功能配置、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、系統(tǒng)配置、數(shù)據(jù)構(gòu)造設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為程序的具體設(shè)計(jì)供給根底。其內(nèi)容要求見(jiàn)表5。表5概要設(shè)計(jì)說(shuō)明書(shū)1.引言編寫(xiě)目的背景定義參考資料2.總體設(shè)計(jì)運(yùn)行環(huán)境根本設(shè)計(jì)概念和處理流程構(gòu)造功能需求和程序的關(guān)系人工處理過(guò)程尚未解決的問(wèn)題3.接口設(shè)計(jì)3.1,3.23.34.運(yùn)行設(shè)計(jì)運(yùn)行模塊組合運(yùn)行掌握運(yùn)行時(shí)間系統(tǒng)數(shù)據(jù)構(gòu)造設(shè)計(jì)規(guī)律構(gòu)造設(shè)計(jì)要點(diǎn)物理構(gòu)造設(shè)計(jì)要點(diǎn)數(shù)據(jù)構(gòu)造設(shè)計(jì)要點(diǎn)6.系統(tǒng)出錯(cuò)處理設(shè)計(jì)出錯(cuò)信息補(bǔ)救措施系統(tǒng)維護(hù)設(shè)計(jì)6、具體設(shè)計(jì)說(shuō)明書(shū)具體設(shè)計(jì)說(shuō)明書(shū)又稱(chēng)為程序設(shè)計(jì)說(shuō)明，編制目的是說(shuō)明壹個(gè)軟件系統(tǒng)各個(gè)層次中的每壹個(gè)程序〔模塊〕的設(shè)計(jì)考慮。假設(shè)軟件系統(tǒng)比較簡(jiǎn)潔，層次少，本文件能夠不單獨(dú)編寫(xiě)，有關(guān)內(nèi)容可且入概要設(shè)計(jì)6。表6具體設(shè)計(jì)說(shuō)明書(shū)1.引言編寫(xiě)目的背景定義參考資料程序系統(tǒng)的組織構(gòu)造程序1〔構(gòu)造符〕設(shè)計(jì)說(shuō)明程序描述功能性能輸入項(xiàng),3.5輸出項(xiàng)算法流程規(guī)律接口存儲(chǔ)安排注釋設(shè)計(jì)限制條件測(cè)試設(shè)計(jì)尚未解決的問(wèn)題程序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í)、規(guī)律結(jié)表7數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)1.引言編寫(xiě)目的背景定義參考資料2.外部設(shè)計(jì)標(biāo)識(shí)符和狀態(tài)使用它的程序商定,2.4特地指導(dǎo)支撐軟件3.構(gòu)造設(shè)計(jì)概念構(gòu)造設(shè)計(jì)規(guī)律物理構(gòu)造設(shè)計(jì)4.運(yùn)用設(shè)計(jì)數(shù)據(jù)字典設(shè)計(jì)安全保密設(shè)計(jì)構(gòu)和物理構(gòu)造做出具體的設(shè)計(jì)規(guī)定。內(nèi)容要求見(jiàn)表7。8、用戶手冊(cè)用戶手冊(cè)的編制是使用非專(zhuān)業(yè)術(shù)語(yǔ)的語(yǔ)言，充分地描述該軟件系統(tǒng)所具有的功能及根本的使用方法。使用戶通過(guò)本手冊(cè)能夠了解該軟件的用途，且能夠確定于什么狀況下、如何使用它。具體的內(nèi)容要求8。81.引言編寫(xiě)目的背景定義參考資料2.用途功能性能精度時(shí)間特性敏捷性3.運(yùn)行環(huán)境硬環(huán)境支撐軟件,3.3數(shù)據(jù)構(gòu)造4.使用過(guò)程安全和初始化輸入輸入數(shù)據(jù)的現(xiàn)實(shí)背景輸入格式輸入舉例輸出輸出數(shù)據(jù)的現(xiàn)實(shí)背景輸出格式輸出舉例文卷查詢出錯(cuò)處理和恢復(fù)終端操作9、操作手冊(cè)操作手冊(cè)的編制是為了向操作人員供給當(dāng)軟件每個(gè)運(yùn)行的具體過(guò)程的有關(guān)學(xué)問(wèn)，包括操作方法的細(xì)節(jié)。內(nèi)容要求見(jiàn)表9。91.引言編寫(xiě)目的背景定義參考資料2.軟件概述軟件的構(gòu)造程序表文卷表安裝和初始化運(yùn)行說(shuō)明運(yùn)行表,4.2運(yùn)行步驟運(yùn)行1(標(biāo)識(shí)符)說(shuō)明運(yùn)行掌握操作信息輸出文段輸出文段輸出文段的復(fù)制啟動(dòng)恢復(fù)過(guò)程運(yùn)行2(標(biāo)識(shí)符)說(shuō)明……格外規(guī)過(guò)程遠(yuǎn)程過(guò)程10、模塊開(kāi)發(fā)卷宗模塊開(kāi)發(fā)卷宗是于模塊開(kāi)發(fā)過(guò)程中逐步編寫(xiě)出來(lái)的。每完成壹個(gè)模塊或壹組親熱關(guān)聯(lián)的模塊，復(fù)審時(shí)編寫(xiě)出壹份，應(yīng)當(dāng)把全部的模塊開(kāi)發(fā)卷宗集合于壹起。編寫(xiě)的目的是記錄和匯總低層次開(kāi)發(fā)的進(jìn)度和結(jié)果；以便于對(duì)整個(gè)系統(tǒng)開(kāi)發(fā)工作進(jìn)展治理的復(fù)審，且為將來(lái)的維護(hù)10。11、測(cè)試打算表101.標(biāo)題模塊開(kāi)發(fā)狀況表(見(jiàn)附表S10.10a)功能說(shuō)明設(shè)計(jì)說(shuō)明,源代碼清單測(cè)試說(shuō)明復(fù)審的結(jié)論表10a模塊開(kāi)發(fā)狀況表模塊標(biāo)識(shí)符,,,模塊的描述性名稱(chēng),,,代碼設(shè)計(jì),打算開(kāi)頭日期,,,,實(shí)際開(kāi)頭日期,,,,打算完成日期,,,,實(shí)際完成日期,,,模塊測(cè)試,打算開(kāi)頭日期,,,,實(shí)際開(kāi)頭日期,,,,打算完成日期,,,,實(shí)際完成日期,,,組裝測(cè)試,打算開(kāi)頭日期,,,,實(shí)際開(kāi)頭日期,,,,打算完成日期,,,,實(shí)際完成日期,,,代碼復(fù)查日期/簽字,,,源代碼行數(shù),,,,,,,,目標(biāo)模塊大小,,,,,,,,工程負(fù)責(zé)人批準(zhǔn)日期/簽字,,,這里所說(shuō)的測(cè)試是指整個(gè)軟件系統(tǒng)的組裝測(cè)試和確認(rèn)測(cè)試，本文件的編制是為了供給壹個(gè)對(duì)該軟件的測(cè)試打算，包括對(duì)每項(xiàng)測(cè)試活動(dòng)的內(nèi)容、進(jìn)度安排、設(shè)計(jì)考慮、測(cè)試數(shù)據(jù)的整體性方法及評(píng)價(jià)準(zhǔn)則。11。111.引言編寫(xiě)目的背景定義參考資料2.打算軟件說(shuō)明測(cè)試內(nèi)容測(cè)試1(標(biāo)識(shí)符)進(jìn)度安排條件測(cè)試資料測(cè)試培訓(xùn),2.4測(cè)試2(標(biāo)識(shí)符)……測(cè)試設(shè)計(jì)說(shuō)明測(cè)試1(標(biāo)識(shí)符)掌握輸入輸出過(guò)程測(cè)試2(標(biāo)識(shí)符)……評(píng)價(jià)準(zhǔn)則范圍數(shù)據(jù)整理尺度12、測(cè)試分析方案測(cè)試分析方案的編寫(xiě)是為了把組裝測(cè)試和確認(rèn)測(cè)試的結(jié)果、覺(jué)察的問(wèn)題以及分析結(jié)果寫(xiě)出成文件形式加以保存，具體編寫(xiě)內(nèi)容要求見(jiàn)12。表121.引言編寫(xiě)目的背景定義參考資料2.測(cè)試概要測(cè)試結(jié)果及覺(jué)察測(cè)試1(標(biāo)識(shí)符)測(cè)試2(標(biāo)識(shí)符)……對(duì)軟件功能的結(jié)論,4.1功能1(標(biāo)識(shí)符)力量限制4.22(標(biāo)識(shí)符)……分析摘要力量缺陷和限制建議評(píng)價(jià)測(cè)試資源消耗13、開(kāi)發(fā)進(jìn)度月報(bào)開(kāi)發(fā)進(jìn)度月報(bào)的編制目的是準(zhǔn)時(shí)向有關(guān)治理部匯報(bào)工程開(kāi)發(fā)的進(jìn)度和狀況,以便準(zhǔn)時(shí)覺(jué)察和處理開(kāi)發(fā)過(guò)程中消滅的問(wèn)題。壹般來(lái)說(shuō)，開(kāi)發(fā)進(jìn)度月報(bào)是以工程組為單位每月編寫(xiě)的，具體內(nèi)容要求見(jiàn)表13。表131.標(biāo)題工程進(jìn)度和狀態(tài)進(jìn)度態(tài)度資源耗用和狀態(tài)資源耗用工時(shí)機(jī)時(shí),3.2狀態(tài)4.經(jīng)費(fèi)支出和狀態(tài)經(jīng)費(fèi)支出支出性費(fèi)用設(shè)備購(gòu)置費(fèi)狀態(tài)下個(gè)月的工作打算