第2章軟件文檔及其組成ppt課件

1、2022年5月1日星期日1徐承志徐承志第第2章章 軟件文檔及其組成軟件文檔及其組成2022年5月1日星期日關(guān)于軟件文檔要說的話關(guān)于軟件文檔要說的話v 文檔對于工程的意義文檔對于工程的意義v 軟件工程是針對大型系統(tǒng)開發(fā)的，是多人開發(fā)和團(tuán)隊(duì)協(xié)軟件工程是針對大型系統(tǒng)開發(fā)的，是多人開發(fā)和團(tuán)隊(duì)協(xié)作，因此文檔是相互交流的重要且必需的媒介。文檔的作，因此文檔是相互交流的重要且必需的媒介。文檔的媒介方式可以多種多樣媒介方式可以多種多樣v 文檔的重要性文檔的重要性v 文檔編寫任務(wù)與代碼編寫任務(wù)同等重要。技術(shù)人員對文文檔編寫任務(wù)與代碼編寫任務(wù)同等重要。技術(shù)人員對文檔人員的偏見檔人員的偏見v 有了完好的文檔系統(tǒng)可以

2、復(fù)現(xiàn)和維護(hù)，而只需代碼那么有了完好的文檔系統(tǒng)可以復(fù)現(xiàn)和維護(hù)，而只需代碼那么不行。不行。v 文檔編寫的難度文檔編寫的難度v 文檔是給人看的試想高中寫作文，每年寫懇求書，文檔是給人看的試想高中寫作文，每年寫懇求書，代碼是給機(jī)器看的。讓學(xué)生選擇寫文檔還是寫代碼代碼是給機(jī)器看的。讓學(xué)生選擇寫文檔還是寫代碼v 軟件工程的終極目的，文檔既能被人看又能被機(jī)器了解。軟件工程的終極目的，文檔既能被人看又能被機(jī)器了解。2022年5月1日星期日課程引見課程引見v 主要內(nèi)容主要內(nèi)容v 文檔分類文檔分類 1、2章內(nèi)容順序調(diào)整一下章內(nèi)容順序調(diào)整一下v 規(guī)范化的概念規(guī)范化的概念v 軟件文檔的國標(biāo)軟件文檔的國標(biāo)v 寫作要求寫

3、作要求v 軟件開發(fā)文檔軟件開發(fā)文檔v 可行性報(bào)告、需求文檔、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)可行性報(bào)告、需求文檔、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)v 軟件管理文檔軟件管理文檔v 開發(fā)方案、測試方案和測試報(bào)告、進(jìn)度報(bào)告、總結(jié)報(bào)告開發(fā)方案、測試方案和測試報(bào)告、進(jìn)度報(bào)告、總結(jié)報(bào)告v 軟件用戶文檔軟件用戶文檔v 軟件文檔管理軟件文檔管理v 雖然沒有實(shí)驗(yàn)，但是要完成課堂作業(yè)預(yù)備練習(xí)本雖然沒有實(shí)驗(yàn)，但是要完成課堂作業(yè)預(yù)備練習(xí)本2022年5月1日星期日2.1 2.1 軟件文檔的概念軟件文檔的概念v2.1.1 為什么需求文檔為什么需求文檔v文檔是計(jì)算機(jī)軟件產(chǎn)品的重要組成部分，文檔是計(jì)算機(jī)軟件產(chǎn)品的重要組成部分，沒有文檔就不成其為軟件，也

