軟件工程與軟件文檔

課程介紹教材：《軟件工程與軟件文檔寫(xiě)作》

文斌劉長(zhǎng)青田原著成績(jī)計(jì)算： 平時(shí)成績(jī)：30%

期末考試：70%考勤：30%作業(yè)：70%本課程全面系統(tǒng)地講述了現(xiàn)代軟件工程的基本概念、原理及應(yīng)用，重點(diǎn)是面向?qū)ο蟮能浖_(kāi)發(fā)方法、工具和過(guò)程，并針對(duì)軟件生命周期的主要階段，結(jié)合具體案例和相關(guān)標(biāo)準(zhǔn)，講述軟件主要文檔的寫(xiě)作規(guī)范和技巧。通過(guò)本課程的學(xué)習(xí)，使學(xué)生能夠真正的從中了解軟件開(kāi)發(fā)的整個(gè)過(guò)程，培養(yǎng)學(xué)生的軟件工程化開(kāi)發(fā)的意識(shí)和對(duì)于不同軟件文檔的寫(xiě)作能力;使學(xué)生能夠運(yùn)用所學(xué)技能和標(biāo)準(zhǔn)完成軟件開(kāi)發(fā)組織中文檔寫(xiě)作的任務(wù)。特別是面向?qū)ο蟛糠?，使用UML+Rose進(jìn)行開(kāi)發(fā)方法講述和文檔寫(xiě)作能力培養(yǎng)。課程主要內(nèi)容參考資料：[1]齊治昌，譚慶平，寧洪.軟件工程.北京：高等教育出版社，2001[2] 殷人昆.軟件工程復(fù)習(xí)與考試指導(dǎo).北京：高等教育出版社，2001[3] 鄭人杰，殷人昆，陶永雷.實(shí)用軟件工程第2版.北京：清華大學(xué)出版社，1997[4] 張虹.軟件工程與軟件開(kāi)發(fā)工具.北京：清華大學(xué)出版社，2004[5] 朱三元，錢(qián)樂(lè)秋，宿為民.軟件工程技術(shù)概論.北京：科學(xué)出版社，2002[6] 王國(guó)強(qiáng)，廖啟高，王海山，等.如何寫(xiě)好計(jì)算機(jī)軟件文檔.北京：電子工業(yè)出版社，1994[7] [美]PrattT W，ZelkowitzMV.程序設(shè)計(jì)語(yǔ)言：設(shè)計(jì)與實(shí)現(xiàn)第4版.傅育熙譯.北京：電子工業(yè)出版社，2001[8] 吳際，金茂忠.UML面向?qū)ο蠓治?北京：北京航空航天大學(xué)出版社，2002[9] PressmanR.SoftwareEngineering：APractitioner’sApproach.4thed.北京：機(jī)械工業(yè)出版社，1999[10] 張海藩.軟件工程導(dǎo)論第4版.北京：清華大學(xué)出版社，2003[11] 劉強(qiáng).軟件工程教案.北京：清華同方股份公司，2003[12] 劉超，張莉.可視化面向?qū)ο蠼＜夹g(shù).北京：北京航空航天大學(xué)出版社，1999第1章軟件工程與軟件文檔1.1軟件

軟件包括程序、數(shù)據(jù)及其相關(guān)文檔的完整集合；

程序是按事先設(shè)計(jì)的功能和性能要求執(zhí)行的指令序列；

數(shù)據(jù)是使程序能正常操縱信息的數(shù)據(jù)結(jié)構(gòu)；

文檔是與程序開(kāi)發(fā)、維護(hù)和使用有關(guān)的圖文材料。

