《軟件工程寫作ppt課件》由會(huì)員分享，可在線閱讀，更多相關(guān)《軟件工程寫作ppt課件（38頁(yè)珍藏版）》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。

1、單擊此處編輯母版標(biāo)題樣式,,單擊此處編輯母版文本樣式,,第二級(jí),,第三級(jí),,第四級(jí),,第五級(jí),,,*,軟件文檔,,什么是文檔,,文檔(document),是指某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。,,它具有,永久性,，并可以由人或機(jī)器閱讀，通常僅用于描述人工可讀的東西。,,在軟件工程中，文檔常常用來(lái)表示對(duì),活動(dòng),、,需求,、,過程,或,結(jié)果,進(jìn)行,描述、定義、規(guī)定、報(bào)告或認(rèn)證,的任何書面或圖示的信息。,,軟件文檔的作用,在軟件生產(chǎn)過程中，軟件文檔在產(chǎn)品的開發(fā)過程中起著重要的作用：,,提高,軟件開發(fā)過程的能見度,。把開發(fā)過程中,發(fā)生的事件,以某種可閱讀的形式,記錄在文檔中,。,,管理人員可把這些記載下

2、來(lái)的材料,作為檢查軟件開發(fā)進(jìn)度和開發(fā)質(zhì)量的依據(jù)，實(shí)現(xiàn)對(duì)軟件開發(fā)的工程管理,。,,提高開發(fā)效率,。軟件文檔的編制，使得開發(fā)人員,對(duì)各個(gè)階段的工作,都進(jìn)行,周密思考,、,全盤權(quán)衡,、,減少返工,。并且可,在開發(fā)早期發(fā)現(xiàn)錯(cuò)誤和不一致性,，便于及時(shí)加以糾正。,,作為開發(fā)人員在一定,階段的,工作成果和結(jié)束標(biāo)志,。,,記錄開發(fā)過程中有關(guān)信息，便于,協(xié)調(diào),以后的軟件開發(fā)、使用和維護(hù)。,軟件文檔的作用,,提供對(duì)軟件的,運(yùn)行,、,維護(hù),和,培訓(xùn),的有關(guān)信息，,便于管理人員、開發(fā)人員、操作人員、用戶之間的協(xié)作、交流和了解,。使軟件開發(fā)活動(dòng)更科學(xué)、更有成效。,,便于潛在用戶了解軟件的功能、性能等各項(xiàng)指標(biāo),，為他們選

3、購(gòu)符合自己需要的軟件提供依據(jù)。,軟件文檔的作用,,文檔的橋梁作用,,文檔的分類,軟件文檔從形式上來(lái)看，大致可分為兩類：,,一類是開發(fā)過程中填寫的各種圖表，稱之為,工作表格,；,,一類是應(yīng)編制的技術(shù)資料或技術(shù)管理資料，稱之為,文檔或文件,。,,,按照文檔產(chǎn)生和使用的范圍，軟件文檔大致可分為三類：,,1、開發(fā)文檔,,,軟件需求說明書 數(shù)據(jù)要求說明書,,概要設(shè)計(jì)說明書 詳細(xì)設(shè)計(jì)說明書,,可行性研究報(bào)告 項(xiàng)目開發(fā)計(jì)劃,,文檔的分類,,2、,管理文檔,,,項(xiàng)目開發(fā)計(jì)劃 測(cè)試計(jì)劃,,測(cè)試報(bào)告 開發(fā)進(jìn)度月報(bào),,項(xiàng)目開發(fā)總結(jié),,3、,用戶文檔,,,用戶手冊(cè) 操作手冊(cè),,維護(hù)修改建議 軟

4、件需求說明書,文檔的分類,,軟件文檔的工作,國(guó)家標(biāo)準(zhǔn)局在1988年1月發(fā)布了,,《計(jì)算機(jī)軟件開發(fā)規(guī)范》,,《軟件產(chǎn)品開發(fā)文件編制指南》,,作為軟件開發(fā)人員工作的準(zhǔn)則和規(guī)程。它們,基于軟件生存期方法,，把軟件產(chǎn)品,從形成概念開始,，,經(jīng)過開發(fā),、,使用和不斷增補(bǔ)修訂,，,直到最后被淘汰,的,整個(gè)過程,應(yīng)提交的文檔歸于以下十三種。,,1、可行性研究報(bào)告,,說明該軟件項(xiàng)目的實(shí)現(xiàn)在,技術(shù)上,、,經(jīng)濟(jì)上,和,社會(huì)因素上,的,可行性,;,,評(píng)述為合理地達(dá)到開發(fā)目標(biāo),可供選擇的,各種可能的實(shí)現(xiàn)方案,;,,說明并論證所選定實(shí)施方案的理由。,,文檔的分類,,2、項(xiàng)目開發(fā)計(jì)劃,,為軟件項(xiàng)目實(shí)施方案制定出的具體計(jì)劃