4、更不能成為沒有文檔就不成其為軟件，也更不能成為軟件產(chǎn)品。軟件產(chǎn)品。v軟件文檔是一種重要的軟件工程技術(shù)資料。軟件文檔是一種重要的軟件工程技術(shù)資料。如系統(tǒng)分析文檔、設(shè)計(jì)文檔、版本闡明文如系統(tǒng)分析文檔、設(shè)計(jì)文檔、版本闡明文檔檔v軟件文檔的規(guī)范編制，在軟件開發(fā)任務(wù)中軟件文檔的規(guī)范編制，在軟件開發(fā)任務(wù)中占有突出的位置和相當(dāng)大的任務(wù)量。高質(zhì)占有突出的位置和相當(dāng)大的任務(wù)量。高質(zhì)量、高效率的編制、分發(fā)、管理、維護(hù)文量、高效率的編制、分發(fā)、管理、維護(hù)文檔，及時(shí)的變卦、修正、擴(kuò)展和運(yùn)用文檔，檔，及時(shí)的變卦、修正、擴(kuò)展和運(yùn)用文檔，對于軟件產(chǎn)品的設(shè)計(jì)開發(fā)、發(fā)行運(yùn)用、變對于軟件產(chǎn)品的設(shè)計(jì)開發(fā)、發(fā)行運(yùn)用、變卦維護(hù)、轉(zhuǎn)讓移

5、植、二次開發(fā)等，對于充卦維護(hù)、轉(zhuǎn)讓移植、二次開發(fā)等，對于充分發(fā)揚(yáng)軟件產(chǎn)品的效益，都有著重要的意分發(fā)揚(yáng)軟件產(chǎn)品的效益，都有著重要的意義。義。2022年5月1日星期日2.1 2.1 軟件文檔的概念軟件文檔的概念v2.1.2 軟件文檔的定義軟件文檔的定義v軟件文檔寫作是為了記錄目的系統(tǒng)的定義、規(guī)劃、軟件文檔寫作是為了記錄目的系統(tǒng)的定義、規(guī)劃、分析、研討、設(shè)計(jì)、開發(fā)、運(yùn)用等各個(gè)階段的設(shè)分析、研討、設(shè)計(jì)、開發(fā)、運(yùn)用等各個(gè)階段的設(shè)計(jì)思想和研討成果。計(jì)思想和研討成果。v文檔文檔某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。v文檔具有永久性，并可供人或機(jī)器閱讀，通常指文檔具有永久性，并可供人

6、或機(jī)器閱讀，通常指專供人閱讀的東西。專供人閱讀的東西。v文檔作為計(jì)算機(jī)軟件的重要組成部分，通知用戶文檔作為計(jì)算機(jī)軟件的重要組成部分，通知用戶如何操作和維護(hù)系統(tǒng)，提供關(guān)于未來改良和重新如何操作和維護(hù)系統(tǒng)，提供關(guān)于未來改良和重新實(shí)施所需的信息，在開發(fā)人員、維護(hù)人員、管理實(shí)施所需的信息，在開發(fā)人員、維護(hù)人員、管理人員、用戶與計(jì)算機(jī)之間起著重要的橋梁作用。人員、用戶與計(jì)算機(jī)之間起著重要的橋梁作用。2022年5月1日星期日2.1 2.1 軟件文檔的概念軟件文檔的概念v文檔的橋梁作用文檔的橋梁作用維護(hù)人員維護(hù)人員管理人員管理人員計(jì)算機(jī)軟件計(jì)算機(jī)軟件用用 戶戶橋梁作用橋梁作用開發(fā)人員開發(fā)人員2022年5月1

7、日星期日2.2 2.2 軟件文檔的作用軟件文檔的作用v1. 工程管理的根據(jù)工程管理的根據(jù)v文檔將通常文檔將通?！安豢梢姷能浖_發(fā)進(jìn)程轉(zhuǎn)換成不可見的軟件開發(fā)進(jìn)程轉(zhuǎn)換成“可可見的文字資料，有利于工程的管理。見的文字資料，有利于工程的管理。“有據(jù)可查有據(jù)可查v2. 技術(shù)交流的言語技術(shù)交流的言語v工程小組內(nèi)部、工程平行開發(fā)的各小組之間進(jìn)展工程小組內(nèi)部、工程平行開發(fā)的各小組之間進(jìn)展的交流和聯(lián)絡(luò)，通常都是經(jīng)過文檔來實(shí)現(xiàn)的。的交流和聯(lián)絡(luò)，通常都是經(jīng)過文檔來實(shí)現(xiàn)的。v3. 工程質(zhì)量保證工程質(zhì)量保證v文檔是進(jìn)展工程質(zhì)量審查和評價(jià)的重要根據(jù)，有文檔是進(jìn)展工程質(zhì)量審查和評價(jià)的重要根據(jù)，有效文檔的提供，可以滿足工程質(zhì)