程序是由程序設(shè)計(jì)語(yǔ)言所描述、能為計(jì)算機(jī)所識(shí)別、理解和處理的語(yǔ)句序列，程序設(shè)計(jì)語(yǔ)言具有良好、嚴(yán)格的語(yǔ)法和語(yǔ)義。目前程序設(shè)計(jì)語(yǔ)言主要有以下幾種類(lèi)型：?面向機(jī)器，如匯編語(yǔ)言、機(jī)器語(yǔ)言等；?面向過(guò)程，如Fortran、Pascal、C等等；?面向?qū)ο?，如Java等等；?面向問(wèn)題，如結(jié)構(gòu)化查詢(xún)語(yǔ)言SQL等等。軟件文檔是記錄軟件開(kāi)發(fā)活動(dòng)和階段性成果、理解軟件所必需的闡述性資料。編寫(xiě)軟件文檔的目的：?促進(jìn)對(duì)軟件的開(kāi)發(fā)、管理和維護(hù)；?便于各種人員（用戶(hù)和開(kāi)發(fā)人員）的交流。軟件的形式化定義，即軟件是：(1)能夠完成預(yù)定功能和性能的可執(zhí)行指令；(2)使得程序能夠適當(dāng)?shù)夭僮餍畔⒌臄?shù)據(jù)結(jié)構(gòu)；(3)描述程序的操作和使用的文檔。軟件的特點(diǎn)(1)軟件是一種邏輯實(shí)體，而不是具體的物理實(shí)體(2)軟件的生產(chǎn)與硬件不同(3)在軟件的運(yùn)行和使用期間，沒(méi)有硬件那樣的機(jī)械磨損，老化問(wèn)題磨合調(diào)整磨損用壞修改點(diǎn)實(shí)際曲線(xiàn)理想曲線(xiàn)硬件失效率曲線(xiàn)時(shí)間失效率時(shí)間失效率軟件失效率曲線(xiàn)(4)軟件的開(kāi)發(fā)和運(yùn)行常常受到計(jì)算機(jī)系統(tǒng)的限制，對(duì)計(jì)算機(jī)系統(tǒng)有著不同程度的依賴(lài)性。為了解除這種依賴(lài)性，在軟件開(kāi)發(fā)中提出了軟件移植的問(wèn)題。(5)軟件的開(kāi)發(fā)至今尚未完全擺脫手工藝的開(kāi)發(fā)方式。(6)軟件本身是復(fù)雜的。(7)相當(dāng)多的軟件工作涉及到社會(huì)因素。(8)軟件成本相當(dāng)昂貴。軟件的成本相當(dāng)昂貴軟件技術(shù)的發(fā)展落后于需求硬、軟件成本比例的變化時(shí)間軟件復(fù)雜性軟件需求差距軟件技術(shù)年份成本%軟件1950197019851995硬件1.2 軟件的分類(lèi)和發(fā)展(1)按軟件的功能進(jìn)行劃分系統(tǒng)軟件：能與計(jì)算機(jī)硬件緊密配合在一起，使計(jì)算機(jī)系統(tǒng)各個(gè)部件、相關(guān)軟件和數(shù)據(jù)協(xié)調(diào)、高效工作的軟件，例如，操作系統(tǒng)、數(shù)據(jù)庫(kù)管理系統(tǒng)、設(shè)備驅(qū)動(dòng)程序以及通信處理程序等。應(yīng)用軟件：是在特定領(lǐng)域內(nèi)開(kāi)發(fā)，為特定目的服務(wù)的一類(lèi)軟件。支撐軟件：是協(xié)助用戶(hù)開(kāi)發(fā)軟件的工具性軟件，其中包括幫助程序人員開(kāi)發(fā)軟件產(chǎn)品的工具，也包括幫助管理人員控制開(kāi)發(fā)進(jìn)程的工具。2023/6/12支撐軟件一般類(lèi)型：文本編輯程序文本格式化程序支持需求分析：PSL/PSA問(wèn)題描述語(yǔ)言關(guān)系數(shù)據(jù)庫(kù)管理系統(tǒng)支持設(shè)計(jì)：圖形軟件包結(jié)構(gòu)化流程圖繪圖程序支持測(cè)試：靜態(tài)分析器測(cè)試覆蓋檢驗(yàn)程序支持實(shí)現(xiàn)：編輯程序連接編輯程序支持管理：標(biāo)準(zhǔn)檢驗(yàn)程序庫(kù)管理程序(2)按軟件規(guī)模進(jìn)行劃分類(lèi)別參加人員數(shù)研制期限產(chǎn)品規(guī)模（源程序行數(shù)）微型11?4周500小型11?6月1x103?2x103中型2?51?2年5x103?50x103大型5?202?3年5k?50xl03?100xlO3甚大型100-10004?5年1xlO6極大型2000?50005?10年1x106?10x106(3)按軟件工作方式劃分實(shí)時(shí)處理軟件：指在事件或數(shù)據(jù)產(chǎn)生時(shí)立即予以處理，并及時(shí)反饋信號(hào)，控制需要監(jiān)測(cè)和控制的過(guò)程的軟件。主要包括數(shù)據(jù)采集、分析和輸出三部分。例：QQ分時(shí)軟件：允許多個(gè)聯(lián)機(jī)用戶(hù)同時(shí)使用計(jì)算機(jī)。