5、。它包括,,,各部分工作的負(fù)責(zé)人員,,開發(fā)的進(jìn)度,,開發(fā)經(jīng)費(fèi)的概算,,所需的硬件和軟件資源等,,項(xiàng)目開發(fā)計(jì)劃應(yīng)提供給管理部門，并,作為開發(fā)階段評(píng)審的基礎(chǔ),。,文檔的分類,,3、軟件需求說明書,,對(duì)目標(biāo)軟件的,功能,、,性能,、,用戶界面,及,運(yùn)行環(huán)境,等,作出詳細(xì)的說明,。,,它是用戶與開發(fā)人員,雙方對(duì)軟件需求取得共同理解基礎(chǔ)上達(dá)成的協(xié)議，也是實(shí)施開發(fā)工作的基礎(chǔ),。,,4、數(shù)據(jù)要求說明書,,給出,數(shù)據(jù)邏輯描述,和,數(shù)據(jù)采集,的各項(xiàng)要求, 為生成和維護(hù)系統(tǒng)的數(shù)據(jù)文件做好準(zhǔn)備。,文檔的分類,,5、概要設(shè)計(jì)說明書,,該說明書是概要設(shè)計(jì)工作階段的成果。它應(yīng)當(dāng)說明,,,系統(tǒng)的功能分配,,模塊劃分,,程序

6、的總體結(jié)構(gòu),,輸入輸出及接口設(shè)計(jì),,運(yùn)行設(shè)計(jì),,數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì),,出錯(cuò)處理設(shè)計(jì)等,,為詳細(xì)設(shè)計(jì)奠定基礎(chǔ)。,文檔的分類,,6、詳細(xì)設(shè)計(jì)說明書,,著重描述,每一個(gè)模塊是如何實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。,,7、用戶手冊(cè),,詳細(xì)描述軟件的,功能,、,性能,和,用戶界面,，使用戶了解,如何使用該軟件,。,,8、操作手冊(cè),,為操作人員提供,軟件各種運(yùn)行情況的有關(guān)知識(shí),，特別是操作方法細(xì)節(jié)。,文檔的分類,,9、測(cè)試計(jì)劃,,針對(duì),組裝測(cè)試和確認(rèn)測(cè)試,，需要,為組織測(cè)試制定計(jì)劃,。計(jì)劃應(yīng)包括,,,測(cè)試的內(nèi)容,,進(jìn)度安排,,條件,,人員,,測(cè)試用例的選取原則,,測(cè)試結(jié)果允許的偏差范圍等,文檔的分類,,10、測(cè)

7、試分析報(bào)告,,測(cè)試工作完成后，應(yīng),提交測(cè)試計(jì)劃執(zhí)行情況的說明。對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論性意見,。,,11、開發(fā)進(jìn)度月報(bào),,該月報(bào)是軟件人員,按月向管理部門提交的項(xiàng)目進(jìn)展情況的報(bào)告,。報(bào)告應(yīng)包括,進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較,、,階段成果,、,遇到的問題和解決的辦法,以及,下個(gè)月的打算,等。,文檔的分類,,12、項(xiàng)目開發(fā)總結(jié)報(bào)告,,軟件項(xiàng)目開發(fā)完成之后，應(yīng)當(dāng),與項(xiàng)目實(shí)施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本,和,投入的人力,。,,還需,對(duì)開發(fā)工作作出評(píng)價(jià)，總結(jié)經(jīng)驗(yàn)和教訓(xùn),。,,文檔的分類,,13、維護(hù)修改建議,,,軟件產(chǎn)品投入運(yùn)行之后，可能有修正、更改等問題,，應(yīng)

8、當(dāng),對(duì)存在的問題,、,修改的考慮,以及,修改的影響估計(jì),等,做詳細(xì)的描述,，寫成維護(hù)修改建議，提交審批。,,以上軟件文檔是在軟件生存期中，隨著各個(gè)階段工作的開展適時(shí)編制的。其中，有的僅反映某一個(gè)階段的工作，有的則需跨越多個(gè)階段,。,文檔的分類,,軟件生存期各階段與各種文檔編制的關(guān)系,,,,文檔最終要向,軟件管理部門,，或向,用戶,回答下列問題,,,哪些需求要被滿足（What）；,,軟件在什么環(huán)境中實(shí)現(xiàn)，所需信息從哪里來(lái)（Where）；,,開發(fā)時(shí)間如何安排（When）；,,開發(fā)(或維護(hù))工作打算由誰(shuí)來(lái)做（Who）；,,需求應(yīng)如何實(shí)現(xiàn)（How）；,,為什么要進(jìn)行這些軟件開發(fā)或維護(hù)修改工作（Why）

9、。,,文檔要回答的問題,,,,對(duì)文檔編制的質(zhì)量要求,如果不重視文檔編寫工作，或是對(duì)文檔編寫工作的安排不當(dāng)，就不可能得到高質(zhì)量的文檔。,,質(zhì)量差的文檔,,使讀者難于理解,，,給使用者造成許多不便,,會(huì)削弱對(duì)軟件的管理,（難以確認(rèn)和評(píng)價(jià)開發(fā)工作的進(jìn)展情況)，,提高軟件成本,(一些工作可能被迫返工),,造成,誤操作,,對(duì)編制高質(zhì)量文檔的要求,(,1,),針對(duì)性,,,文檔編制以前,應(yīng)分清讀者對(duì)象,。按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要。,,,管理文檔主要面向管理人員,,,用戶文檔主要面向用戶,,這兩類文檔不應(yīng)像開發(fā)文檔(面向開發(fā)人員)那樣過多使用軟件的專用術(shù)語(yǔ)。,,(2),精確性,,,