8、量保證人員和審效文檔的提供，可以滿足工程質(zhì)量保證人員和審查人員的任務(wù)需求。查人員的任務(wù)需求。2022年5月1日星期日2.2 2.2 軟件文檔的作用軟件文檔的作用v 4. 支持培訓(xùn)與維護(hù)支持培訓(xùn)與維護(hù)v 合格的軟件文檔通常都提供有關(guān)軟件運(yùn)轉(zhuǎn)、維護(hù)和培訓(xùn)的合格的軟件文檔通常都提供有關(guān)軟件運(yùn)轉(zhuǎn)、維護(hù)和培訓(xùn)的必要信息，支持軟件產(chǎn)品的運(yùn)用和維護(hù)。必要信息，支持軟件產(chǎn)品的運(yùn)用和維護(hù)。v 5. 支持軟件維護(hù)支持軟件維護(hù)v 軟件文檔提供系統(tǒng)開發(fā)的全部必要技術(shù)資料，有利于維護(hù)軟件文檔提供系統(tǒng)開發(fā)的全部必要技術(shù)資料，有利于維護(hù)人員熟習(xí)系統(tǒng)，開展維護(hù)任務(wù)；軟件維護(hù)文檔記載了軟件人員熟習(xí)系統(tǒng)，開展維護(hù)任務(wù)；軟件維護(hù)文

9、檔記載了軟件維護(hù)過程中軟件及其環(huán)境變化的全部信息。維護(hù)過程中軟件及其環(huán)境變化的全部信息。v 6. 記載軟件歷史記載軟件歷史v 軟件文檔作為軟件文檔作為“記載軟件歷史的言語，可用作未來工程記載軟件歷史的言語，可用作未來工程的一種資源，向潛在用戶報(bào)道軟件的各種有利信息，便于的一種資源，向潛在用戶報(bào)道軟件的各種有利信息，便于他們判別本人能否需求該軟件提供的效力。他們判別本人能否需求該軟件提供的效力。v 良好的系統(tǒng)文檔，顯然有助于完成軟件的移植，或?qū)④浖己玫南到y(tǒng)文檔，顯然有助于完成軟件的移植，或?qū)④浖D(zhuǎn)移到各種新的系統(tǒng)環(huán)境中去。轉(zhuǎn)移到各種新的系統(tǒng)環(huán)境中去。2022年5月1日星期日2.3 2.3 軟件

10、文檔的分類軟件文檔的分類v從方式上上將軟件文檔大致分成兩類：從方式上上將軟件文檔大致分成兩類：v軟件開發(fā)過程中需求填寫的各種圖表軟件開發(fā)過程中需求填寫的各種圖表v編制的各種技術(shù)文件或管理資料編制的各種技術(shù)文件或管理資料v根據(jù)其產(chǎn)生和運(yùn)用的范圍主要?jiǎng)澐譃槿悾焊鶕?jù)其產(chǎn)生和運(yùn)用的范圍主要?jiǎng)澐譃槿悾簐開發(fā)文檔開發(fā)文檔v用戶文檔用戶文檔v管理文檔。管理文檔。2022年5月1日星期日軟件文檔軟件文檔開發(fā)文檔開發(fā)文檔用戶文檔用戶文檔管理文檔管理文檔可行性研討報(bào)告可行性研討報(bào)告工程開發(fā)方案工程開發(fā)方案軟件需求闡明書軟件需求闡明書數(shù)據(jù)庫設(shè)計(jì)闡明書數(shù)據(jù)庫設(shè)計(jì)闡明書概要設(shè)計(jì)闡明書概要設(shè)計(jì)闡明書詳細(xì)設(shè)計(jì)闡明書詳細(xì)

