資源描述:
《《軟件文檔及其組成》PPT課件》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、23七月20211軟件文檔與標(biāo)準(zhǔn)徐承志第2章軟件文檔及其組成223七月2021關(guān)于軟件文檔要說(shuō)的話文檔對(duì)于工程的意義軟件工程是針對(duì)大型系統(tǒng)開發(fā)的,是多人開發(fā)和團(tuán)隊(duì)合作,因此文檔是相互交流的重要且必須的媒介。文檔的媒介形式可以多種多樣文檔的重要性文檔編寫工作與代碼編寫工作同等重要。技術(shù)人員對(duì)文檔人員的偏見(jiàn)有了完整的文檔系統(tǒng)可以復(fù)現(xiàn)和維護(hù),而只有代碼則不行。文檔編寫的難度文檔是給人看的(試想高中寫作文,每年寫申請(qǐng)書),代碼是給機(jī)器看的。讓學(xué)生選擇寫文檔還是寫代碼軟件工程的終極目標(biāo),文檔既能被人看又能被機(jī)器理解。323七月2021課程介紹主要內(nèi)容文檔分類1、2章內(nèi)
2、容順序調(diào)整一下標(biāo)準(zhǔn)化的概念軟件文檔的國(guó)標(biāo)寫作要求軟件開發(fā)文檔可行性報(bào)告、需求文檔、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)軟件管理文檔開發(fā)計(jì)劃、測(cè)試計(jì)劃和測(cè)試報(bào)告、進(jìn)度報(bào)告、總結(jié)報(bào)告軟件用戶文檔軟件文檔管理雖然沒(méi)有實(shí)驗(yàn),但是要完成課堂作業(yè)(準(zhǔn)備練習(xí)本)423七月20212.1軟件文檔的概念2.1.1為什么需要文檔文檔是計(jì)算機(jī)軟件產(chǎn)品的重要組成部分,沒(méi)有文檔就不成其為軟件,也更不能成為軟件產(chǎn)品。軟件文檔是一種重要的軟件工程技術(shù)資料。如系統(tǒng)分析文檔、設(shè)計(jì)文檔、版本說(shuō)明文檔……軟件文檔的規(guī)范編制,在軟件開發(fā)工作中占有突出的地位和相當(dāng)大的工作量。高質(zhì)量、高效率的編制、分發(fā)、管理、維護(hù)文檔
3、,及時(shí)的變更、修正、擴(kuò)充和使用文檔,對(duì)于軟件產(chǎn)品的設(shè)計(jì)開發(fā)、發(fā)行使用、變更維護(hù)、轉(zhuǎn)讓移植、二次開發(fā)等,對(duì)于充分發(fā)揮軟件產(chǎn)品的效益,都有著重要的意義。523七月20212.1軟件文檔的概念2.1.2軟件文檔的定義軟件文檔寫作是為了記錄目標(biāo)系統(tǒng)的定義、規(guī)劃、分析、研究、設(shè)計(jì)、開發(fā)、應(yīng)用等各個(gè)階段的設(shè)計(jì)思想和研究成果。文檔——某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。文檔具有永久性,并可供人或機(jī)器閱讀,通常指專供人閱讀的東西。文檔作為計(jì)算機(jī)軟件的重要組成部分,告訴用戶如何操作和維護(hù)系統(tǒng),提供關(guān)于未來(lái)改進(jìn)和重新實(shí)施所需的信息,在開發(fā)人員、維護(hù)人員、管理人員、用戶與計(jì)算機(jī)之間起
4、著重要的橋梁作用。623七月20212.1軟件文檔的概念文檔的橋梁作用維護(hù)人員管理人員計(jì)算機(jī)軟件用戶橋梁作用開發(fā)人員723七月20212.2軟件文檔的作用1.項(xiàng)目管理的依據(jù)文檔將通?!安豢梢?jiàn)的”軟件開發(fā)進(jìn)程轉(zhuǎn)換成“可見(jiàn)的”文字資料,有利于項(xiàng)目的管理。“有據(jù)可查”2.技術(shù)交流的語(yǔ)言項(xiàng)目小組內(nèi)部、項(xiàng)目平行開發(fā)的各小組之間進(jìn)行的交流和聯(lián)系,通常都是通過(guò)文檔來(lái)實(shí)現(xiàn)的。3.項(xiàng)目質(zhì)量保證文檔是進(jìn)行項(xiàng)目質(zhì)量審查和評(píng)價(jià)的重要依據(jù),有效文檔的提供,可以滿足項(xiàng)目質(zhì)量保證人員和審查人員的工作需要。823七月20212.2軟件文檔的作用4.支持培訓(xùn)與維護(hù)合格的軟件文檔通常都提供有關(guān)
5、軟件運(yùn)行、維護(hù)和培訓(xùn)的必要信息,支持軟件產(chǎn)品的應(yīng)用和維護(hù)。5.支持軟件維護(hù)軟件文檔提供系統(tǒng)開發(fā)的全部必要技術(shù)資料,有利于維護(hù)人員熟悉系統(tǒng),開展維護(hù)工作;軟件維護(hù)文檔記載了軟件維護(hù)過(guò)程中軟件及其環(huán)境變化的全部信息。6.記載軟件歷史軟件文檔作為“記載軟件歷史的語(yǔ)言”,可用作未來(lái)項(xiàng)目的一種資源,向潛在用戶報(bào)道軟件的各種有利信息,便于他們判斷自己是否需要該軟件提供的服務(wù)。良好的系統(tǒng)文檔,顯然有助于完成軟件的移植,或?qū)④浖D(zhuǎn)移到各種新的系統(tǒng)環(huán)境中去。923七月20212.3軟件文檔的分類從形式上上將軟件文檔大致分成兩類:軟件開發(fā)過(guò)程中需要填寫的各種圖表編制的各種技術(shù)文
6、件或管理資料根據(jù)其產(chǎn)生和使用的范圍主要?jiǎng)澐譃槿悾洪_發(fā)文檔用戶文檔管理文檔。1023七月2021軟件文檔開發(fā)文檔用戶文檔管理文檔可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說(shuō)明書數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書概要設(shè)計(jì)說(shuō)明書詳細(xì)設(shè)計(jì)說(shuō)明書用戶手冊(cè)操作手冊(cè)軟件需求說(shuō)明書數(shù)據(jù)要求說(shuō)明書項(xiàng)目開發(fā)計(jì)劃模塊開發(fā)卷宗開發(fā)進(jìn)度月報(bào)測(cè)試計(jì)劃測(cè)試分析報(bào)告項(xiàng)目開發(fā)總結(jié)報(bào)告1123七月20212.4軟件文檔與使用者的關(guān)系軟件開發(fā)中產(chǎn)生的各類文檔面向不同的用戶,而軟件用戶應(yīng)該得到的文檔也在商業(yè)合同中有明確規(guī)定。軟件文檔的使用對(duì)象開發(fā)人員維護(hù)人員管理人員用戶可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說(shuō)明書數(shù)據(jù)要求說(shuō)明
7、書概要設(shè)計(jì)說(shuō)明書詳細(xì)設(shè)計(jì)說(shuō)明書數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書測(cè)試計(jì)劃測(cè)試分析報(bào)告設(shè)計(jì)說(shuō)明書測(cè)試分析報(bào)告模塊開發(fā)卷宗可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃模塊開發(fā)卷宗開發(fā)進(jìn)度月報(bào)項(xiàng)目開發(fā)總結(jié)報(bào)告用戶手冊(cè)操作手冊(cè)1223七月20212.5軟件文檔編制與軟件生存周期的關(guān)系軟件文檔的編制是隨著軟件生存期各個(gè)階段工作的開展而適時(shí)進(jìn)行的。其中,有的僅反映某一階段的工作,有的則需要跨越多個(gè)階段的工作??尚行匝芯颗c計(jì)劃需求分析軟件設(shè)計(jì)編碼與單元測(cè)試集成與測(cè)試運(yùn)行與維護(hù)可行性研究報(bào)告√項(xiàng)目開發(fā)計(jì)劃√√軟件需求說(shuō)明書√數(shù)據(jù)要求說(shuō)明書√測(cè)試計(jì)劃√√概要設(shè)計(jì)說(shuō)明書√詳細(xì)設(shè)計(jì)說(shuō)明書√數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書√模塊開發(fā)
8、卷宗√√用戶手冊(cè)√√√操作手冊(cè)√√測(cè)試分析報(bào)告√開發(fā)