例：紅綠燈交互式軟件：能實(shí)現(xiàn)人機(jī)通信的軟件。例：繪聲繪影批處理軟件：把一組輸入作業(yè)或一批數(shù)據(jù)以成批處理的方式一次運(yùn)行，按順序逐個(gè)處理的軟件。例：垃圾處理軟件(4)按軟件服務(wù)對(duì)象的范圍劃分項(xiàng)目軟件：也稱(chēng)定制軟件，是受某個(gè)特定客戶(hù)（或少數(shù)客戶(hù)）的委托，由一個(gè)或多個(gè)軟件開(kāi)發(fā)機(jī)構(gòu)在合同的約束下開(kāi)發(fā)出來(lái)的軟件。例如軍用防空指揮系統(tǒng)、衛(wèi)星控制系統(tǒng)。產(chǎn)品軟件：是由軟件開(kāi)發(fā)機(jī)構(gòu)開(kāi)發(fā)出來(lái)直接提供給市場(chǎng)，或是為千百個(gè)用戶(hù)服務(wù)的軟件。例如，文字處理軟件、文本處理軟件、財(cái)務(wù)處理軟件、人事管理軟件等。(5)按使用的頻度進(jìn)行劃分有的軟件開(kāi)發(fā)出來(lái)僅供一次使用。例如用于人口普查、工業(yè)普查的軟件。另外有些軟件具有較高的使用頻度，如天氣預(yù)報(bào)軟件。(6)按軟件失效的影響進(jìn)行劃分有的軟件在工作中出現(xiàn)了故障，造成軟件失效，可能給整個(gè)系統(tǒng)帶來(lái)的影響不大。有的軟件一旦失效。可能釀成災(zāi)難性后果，例如財(cái)務(wù)金融、交通通信、航空航天等軟件。我們稱(chēng)這類(lèi)軟件為關(guān)鍵軟件或生命攸關(guān)軟件。軟件的發(fā)展歷史

經(jīng)歷4個(gè)階段1950196019701980程序設(shè)計(jì)階段面向批處理有限的分布自定義軟件1.1.2軟件發(fā)展1950196019701980程序系統(tǒng)階段多用戶(hù)實(shí)時(shí)數(shù)據(jù)庫(kù)軟件產(chǎn)品19501960197019801990軟件工程階段分布式系統(tǒng)嵌入“智能”低成本硬件消費(fèi)者的影響1.1.2軟件發(fā)展195019601970198019902005

第四階段強(qiáng)大的桌面系統(tǒng)面向?qū)ο蠹夹g(shù)專(zhuān)家系統(tǒng)人工神經(jīng)網(wǎng)絡(luò)并行計(jì)算網(wǎng)絡(luò)計(jì)算1.1.2軟件發(fā)展軟件危機(jī)

軟件危機(jī)是指在計(jì)算機(jī)軟件的開(kāi)發(fā)和維護(hù)過(guò)程中所遇到的一系列嚴(yán)重的問(wèn)題。（20世紀(jì)60年代末70年代初）（正常、不正常運(yùn)行軟件都具有這種問(wèn)題）軟件危機(jī)的具體表現(xiàn)：對(duì)軟件開(kāi)發(fā)成本和進(jìn)度的估計(jì)常常不準(zhǔn)確。（成本、進(jìn)度等）；軟件產(chǎn)品不符合用戶(hù)的實(shí)際需要；軟件產(chǎn)品的質(zhì)量差：軟件質(zhì)量保證技術(shù)（審查、復(fù)審及測(cè)試）沒(méi)有貫穿到軟件開(kāi)發(fā)的全過(guò)程中；軟件的可維護(hù)性差（改正、移植、重用性等）；件開(kāi)發(fā)生產(chǎn)率提高的速度遠(yuǎn)遠(yuǎn)不能滿(mǎn)足客觀(guān)需求；軟件文檔資料通常不完整、不合格；軟件的價(jià)格昂貴。軟件危機(jī)的原因：