10、,文檔的行文應(yīng)當(dāng),十分確切,，,不能出現(xiàn)多義性的描述,。同一課題幾個(gè)文檔的內(nèi)容應(yīng)當(dāng)是協(xié)調(diào)一致，沒有矛盾的。,,(3) 清晰性,,,文檔編寫應(yīng),力求簡(jiǎn)明,，,如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。,,,(4) 完整性,,任何一個(gè)文檔都應(yīng)當(dāng)是,完整的,、,獨(dú)立的,，它應(yīng),自成體系,。,,例如，,前言部分應(yīng)做一般性介紹，正文給出中心內(nèi)容，必要時(shí)還有附錄，列出參考資料等。,,同一課題的幾個(gè)文檔之間可能有些部分內(nèi)容相同，這種重復(fù)是必要的。,,,不要在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況,。,如，一些段落沒有具體描述，用“見××文檔××節(jié)”的方式,.,,(5) 靈活性,,,各個(gè)不同軟件項(xiàng)目，其規(guī)模和復(fù)雜程

11、度有著許多實(shí)際差別，不能一律看待。,,應(yīng)根據(jù)具體的軟件開發(fā)項(xiàng)目，決定編制的文檔種類。,,軟件開發(fā)的管理部門應(yīng)該,根據(jù)本單位承擔(dān)的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力，制定一個(gè)對(duì)文檔編制要求的實(shí)施規(guī)定。,,,對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定，確定一個(gè)文檔編制計(jì)劃。其中包括：,,編制哪幾種文檔，詳細(xì)程度如何,,各文檔的編制負(fù)責(zé)人和進(jìn)度要求,,審查/批準(zhǔn)負(fù)責(zé)人和時(shí)間進(jìn)度安排,,在開發(fā)時(shí)期內(nèi)各文檔的維護(hù)、修改和管理的負(fù)責(zé)人，以及批準(zhǔn)手續(xù),,當(dāng)所開發(fā)的軟件系統(tǒng)非常大時(shí)，一種文檔可以分成幾卷編寫。,例如，,,,項(xiàng)目開發(fā)計(jì)劃,可分寫為：,,質(zhì)量保證計(jì)劃,,配置管理計(jì)劃,,用戶培訓(xùn)計(jì)劃

12、,,安裝實(shí)施計(jì)劃等,。,,,系統(tǒng)設(shè)計(jì)說明書,可分寫為：,,系統(tǒng)設(shè)計(jì)說明書,,子系統(tǒng)設(shè)計(jì)說明書。,,,,程序設(shè)計(jì)說明書,可分寫為：,,程序設(shè)計(jì)說明書,,接口設(shè)計(jì)說明書,,版本說明。,,,操作手冊(cè),可分寫為：,,操作手冊(cè),,安裝實(shí)施過程。,,,測(cè)試計(jì)劃,可分寫為：,,,測(cè)試計(jì)劃,,,測(cè)試設(shè)計(jì)說明,,測(cè)試規(guī)程,,測(cè)試用例。,,,測(cè)試分析報(bào)告,可分寫為：,,綜合測(cè)試報(bào)告,,驗(yàn)收測(cè)試報(bào)告。,,,項(xiàng)目開發(fā)總結(jié)報(bào)告,也可分寫成：,,項(xiàng)目開發(fā)總結(jié)報(bào)告,,資源環(huán)境統(tǒng)計(jì)。,,對(duì)國(guó)標(biāo),GB8567-88,《,計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南,》所建議的所有條款都,,可以擴(kuò)展,，進(jìn)一步細(xì)分，以適應(yīng)需要；,,如果條款中有些細(xì)節(jié)并非必需，,也可以根據(jù)實(shí)際情況壓縮合并,。,,程序的設(shè)計(jì)表現(xiàn)形式，可以使用,程序流程圖,、,判定表,、,程序描述語(yǔ)言,(,PDL,)、或,問題分析圖,(,PAD,)等。,,當(dāng)國(guó)標(biāo)《,計(jì)算機(jī)軟件產(chǎn)品開發(fā)文件編制指南,》中規(guī)定的文檔種類不能滿足某些應(yīng)用部門的特殊需要時(shí)，,可以建立一些特殊的文檔種類要求,，這些要求可以包含在本單位的文檔編制實(shí)施規(guī)定中,。,,為使軟件文檔能起到多種橋梁的作用：,,有助于程序員編制程序,,有助于管理人員監(jiān)督和管理軟件的開發(fā),,有助于用戶了解軟件的工作和應(yīng)做的操作，,,有助于維護(hù)人員進(jìn)行有效的修改和擴(kuò)充,,文檔的編制必須保證一定的質(zhì)量。,,