11、設(shè)計(jì)闡明書用戶手冊用戶手冊操作手冊操作手冊軟件需求闡明書軟件需求闡明書數(shù)據(jù)要求闡明書數(shù)據(jù)要求闡明書工程開發(fā)方案工程開發(fā)方案模塊開發(fā)卷宗模塊開發(fā)卷宗開發(fā)進(jìn)度月報(bào)開發(fā)進(jìn)度月報(bào)測試方案測試方案測試分析報(bào)告測試分析報(bào)告工程開發(fā)總結(jié)報(bào)告工程開發(fā)總結(jié)報(bào)告2022年5月1日星期日2.4 2.4 軟件文檔與運(yùn)用者的關(guān)系軟件文檔與運(yùn)用者的關(guān)系軟件開發(fā)中產(chǎn)生的各類文檔面向不同的用戶，而軟件用戶應(yīng)該得到的文檔也在商業(yè)合同中有明確規(guī)定。軟件文檔的運(yùn)用對象軟件文檔的運(yùn)用對象開發(fā)人員開發(fā)人員維護(hù)人員維護(hù)人員管理人員管理人員用用 戶戶可行性研討報(bào)告可行性研討報(bào)告工程開發(fā)方案工程開發(fā)方案軟件需求闡明書軟件需求闡明書數(shù)據(jù)要求闡

12、明書數(shù)據(jù)要求闡明書概要設(shè)計(jì)闡明書概要設(shè)計(jì)闡明書詳細(xì)設(shè)計(jì)闡明書詳細(xì)設(shè)計(jì)闡明書數(shù)據(jù)庫設(shè)計(jì)闡明書數(shù)據(jù)庫設(shè)計(jì)闡明書測試方案測試方案測試分析報(bào)告測試分析報(bào)告設(shè)計(jì)闡明書設(shè)計(jì)闡明書測試分析報(bào)告測試分析報(bào)告模塊開發(fā)卷宗模塊開發(fā)卷宗可行性研討報(bào)告可行性研討報(bào)告工程開發(fā)方案工程開發(fā)方案模塊開發(fā)卷宗模塊開發(fā)卷宗開發(fā)進(jìn)度月報(bào)開發(fā)進(jìn)度月報(bào)工程開發(fā)總結(jié)報(bào)告工程開發(fā)總結(jié)報(bào)告用戶手冊用戶手冊操作手冊操作手冊2022年5月1日星期日2.5 2.5 軟件文檔編制與軟件生存周期的關(guān)系軟件文檔編制與軟件生存周期的關(guān)系v 軟件文檔的編制是隨著軟件生存期各個(gè)階段任務(wù)的開展而適時(shí)進(jìn)展的。其中，有的僅反映某一階段的任務(wù)，有的那么需求跨越多個(gè)階段的任務(wù)?？尚行匝芯颗c計(jì)劃需求分析軟件設(shè)計(jì)編碼與單元測試集成與測試運(yùn)行與維護(hù)可行性研究報(bào)告項(xiàng)目開發(fā)計(jì)劃軟件需求說明書數(shù)據(jù)要求說明書測試計(jì)劃概要設(shè)計(jì)說明書詳細(xì)設(shè)計(jì)說明書數(shù)據(jù)庫設(shè)計(jì)說明書模塊開發(fā)卷宗用戶手冊操作手冊測試分析報(bào)告開發(fā)進(jìn)度月報(bào)項(xiàng)目總結(jié)報(bào)告維護(hù)和修改建議2022年5月1日星期日2.5 2.5