（1）用戶(hù)需求不明確

（2）軟件開(kāi)發(fā)人員對(duì)用戶(hù)需求的理解與用戶(hù)的本來(lái)愿望有差異

（3）軟件規(guī)模越來(lái)越大，經(jīng)驗(yàn)不足

（4）軟件項(xiàng)目開(kāi)發(fā)人員不能有效、獨(dú)立自主地處理大型軟件的全部關(guān)系和各個(gè)分支

（5）缺乏有力的方法學(xué)和工具方面的支持

（6）軟件產(chǎn)品的特殊性和人類(lèi)智力的局限性1.3

軟件工程軟件工程，由NATO于1968年提出軟件工程是運(yùn)用工程、數(shù)學(xué)、計(jì)算機(jī)等科學(xué)概念、方法和原理來(lái)指導(dǎo)軟件開(kāi)發(fā)和管理和維護(hù)的一門(mén)工程學(xué)科。軟件工程構(gòu)成三要素為:?過(guò)程一管理部分；?方法——技術(shù)手段；?工具——自動(dòng)或半自動(dòng)地支持軟件的開(kāi)發(fā)和管理要素之間相互關(guān)聯(lián)和支持。軟件工程的目標(biāo)是：在給定成本、進(jìn)度的前提下，開(kāi)發(fā)出具有可修改性、有效性、可靠性、可理解性、可維護(hù)性、可重用性、可適應(yīng)性、可移植性、可追蹤性和可互操作性并滿(mǎn)足用戶(hù)需求的軟件產(chǎn)品。追求這些目標(biāo)有助于提高軟件產(chǎn)品的質(zhì)量和開(kāi)發(fā)效率，減少維護(hù)的困難。軟件工程的原則：抽象、信息隱藏、模塊化、局部化、一致性、完整性和可驗(yàn)證性12個(gè)在不同場(chǎng)合反復(fù)出現(xiàn)的概念：綁定（Binding)大問(wèn)題的復(fù)雜性（Complexity oflargeProblems)概念和形式模型（Conceptual andFormatModels)一致性和完備性（ConsistencyandCompleteness)效率（Efficiency)演化（Evolution)抽象層次（Levels ofAbstraction)按空間排序（Ordering inSpace)(9)按時(shí)間排序（Ordering inTime)(10)重用（Reuse)(11)安全性（Security)(12)折中和結(jié)論（Tradeoffs andConsequences)1.4

軟件文檔在軟件開(kāi)發(fā)中的地位和作用主要體現(xiàn)在以下幾個(gè)方面：(1)文檔反映軟件開(kāi)發(fā)人員在各階段的工作成果和結(jié)束標(biāo)志。(2)文檔提高軟件開(kāi)發(fā)過(guò)程的“透明度”，便于管理人員對(duì)整個(gè)開(kāi)發(fā)過(guò)程進(jìn)行控制和管理。(3)文檔增強(qiáng)軟件開(kāi)發(fā)的系統(tǒng)性。(4)文檔改善軟件開(kāi)發(fā)人員之間“愛(ài)莫能助”的局面，增強(qiáng)開(kāi)發(fā)人員之間的通訊交流。(5)文檔記錄從問(wèn)題定義、需求分析、軟件設(shè)計(jì)到驗(yàn)收測(cè)試，這一系列有關(guān)軟件的管理信息和技術(shù)信息，既便于協(xié)調(diào)軟件開(kāi)發(fā)工作，又為軟件維護(hù)和擴(kuò)充提供了依據(jù)。(6)文檔說(shuō)明軟件安裝。對(duì)文檔的基本要求:文檔的及時(shí)性。文檔的完整性。文檔的準(zhǔn)確性。文檔的規(guī)范性。根據(jù)標(biāo)準(zhǔn)制定的機(jī)構(gòu)和標(biāo)準(zhǔn)適用的范圍有所不同，軟件工程和軟件文檔標(biāo)準(zhǔn)可分為五個(gè)級(jí)別，即國(guó)際標(biāo)準(zhǔn)國(guó)家標(biāo)準(zhǔn)、行業(yè)標(biāo)準(zhǔn)、企業(yè)（機(jī)構(gòu)）規(guī)范及項(xiàng)目（課題）規(guī)范。1.國(guó)際標(biāo)準(zhǔn)：由國(guó)際聯(lián)合機(jī)構(gòu)制定和公布的標(biāo)準(zhǔn)，供各國(guó)參考。如ISO——國(guó)際標(biāo)準(zhǔn)化組織。2.國(guó)家標(biāo)準(zhǔn)：由政府或國(guó)家級(jí)的機(jī)構(gòu)制定或批準(zhǔn)，適用于全國(guó)范圍。如GB——中國(guó)國(guó)標(biāo)、ANSI——美國(guó)國(guó)家標(biāo)準(zhǔn)協(xié)會(huì)、BS——英國(guó)國(guó)家標(biāo)準(zhǔn)、JIS——日本工業(yè)標(biāo)準(zhǔn)。3.行業(yè)標(biāo)準(zhǔn)：由行業(yè)機(jī)構(gòu)、學(xué)術(shù)團(tuán)體或國(guó)防等機(jī)構(gòu)制定，適用于某個(gè)業(yè)務(wù)領(lǐng)域。如IEEE——美國(guó)電氣和電子工程師學(xué)會(huì)、GJB——中國(guó)國(guó)家軍用標(biāo)準(zhǔn)。4.企業(yè)規(guī)范：企業(yè)因軟件工程工作的需要制定的適用于本企業(yè)的規(guī)范。如IBM通用產(chǎn)品部于1984年制定的《程序設(shè)計(jì)開(kāi)發(fā)指南》。5.項(xiàng)目規(guī)范：由某一科研生產(chǎn)項(xiàng)目組織制定，僅為該項(xiàng)目任務(wù)服務(wù)的軟件工程規(guī)范。如CIMS——計(jì)算機(jī)集成制造系統(tǒng)——軟件工程規(guī)范。中國(guó)的軟件標(biāo)準(zhǔn)1983年起，我國(guó)陸續(xù)制定和發(fā)布了20余項(xiàng)軟件工程國(guó)家標(biāo)準(zhǔn)。這些標(biāo)準(zhǔn)可以分為以下四類(lèi)：1.基礎(chǔ)標(biāo)準(zhǔn)：規(guī)定了信息加工處理和軟件工程領(lǐng)域的術(shù)語(yǔ)、符號(hào)、表示、構(gòu)造、分類(lèi)級(jí)約定；2.開(kāi)發(fā)標(biāo)準(zhǔn)：規(guī)定了軟件生存期過(guò)程、軟件支持環(huán)境、軟件記錄處理流程、軟件維護(hù)等的工作規(guī)范；3.文檔標(biāo)準(zhǔn)：規(guī)定了軟件產(chǎn)品、需求、測(cè)試、管理等文檔的編制規(guī)范；4.管理標(biāo)準(zhǔn)：規(guī)定了軟件配置管理計(jì)劃、質(zhì)量保證計(jì)劃、產(chǎn)品質(zhì)量特性、軟件可靠性和可維護(hù)性管理等的規(guī)范和工作要素。下表列出了我國(guó)部分軟件工程標(biāo)準(zhǔn)的名稱(chēng)及其標(biāo)準(zhǔn)號(hào)：類(lèi)型標(biāo)準(zhǔn)名稱(chēng)標(biāo)準(zhǔn)號(hào)基礎(chǔ)標(biāo)準(zhǔn)軟件工程術(shù)語(yǔ)GB/T11457-1989信息處理——數(shù)據(jù)流程、程序流程圖、系統(tǒng)結(jié)構(gòu)圖、程序網(wǎng)絡(luò)圖、系統(tǒng)資源圖的文件編制符號(hào)及約定GB/T1526-1989軟件工程標(biāo)準(zhǔn)分類(lèi)法GB/T15538-1995信息處理——程序構(gòu)造及其表示法的約定GB/T13502-1992信息處理——單命中判定表規(guī)范GB/T15535-1995(ISO5806)信息處理系統(tǒng)——計(jì)算機(jī)系統(tǒng)配置圖符號(hào)及其約定GB/T14085-1993(ISO8790)開(kāi)發(fā)標(biāo)準(zhǔn)信息技術(shù)——軟件生存期過(guò)程GB/T8566-1995軟件支持環(huán)境GB/T15853-1995信息處理——按記錄組處理順序文卷的程序流程GB/T15697-1995(ISO6593)軟件維護(hù)指南GB/T14079-1993文檔標(biāo)準(zhǔn)計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文檔編制指南GB/T8567-1988計(jì)算機(jī)軟件需求說(shuō)明編制指南GB/T9385-1988計(jì)算機(jī)軟件測(cè)試文檔編制規(guī)范GB/T9386-1988軟件文檔管理指南GB/T16680-1996管理標(biāo)準(zhǔn)計(jì)算機(jī)軟件配置管理計(jì)劃規(guī)范GB/T12505-1990信息技術(shù)——軟件產(chǎn)品評(píng)價(jià)質(zhì)量特性及其使用指南GB/T16260-1996計(jì)算機(jī)軟件質(zhì)量保證計(jì)劃規(guī)范GB/T12504-1990計(jì)算機(jī)軟件可靠性和可維護(hù)性管理GB/T14394-1993軟件工程標(biāo)準(zhǔn)的制定

軟件工程標(biāo)準(zhǔn)的制定與推行通常要經(jīng)歷一個(gè)環(huán)狀生命周期，如下圖所示。從最初的制定一項(xiàng)標(biāo)準(zhǔn)的初步設(shè)想，經(jīng)發(fā)起后，沿著環(huán)狀生命期，順時(shí)針經(jīng)歷以下步驟：審核修訂建議開(kāi)發(fā)咨詢(xún)審批公布培訓(xùn)實(shí)施發(fā)起撤銷(xiāo)1.建議——擬定初步的建議方案2.開(kāi)發(fā)——制定標(biāo)準(zhǔn)的具體內(nèi)容3.咨詢(xún)——征求并吸收有關(guān)人員的意見(jiàn)4.審批——由管理部門(mén)決定能否推出5.公布——公布發(fā)布，使標(biāo)準(zhǔn)生效6.培訓(xùn)——為推行標(biāo)準(zhǔn)準(zhǔn)備人員條件7.實(shí)施——投入使用，需經(jīng)歷相當(dāng)期限8.審核——檢驗(yàn)實(shí)施效果，決定修改或撤銷(xiāo)9.修訂——修改其中不適當(dāng)?shù)牟糠郑纬蓸?biāo)準(zhǔn)的新版本，進(jìn)入新的周期事實(shí)上，幾乎所有的標(biāo)準(zhǔn)都有一個(gè)逐步的成熟，在環(huán)狀生命期上循環(huán)數(shù)次的經(jīng)歷，這就需要標(biāo)準(zhǔn)的制定者和使用者付出大量的勞動(dòng)，來(lái)對(duì)標(biāo)準(zhǔn)加以完善。軟件文檔的種類(lèi)軟件文檔從形式上看，大致可分為兩類(lèi)：一類(lèi)是開(kāi)發(fā)過(guò)程中填寫(xiě)的各種圖表，可稱(chēng)之為工作表格；另一類(lèi)是編制的技術(shù)資料或技術(shù)管理資料，可稱(chēng)之為文檔或文件。軟件文檔的編制，可以用自然語(yǔ)言、特別設(shè)計(jì)的形式語(yǔ)言、介于兩者之間的半形式語(yǔ)言（結(jié)構(gòu)化語(yǔ)言）和各類(lèi)圖形表示。可以用表格來(lái)編制文檔。文檔可以書(shū)寫(xiě)，也可以在計(jì)算機(jī)支持系統(tǒng)中產(chǎn)生，但它必須是可閱讀的。按照文檔產(chǎn)生和使用的范圍，軟件文檔大致可分為以下三類(lèi)：①開(kāi)發(fā)文檔。②管理文檔。③用戶(hù)文檔。41軟件文檔開(kāi)發(fā)文檔用戶(hù)文檔管理文檔可行性研究報(bào)告項(xiàng)目開(kāi)發(fā)計(jì)劃軟件需求說(shuō)明書(shū)數(shù)據(jù)要求規(guī)格說(shuō)明概要設(shè)計(jì)說(shuō)明書(shū)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)用戶(hù)手冊(cè)操作手冊(cè)軟件需求說(shuō)明書(shū)維護(hù)修改建議項(xiàng)目開(kāi)發(fā)計(jì)劃模塊開(kāi)發(fā)卷宗開(kāi)發(fā)進(jìn)度月報(bào)測(cè)試計(jì)劃測(cè)試分析報(bào)告項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告421.開(kāi)發(fā)文檔開(kāi)發(fā)文檔作為軟件開(kāi)發(fā)人員前一階段工作成果的體現(xiàn)和后一階段工作依據(jù)的文檔，主要負(fù)責(zé)對(duì)軟件開(kāi)發(fā)過(guò)程進(jìn)行描述和規(guī)范。開(kāi)發(fā)文檔除了前面列表的內(nèi)容，還包括軟件的詳細(xì)技術(shù)描述，如程序邏輯、程序間相互關(guān)系、數(shù)據(jù)格式、存儲(chǔ)等。開(kāi)發(fā)文檔主要可以發(fā)揮以下幾個(gè)方面的作用：作為軟件生存期整個(gè)階段之間的通信工具，記錄生成軟件需求、設(shè)計(jì)、編碼、測(cè)試等的詳細(xì)規(guī)定和說(shuō)明；描述開(kāi)發(fā)小組的工作職責(zé)。通過(guò)規(guī)定軟件規(guī)劃設(shè)計(jì)、主題事項(xiàng)、文檔編制、質(zhì)量保證等人員的角色，來(lái)定義“如何做”和“何時(shí)做”；用作檢驗(yàn)點(diǎn)，而允許管理者評(píng)估開(kāi)發(fā)進(jìn)度。如果開(kāi)發(fā)文檔缺失或過(guò)時(shí)，管理者將失去跟蹤和控制軟件項(xiàng)目的重要工具；形成系統(tǒng)維護(hù)人員所要求的基本的軟件支持文檔，并構(gòu)成產(chǎn)品文檔的一部分；記錄軟件開(kāi)發(fā)的歷史。442.用戶(hù)文檔用戶(hù)文檔主要負(fù)責(zé)對(duì)軟件產(chǎn)品的安裝、配置、使用、維護(hù)等信息進(jìn)行描述。包括系統(tǒng)安裝配置手冊(cè)、用戶(hù)操作手冊(cè)、軟件需求說(shuō)明書(shū)、數(shù)據(jù)要求說(shuō)明書(shū)等。用戶(hù)文檔主要發(fā)揮以下作用：為使用和運(yùn)行軟件產(chǎn)品的用戶(hù)提供培訓(xùn)和運(yùn)行參考信息；為產(chǎn)品維護(hù)工程師提供必要的信息；促進(jìn)和方便軟件產(chǎn)品的市場(chǎng)推廣。用戶(hù)文檔的提供通常可以包括以下形式： 產(chǎn)品的市場(chǎng)宣傳資料、適合管理者的產(chǎn)品指南和相關(guān)資料、提供給潛在用戶(hù)的較深入的產(chǎn)品技術(shù)資料、產(chǎn)品使用所需的完整的操作和技術(shù)資料等。用戶(hù)文檔的涉眾通常包括以下人員： 一般潛在用戶(hù)、具有決策權(quán)的潛在用戶(hù)、最終用戶(hù)、產(chǎn)品維護(hù)人員等。最基本的用戶(hù)文檔通常包括以下幾類(lèi)： 產(chǎn)品培訓(xùn)手冊(cè)、產(chǎn)品操作手冊(cè)、產(chǎn)品安裝配置手冊(cè)、產(chǎn)品支持手冊(cè)、產(chǎn)品信息廣告等。用戶(hù)文檔的分發(fā)按照涉眾的類(lèi)型進(jìn)行。不同類(lèi)型的涉眾可以獲得不同的用戶(hù)文檔。用戶(hù)文檔在分發(fā)前應(yīng)該制定合適的分發(fā)策略和計(jì)劃。463.管理文檔管理文檔主要是對(duì)軟件開(kāi)發(fā)過(guò)程的管理信息進(jìn)行描述。管理文檔除了前面列表內(nèi)容，還應(yīng)該包括被管理者的反饋信息，如各色表格、工作總結(jié)、開(kāi)發(fā)體會(huì)、產(chǎn)品建議等。管理文檔主要有以下作用：軟件初期定義、規(guī)劃、商務(wù)等與客戶(hù)互動(dòng)結(jié)果的記錄；開(kāi)發(fā)過(guò)程每個(gè)階段的進(jìn)度和進(jìn)度變更的記錄；軟件開(kāi)發(fā)人員