軟件文檔編寫

軟件文檔編寫目錄第1章軟件工程標(biāo)準(zhǔn)化與軟件文檔

1.1軟件生存周期與軟件文檔

1.2軟件文檔的作用

1.3軟件文檔分類

1.3.1開發(fā)文檔

1.3.2產(chǎn)品文檔

1.3.3管理文檔

1.4軟件工程標(biāo)準(zhǔn)化

1.4.1軟件工程標(biāo)準(zhǔn)化的意義

1.4.2軟件工程標(biāo)準(zhǔn)的層次

1.4.3中國的軟件標(biāo)準(zhǔn)

1.4.4五種常見的國際軟件標(biāo)準(zhǔn)

1.5軟件文檔編寫要求

1.5.1軟件文檔的編寫原則

1.5.2文檔編寫的靈活性

1.5.3制定文檔編寫策略

1.5.4建立企業(yè)的文檔標(biāo)準(zhǔn)

1.5.5制訂文檔編寫計劃

1.5.6建立文檔管理規(guī)程

1.5.7軟件文檔的質(zhì)量要求

1.6項目開發(fā)的文檔化

本章小結(jié)

習(xí)題

第2章CASE工具與軟件文檔編寫

2.1CAsE概述

2.2CAsE支持下的軟件建模和文檔編寫工具

2.2.1ProccssAnalYst和DataArchitcCt

2.2.2SoDA自動化文檔設(shè)計和生成

2.2.3PlayCASE

本章小結(jié)

習(xí)題

第3章可行性研究報告

3.1可行性研究概述

3.1.1可行性研究的任務(wù)

3.1.2可行性研究的步驟

3.2可行性研究報告的內(nèi)容要求與編寫指南

3.2.1可行性研究報告的引言

3.2.2可行性研究的前提

3.2.3對現(xiàn)有系統(tǒng)的分析

3.2.4對所建議系統(tǒng)的分析

3.2.5可行性分析

3.2.6可行性分析結(jié)論

3.3可行性研究報告編寫示例

本章小節(jié)

習(xí)題

實訓(xùn)1

第4章基于結(jié)構(gòu)化方法的軟件文檔

4.1軟件需求規(guī)格說明書

4.1.1需求分析概述

4.1.2軟件需求規(guī)格說明書的目的和編寫要求

4.1.3軟件需求規(guī)格說明書的內(nèi)容要求與編寫指南

4.1.4軟件需求規(guī)格說明書示例

4.2概要設(shè)計說明書

4.2.1概要設(shè)計概述

4.2.2概要設(shè)計說明書的內(nèi)容要求與編寫指南

4.2.3概要設(shè)計說明書示例

4.3詳細設(shè)計說明書

4.3.1詳細設(shè)計概述

4.3.2詳細設(shè)計說明書的內(nèi)容要求和編寫指南

4.3.3詳細設(shè)計說明書示例

本章小結(jié)

習(xí)題

實訓(xùn)2

第5章基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說明書

5.1面向?qū)ο蟮能浖枨蠓治龈攀?/p>

5.2軟件需求規(guī)格說明書的內(nèi)容要求與編寫指南

5.2.1引言

5.2.2項目概述

5.2.3需求規(guī)定

5.3用例說明書的內(nèi)容及編寫要點

5.4基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說明書示例

本章小結(jié)

習(xí)題

實訓(xùn)3

第6章基于面向?qū)ο蠓椒ǖ能浖O(shè)計說明書

6.1面向?qū)ο筌浖O(shè)計概述

6.2面向?qū)ο蟮能浖O(shè)計說明書的內(nèi)容要求和編寫指南

6.2.1類報告

6.2.2用例實現(xiàn)報告

6.2.3設(shè)計模型報告

6.3面向?qū)ο笤O(shè)計文檔的編寫示例

本章小結(jié)

實訓(xùn)4

第7章程序代碼的文檔化

7.1程序代碼規(guī)范

7.2Doxygen應(yīng)用基礎(chǔ)

7.2.1安裝Doxygen

7.2.2設(shè)置項目的Doxygen配置文件模板

7.2.3編寫正確格式的注釋

7.2.4制作說明文件

7.2.5Doxygen使用步驟及范例

本章小結(jié)

習(xí)題

實訓(xùn)5

第8章面向?qū)ο鬁y試文檔

8.1面向?qū)ο鬁y試概述

8.1.1面向?qū)ο鬁y試的具體任務(wù)

8.1.2面向?qū)ο鬁y試的步驟

8.2面向?qū)ο鬁y試文檔

8.2.1測試計劃

8.2.2測試用例

8.2.3測試報告

8.3面向?qū)ο鬁y試文檔的內(nèi)容要求和編寫指南

8.3.1引言

8.3.2項目背景

8.3.3質(zhì)量目標(biāo)

8.3.4測試資源

8.3.5測試策略

8.3.6測試計劃

本章小結(jié)

習(xí)題

實訓(xùn)6

參考文獻第1章軟件工程標(biāo)準(zhǔn)化與軟件文檔學(xué)習(xí)目標(biāo)軟件生存周期與軟件文檔。軟件文檔的作用與分類。軟件工程標(biāo)準(zhǔn)化的意義和作用。軟件工程標(biāo)準(zhǔn)的分類方法，軟件工程標(biāo)準(zhǔn)的制定與推行過程。我國的軟件工程標(biāo)準(zhǔn)化工作和相關(guān)標(biāo)準(zhǔn)。軟件是指與計算機系統(tǒng)的操作有關(guān)的計算機程序及文檔的集合。簡單地說,軟件包括程序和文檔兩部分。計算機程序是指適合于計算機處理的指令序列以及所處理的數(shù)據(jù)：軟件文檔（softwaredocument）是與軟件開發(fā)、維護和使用有關(guān)的文字材料,如技術(shù)文檔、設(shè)計文檔、版本說明文檔等，文檔和程序共同構(gòu)成了能完成特定功能的計算機軟件。可以說，沒有文檔的軟件，不能稱其為軟件，更不能成為軟件產(chǎn)品。1.1軟件生存周期與軟件文檔軟件生存周期由計劃、開發(fā)和運行三個時期組成,每一時期可再細分一些工作階段。文檔是與軟件生存周期緊密關(guān)聯(lián)的。計劃時期可以把計劃時期再細分為幾個階段:（1）問題定義（2）可行性研究（3）制訂開發(fā)計劃2.開發(fā)時期（1）需求分析確定系統(tǒng)的功能、性能和其他方面的要求:系統(tǒng)必須做什么?對所要解決的問題進行詳細定義,這需要軟件開發(fā)人員和用戶共同討論決定,哪些需求是可以滿足的,并加以確切地描述。編寫軟件需求說明書、初步用戶手冊、確認測試計劃和數(shù)據(jù)要求說明書等。（2）概要設(shè)計根據(jù)軟件需求說明書的要求,確定系統(tǒng)的事務(wù)處理流程,確定軟件的總體結(jié)構(gòu)和全局數(shù)據(jù)結(jié)構(gòu),并對輸入和輸出、安全性控制等方面做出全局性規(guī)劃,從而回答系統(tǒng)應(yīng)該怎么做才能滿足需求規(guī)格說明書的規(guī)定。編寫軟件概要設(shè)計說明書。（3）詳細設(shè)計將整個系統(tǒng)分解成若干個子系統(tǒng)或模塊,定義子系統(tǒng)或模塊間的接口關(guān)系,對各子系統(tǒng)進行具體設(shè)計定義。編寫軟件詳細設(shè)計說明書,數(shù)據(jù)庫或數(shù)據(jù)結(jié)構(gòu)設(shè)計說明書,組裝測試計劃。（4）編碼把軟件設(shè)計轉(zhuǎn)換成計算機可以接受的程序,即寫成以某一程序設(shè)計語言表示的源程序清單。（5）測試和排錯設(shè)法找到程序的潛在錯誤,并加以修正,以提高軟件的正確性和可靠性。3.運行時期編寫軟件問題報告、軟件修改報告。軟件文檔的作用1.管理依據(jù)2.任務(wù)之間聯(lián)系的憑證3.質(zhì)量保證4.培訓(xùn)與參考5.軟件維護支持6.歷史檔案1.3軟件文檔分類一般說來,軟件文檔可分為以下三種類別:開發(fā)文檔——描述開發(fā)過程本身。產(chǎn)品文檔——描述開發(fā)過程的產(chǎn)物。管理文檔——記錄項目管理的信息。1.3.1開發(fā)文檔開發(fā)文檔是描述軟件開發(fā)過程,包括軟件需求、軟件設(shè)計、軟件測試、保證軟件質(zhì)量的一類文檔,開發(fā)文檔也包括軟件的詳細技術(shù)描述（程序邏輯、程序間的相互關(guān)系、數(shù)據(jù)格式和存儲等）。開發(fā)文檔所起的作用可歸納如下:它們是軟件開發(fā)過程中包含的所有階段之間的通信工具,它們記錄生成軟件需求、設(shè)計、編碼和測試的詳細規(guī)定和說明。它們描述開發(fā)小組的職責(zé)。通過規(guī)定軟件、主題事項、文檔編制、質(zhì)量保證人員以及包含在開發(fā)過程中任何其他事項的角色來定義如何做和何時做。它們用作檢驗點而允許管理者評定開發(fā)進度。如果開發(fā)文檔丟失、不完整或過時,管理者將失去跟蹤和控制軟件項目的一個重要工具。它們形成了維護人員所要求的基本的軟件支持文檔。而這些支持文檔可作為產(chǎn)品文檔的一部分。它們記錄軟件開發(fā)的歷史?；镜拈_發(fā)文檔是:可行性研究和項目任務(wù)書。軟件需求規(guī)格說明。軟件功能規(guī)格說明。軟件設(shè)計規(guī)格說明,包括程序和數(shù)據(jù)規(guī)格說明。開發(fā)計劃。軟件集成和測試計劃。質(zhì)量保證計劃、標(biāo)準(zhǔn)、進度。安全和測試信息。1.3.2產(chǎn)品文檔產(chǎn)品文檔規(guī)定關(guān)于軟件產(chǎn)品的使用、維護、增強、轉(zhuǎn)換和傳輸?shù)男畔?。產(chǎn)品文檔起到如下作用:為使用和運行軟件產(chǎn)品的任何人規(guī)定培訓(xùn)和參考信息。使得那些未參加開發(fā)本軟件的程序員維護它。促進軟件產(chǎn)品的市場流通或提高可接受性。產(chǎn)品文檔用于下列類型的讀者:用戶——他們利用軟件輸入數(shù)據(jù)、檢索信息和解決問題。運行者——他們在計算機系統(tǒng)上運行軟件。維護人員——他們維護、增強或變更軟件。產(chǎn)品文檔包括如下內(nèi)容:用于管理者的指南和資料,它們是用來監(jiān)督軟件的使用的。宣傳資料,用于通告軟件產(chǎn)品的可用性并詳細說明它的功能、運行環(huán)境等。一般信息,用來對任何有興趣的人描述軟件產(chǎn)品?；镜漠a(chǎn)品文檔包括:培訓(xùn)手冊、參考手冊和用戶指南、軟件支持手冊、產(chǎn)品手冊和信息廣告等。1.3.3管理文檔1.4軟件工程標(biāo)準(zhǔn)化1.4.1軟件工程標(biāo)準(zhǔn)化的意義軟件工程的標(biāo)準(zhǔn)化會給軟件開發(fā)工作帶來許多好處,比如:提高軟件的可靠性、可維護性和可移植性（這表明軟件工程標(biāo)準(zhǔn)化可提高軟件產(chǎn)品的質(zhì)量）。提高軟件的生產(chǎn)率,提高軟件人員的技術(shù)水平。提高軟件人員之間的通信效率,減少差錯和誤解。有利于軟件管理。有利于降低軟件產(chǎn)品的成本和運行維護成本。有利于縮短軟件開發(fā)周期。1.4.2軟件工程標(biāo)準(zhǔn)的層次(1)國際標(biāo)準(zhǔn)(2)國家標(biāo)準(zhǔn)由政府或國家級的機構(gòu)制定或批準(zhǔn),適用于全國范圍的標(biāo)準(zhǔn),如:GB——中國的國家標(biāo)準(zhǔn)，簡稱“國標(biāo)”（GB）。由中國國家標(biāo)準(zhǔn)化管理委員會（我國的最高標(biāo)準(zhǔn)化管理機構(gòu)）公布并實施?，F(xiàn)已批準(zhǔn)了若干個軟件工程標(biāo)準(zhǔn)。ANSI——美國國家標(biāo)準(zhǔn)學(xué)會（AmericanNationalStandardsInstitute）是美國政府認可的國家標(biāo)準(zhǔn)化團體,具有一定權(quán)威性，它所頒布的標(biāo)準(zhǔn)均冠以ANSI字樣。FIPS/NBS（FederalInformationProcessingStandards/NationalBureauofStandards）——國商務(wù)部國家標(biāo)準(zhǔn)局聯(lián)邦信息處理標(biāo)準(zhǔn)。NBS所公布的標(biāo)準(zhǔn)均冠有FIPS字樣。(3)行業(yè)標(biāo)準(zhǔn)(4)企業(yè)規(guī)范(5)行業(yè)規(guī)范1.4.3中國的軟件標(biāo)準(zhǔn)1.可行性研究招告2.項目開發(fā)計劃3.軟件需求說明書4.數(shù)據(jù)要求說明書5.概要設(shè)計說明書6.詳細設(shè)計說明書7.數(shù)據(jù)庫設(shè)計說明書8.用戶手冊9.操作手冊10.模塊開發(fā)卷宗11.測試計劃12.測試分析報告13.開發(fā)進度月報14.項目開發(fā)總結(jié)報告1.4.4五種常見的國際軟件標(biāo)準(zhǔn)1.IEEE軟件工程標(biāo)準(zhǔn)（1）歷史（2）涵蓋范圍（3）目的（4）組織架構(gòu)（5）使用對象（6）應(yīng)用領(lǐng)域第一卷(CustomerandTerminologyStandards，客戶與術(shù)語之標(biāo)準(zhǔn))的應(yīng)用領(lǐng)域如下：第二卷(ProcessStandards，過程標(biāo)準(zhǔn))的應(yīng)用領(lǐng)域如下：第三卷(ProductStandards，產(chǎn)品標(biāo)準(zhǔn))的應(yīng)用領(lǐng)域如下：第四卷(ResourceandTechniqueStandards，資源與技術(shù)標(biāo)準(zhǔn))的舉例如下：（7）修訂頻率2.ISO/IEC/IEEE/EIA12207（2）歷史（2）涵蓋范圍（3）目的（4）組織架構(gòu)ISO/IEC12207共包括了3種型態(tài)的軟件開發(fā)過程：主要過程、輔助過程和組織過程，其分類層次如下：1）主要過程(primarylifecycleprocesses)獲得(acquisition)供應(yīng)(supply)開發(fā)(development)運作(operation)維護(maintenance)

2）輔助過程(supportinglifecycleprocesses)文檔(documentation)配置管理(configurationmanagement)質(zhì)量保證(qualityassurance)驗證(verification)確認(validation)聯(lián)合評審(jointreview)審計(audit)

3）組織過程(organizationallifecycleprocesses)管理(management)基礎(chǔ)建設(shè)(infrastructure)改善(improvement)培訓(xùn)(training)

使用對象（5）應(yīng)用領(lǐng)域（6）修訂頻率3.SELRecommendedApproach（1）歷史（2）內(nèi)容（3）目的（4）組織架構(gòu)（5）使用對象（6）應(yīng)用范圍（7）修訂頻率4.SSDMStandardsandProcedures（1）歷史（2）內(nèi)容（3）目的（4）組織架構(gòu)SSDM標(biāo)準(zhǔn)和規(guī)則共分為如下7章，括號中的數(shù)字表示每一個章節(jié)所包含標(biāo)準(zhǔn)和程序的數(shù)目：項目管理(33)系統(tǒng)工程(3)硬件發(fā)展(3)軟件開發(fā)(24)系統(tǒng)測試與評估(3)文件(32)標(biāo)準(zhǔn)和規(guī)程的建立(3)（5）使用對象（6）應(yīng)用范圍（7）修訂頻率5.ISO9000系列標(biāo)準(zhǔn)（1）歷史（2）內(nèi)容（3）目的（4）組織架構(gòu)結(jié)構(gòu)上，ISO9001:1994分為下面20種需求，而ISO9000-3:1997也具有相同的組織架構(gòu)：管理責(zé)任(managementresponsibility)品質(zhì)系統(tǒng)(qualitysystem)合約審查(contractreview)設(shè)計管制(designcontrol)文件及資料之管制(documentanddatacontrol)采購(purchasing)客戶供應(yīng)品之管制(controlofcustomer-suppliedproduct)產(chǎn)品鑒別與追溯性(productidentificationandtraceability)過程管制(processcontrol)檢驗與測試(inspectionandtesting)檢驗、量測與測試設(shè)備之管制(controlofinspection,measuringandtestequipment)檢驗與測試狀況(inspectionandteststatus)不合格品之管制(controlofnonconformingproduct)矯正及預(yù)防措施(correctiveandpreventiveaction)搬運、儲存、包裝、保存與交貨(handling,storage,packaging,preservationanddelivery)品質(zhì)紀(jì)錄之管制(controlofqualityrecords)內(nèi)部品質(zhì)稽核(internalqualityaudits)教育訓(xùn)練(training)服務(wù)(Servicing)統(tǒng)計技術(shù)(Statisticaltechniques)（5）使用對象（6）應(yīng)用范圍（7）修訂頻率1.5軟件文檔編寫要求1.5.1軟件文檔的編寫原則1.應(yīng)適應(yīng)文檔的讀者2.應(yīng)有必要的重復(fù)性3.應(yīng)具有一定的靈活性1.5.2文檔編寫的靈活性1.文檔的種類(1)應(yīng)該編制哪幾種文檔，詳細程度如何。(2)各個文檔的編制負責(zé)人和進度要求。(3)審查、批準(zhǔn)的負責(zé)人和時間進度安排。(4)在開發(fā)時期內(nèi)，各文檔的維護、修改和管理的負責(zé)人以及批準(zhǔn)手續(xù)。2.文檔的詳細程度3.文檔的擴展項目開發(fā)計劃可能包括以下內(nèi)容：質(zhì)量保證計劃配置管理計劃用戶培訓(xùn)計劃安裝實施計劃系統(tǒng)設(shè)計說明書可劃分成以下內(nèi)容：系統(tǒng)設(shè)計說明書子系統(tǒng)設(shè)計說明書程序設(shè)計說明書可劃分成以下內(nèi)容：程序設(shè)計說明書接口設(shè)計說明書版本說明 操作手冊可劃分成以下內(nèi)容：操作手冊安裝實施過程測試計劃可劃分成以下內(nèi)容：測試計劃測試設(shè)計說明測試規(guī)程測試用例測試分析報告可劃分成以下內(nèi)容：綜合測試報告驗收測試報告4.章節(jié)的擴張與縮并5.程序設(shè)計的表現(xiàn)形式6.文檔的表現(xiàn)形式7.文檔的其它種類1.5.3制定文檔編制策略1.文檔需要覆蓋整個軟件生存周期2.文檔應(yīng)是可管理的3.文檔應(yīng)適合于它的讀者4.文檔的作用應(yīng)貫穿軟件的整個開發(fā)過程5.應(yīng)當(dāng)采用并標(biāo)明文檔標(biāo)準(zhǔn)6.應(yīng)規(guī)定支持工具1.5.4建立企業(yè)的文檔標(biāo)準(zhǔn)1.選擇軟件生存周期模型2.規(guī)定文檔類型和內(nèi)容3.確定文檔的質(zhì)量等級文檔的質(zhì)量可以按文檔的形式和列出的要求劃分為4級。①最低限度文檔（1級文檔）：1級文檔適合開發(fā)工作量低于一個人月的開發(fā)者自用程序。該文檔應(yīng)包括程序清單、開發(fā)記錄、測試數(shù)據(jù)和程序簡介。②內(nèi)部文檔（2級文檔）：2級文檔可用于在精心研究后被認為似乎沒有與其他用戶共享資源的專用程序。除1級文檔提供的信息外，2級文檔還包括程序清單內(nèi)足夠的注釋以幫助用戶安裝和使用程序。③工作文檔（3級文檔）：3級文檔適合于由同一單位內(nèi)若干人聯(lián)合開發(fā)的程序，或可被其他單位使用的程序。④正式文檔（4級文檔）：4級文檔適合那些要正式發(fā)行供普通使用的軟件產(chǎn)品。關(guān)鍵性程序或具有重復(fù)管理應(yīng)用性質(zhì)（如工資計算）的程序需要4級文檔。4級文檔應(yīng)遵守GB8567-1988的有關(guān)規(guī)定。1.5.5制定文檔計劃列出應(yīng)編寫文檔的目錄提示編寫文檔應(yīng)參考的標(biāo)準(zhǔn)指定文檔管理員提供編寫文檔所需要的條件，落實文檔編寫人員、所需經(jīng)費以及編寫工具等明確保證文檔質(zhì)量的方法，為了確保文檔內(nèi)容的正確性、合理性，應(yīng)采取一定的措施，如評審、鑒定等。繪制進度表，以圖表形式列出在軟件生存周期各階段應(yīng)產(chǎn)生的文檔、編制人員、編制日期、完成日期、評審日期等1.5.6建立文檔管理規(guī)程文檔管理規(guī)程是關(guān)于文檔的計劃、編寫、評審、制作和分發(fā)的步驟，這些規(guī)程包含審批、質(zhì)量保證及若干控制點，規(guī)定了修改步驟、存儲和維護要求以及更新方法。1.制訂文檔計劃2.編寫文檔按文檔計劃規(guī)定的文檔數(shù)量和質(zhì)量要求編寫文檔。按GB8567-1988或單位制定的標(biāo)準(zhǔn)內(nèi)容和格式編寫相應(yīng)文檔。文檔用紙的格式由各單位按有關(guān)標(biāo)準(zhǔn)規(guī)定執(zhí)行。每個文檔必須裝訂成冊，并加封面和目錄。歸檔用的文檔還應(yīng)有扉頁，用于各責(zé)任者的簽署。3.文檔編號4.文檔評審(1)評審的內(nèi)容(2)需求評審(3)設(shè)計評審(4)其它評審編排方式。技術(shù)準(zhǔn)確度。覆蓋范圍的完整性。對讀者的適合程度。圖表設(shè)計思想及最終圖表（也應(yīng)接受關(guān)于技術(shù)準(zhǔn)確度、適合程度和完整性的單獨評審）。在語法、標(biāo)點及其他行文技巧方面的正確性。對格式和別的標(biāo)準(zhǔn)的遵守程度。(5)評審程序評審?fù)ǔ２捎迷u審會的方式進行。其一般步驟如下。有軟件開發(fā)單位負責(zé)人、用戶代表、開發(fā)小組成員、科技管理人員和標(biāo)準(zhǔn)化人員等組成評審小組，必要時還可邀請外單位的專家參加。開會前，由開發(fā)單位負責(zé)人確定評審的具體內(nèi)容，并將評審材料發(fā)給評審小組成員，要求做好評審準(zhǔn)備。由開發(fā)單位負責(zé)人主持評審會，根據(jù)文檔編制者對該文檔的說明和評審條目，由評審小組成員進行評議、評審，評審結(jié)束時應(yīng)做出評審結(jié)論，評審小組成員應(yīng)在評審結(jié)論上簽字。5.文檔的簽署6.文檔歸檔與保管7.文檔維護1.5.7軟件文檔的質(zhì)量要求缺乏實踐經(jīng)驗，缺乏評價文檔質(zhì)量的標(biāo)準(zhǔn)。不重視文檔編寫工作，或是對文檔編寫工作的安排不恰當(dāng)。高質(zhì)量的軟件文檔應(yīng)具備以下幾個方面的特點。（1）針對性（2）精確性（3）清晰性（4）完整性（5）靈活性（6）可追溯性1.6項目開發(fā)的文檔化與客戶和其他項目組的所有往來必須有記錄。對所有的活動都有一個跟蹤落實的過程，比如對所有的審查記錄和更改請求都進行標(biāo)記，通過跟蹤其狀態(tài)來監(jiān)督落實情況。對所有的活動，包括對文檔和代碼的更改都會有歷史記錄。記錄都是通過定量的數(shù)值或者專業(yè)工具加以記錄，強調(diào)以數(shù)據(jù)說話，比較準(zhǔn)確、客觀。第二章CASE工具與軟件文檔編寫學(xué)習(xí)目標(biāo)CASE工具的意義和作用。CASE工具支持下的文檔編寫2.1CASE概述CASE（ComputerAidedSoftwareEngineering，計算機輔助軟件工程）并不是一種全新的技術(shù)，而是建立在許多實際中已被證明是行之有效的技術(shù)和工具基礎(chǔ)之上的技術(shù)。從這種意義上說,CASE也可以被定義為“用自動化手段對結(jié)構(gòu)化概念和設(shè)計方法重新進行組裝”。2.2case支持下的軟件建模和文檔編寫工具2.2.1processanalyst和dataarchitect1.ProcessAnalystProcessAnalyst模塊的基本功能是通過建立過程分析模型，幫助系統(tǒng)分析人員收集數(shù)據(jù)，編寫數(shù)據(jù)字典，并繪制數(shù)據(jù)流圖。其基本功能主要包括：對象建模技術(shù)（OMT）和數(shù)據(jù)流圖（DFD）。建立層次化的處理模型。定制和打印模型文檔。從（概念數(shù)據(jù)模型CDM）中引入數(shù)據(jù)項。應(yīng)用對象鏈接與嵌入（OLE）技術(shù)鏈接和嵌入其他應(yīng)用程序中的對象。在結(jié)構(gòu)化系統(tǒng)分析與設(shè)計中，可以采用多種方法建立過程分析模型，ProcessAnalyst支持一下4種典型的模型方法：對象模型技術(shù)（ObjectModelingTechnique,OMT）功能模型。Yourdon/DeMarco方法。Gane&Sarson方法。結(jié)構(gòu)化系統(tǒng)分析與設(shè)計方法（Structuredsystemanalysisanddesignmethodology，SSADM）。DataArchitectDataArchitect具有如下功能：用實體-關(guān)系圖為信息系統(tǒng)建模。在DataArchitect中，這種實體-關(guān)系圖叫做概念數(shù)據(jù)模型，這是概念層次上的建模?；谀骋粩?shù)據(jù)庫管理系統(tǒng)生成相應(yīng)的物理數(shù)據(jù)模型，這是物理層次上的建模。定制物理數(shù)據(jù)模型以滿足物理上和性能上的要求，這是對物理數(shù)據(jù)模型的維護。為目標(biāo)數(shù)據(jù)庫管理系統(tǒng)生成一個數(shù)據(jù)庫創(chuàng)建腳本。如果目標(biāo)數(shù)據(jù)庫支持，生成參照完整性觸發(fā)器。定制并打印模型報告，生成概念數(shù)據(jù)模型和物理數(shù)據(jù)模型的設(shè)計文檔。從現(xiàn)在數(shù)據(jù)模型的對象定義擴展屬性，利用擴展屬性在4GL用戶界面和物理數(shù)據(jù)模型之間傳遞信息，實現(xiàn)數(shù)據(jù)庫設(shè)計與用戶界面的接口。報告生成器2.2.2SoDA自動化文檔設(shè)計和生成1.SoDA的功能與特點Rational公司提供的SoDA是一種強有力的軟件文檔自動生成器。它使軟件文檔的生成實現(xiàn)了自動化,簡化了軟件開發(fā)中文檔的生成過程,SoDA全面收集軟件開發(fā)周期中各階段信息并以之為基礎(chǔ)制作文檔。極大提高了文檔的可用性、易用性和連貫性,使文檔更加有效。SoDA可定制支持任何文檔標(biāo)準(zhǔn),從各種軟件開發(fā)工具中截取數(shù)據(jù),并可與各種支持編程語言的工具協(xié)同工作。對SoDA的良好性能可概括如下:可自動從軟件工程工具中獲得信息。可使用文字處理工具直接添加并保存補充的信息。無需編程即可定制文檔模板。使用SoDA,可以創(chuàng)建基于ISO9000,IEEE標(biāo)準(zhǔn)的文檔模板,或是符合用戶內(nèi)部文檔標(biāo)準(zhǔn)的模板。可檢查文檔和信息源的一致性?？缮珊筒粩喔挛臋n?？墒褂枚嘈畔⒃瓷梢粋€單一的文檔?？商峁┱麄€生命周期文檔自動化功能?？商峁π枨蟾櫟闹С帧？梢奡oDA是一個提供了有效的自動化功能且又具備手工生成靈活性的文檔生成工具?；谝陨显?建議在軟件文檔寫作,尤其是面向?qū)ο蠓治龊驮O(shè)計的文檔寫作時,宜采用SoDA作為軟件文檔寫作的輔助工具。2.2.3PlayCASEPlayCASE全面支持快速應(yīng)用開發(fā),支持集成化的業(yè)務(wù)調(diào)查、需求定義、總體設(shè)計、詳細設(shè)計,支持Oracle、Sybase、MSSQLServer等大型數(shù)據(jù)庫,支持PowerBuilder、VB、Access、VC++、Delphi等開發(fā)工具。對企業(yè)組織結(jié)構(gòu)與業(yè)務(wù)流程分析、業(yè)務(wù)數(shù)據(jù)搜集、軟件結(jié)構(gòu)與流程設(shè)計、數(shù)據(jù)庫概念設(shè)計、邏輯設(shè)計、物理設(shè)計都提供了可視化的支持。能自動生成業(yè)務(wù)調(diào)查表、需求分析說明書、軟件設(shè)計說明書、程序框架第三章可行性研究報告學(xué)習(xí)目標(biāo)可行性分析概述可行性研究報告的內(nèi)容要求與編寫指南可行性分析示例3.1可行性分析概述在軟件開發(fā)的第一個階段,即可行性研究與計劃階段,主要任務(wù)是了解用戶的要求和現(xiàn)實環(huán)境,研究并論證項目的可行性,提出系統(tǒng)方案,制訂初步的項目開發(fā)計劃。可行性研究報告是這個階段工作的主要結(jié)果和完成的標(biāo)志之一。3.1.1可行性研究的任務(wù)對每種方案都應(yīng)該仔細研究它的可行性,一般說來,至少應(yīng)該從下述四個方面研究每種方案的可行性:（1）經(jīng)濟可行性（2）技術(shù)可行性（3）社會因素方面的可行性,包括法律可行性和使用可行性（4）方案的選擇3.2.2可行性研究的步驟典型的可行性研究過程有下述一些步驟:（1）復(fù)查系統(tǒng)規(guī)模和目標(biāo)（2）研究目前正在使用的系統(tǒng)（3）導(dǎo)出新系統(tǒng)的高層邏輯模型（4）重新定義問題（5）導(dǎo)出和評價供選擇的方案（6）推薦行動方針（7）編寫計劃任務(wù)書（8）編寫文檔提交審查3.2可行性研究報告的內(nèi)容要求與編寫指南可行性研究報告的引言在本文檔中要列出本文件中用到的專門術(shù)語的定義和外文縮略語的全稱，還要列出參考資料，參考資料包括:①本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機關(guān)的批文。②屬于本項目的其他已發(fā)表的文件。本文件中各處引用的文件、資料,包括所需用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位,說明這些文件資料的來源?？尚行匝芯繄蟾娴那疤峥尚行匝芯繄蟾娴牡诙梼?nèi)容是說明對所建議的開發(fā)項目進行可行性研究的前提,如,要求、目標(biāo)、假定、限制等。將其分成三個子文檔,序號分別為A2-1、A2-2、A2-3。A2-1說明項目的基本要求,包括功能、性能、I/O數(shù)據(jù)、數(shù)據(jù)流程和處理流程、安全保密、與其他系統(tǒng)的聯(lián)系、期限要求、其他要求等。對所建議開發(fā)的軟件的基本要求包括:①功能要求。②性能要求。③對系統(tǒng)的每項輸出,如,報告、文件或數(shù)據(jù),要說明其特征,如,用途、產(chǎn)生頻度、接口以及分發(fā)對象。④給出系統(tǒng)的輸入,包括數(shù)據(jù)的來源、類型、數(shù)量、數(shù)據(jù)的組織以及提供的頻度。⑤給出系統(tǒng)的處理流程和數(shù)據(jù)流程,要用圖表的方式表示出最基本的數(shù)據(jù)流程和處理流程,并輔之以敘述。⑥在安全與保密方面的要求。⑦同本系統(tǒng)相連接的其他系統(tǒng)。⑧系統(tǒng)的最后完成期限。建議系統(tǒng)的主要開發(fā)目標(biāo)包括:①人力與設(shè)備費用的減少。②處理速度的提高。③控制精度或生產(chǎn)能力的提高。④管理信息服務(wù)的改進。⑤自動決策系統(tǒng)的改進。⑥人員利用率的改進。項目開發(fā)條件、假定和限制一般包括如下內(nèi)容:①所建議系統(tǒng)的運行壽命的最小值。②進行系統(tǒng)方案選擇、比較的時間。③經(jīng)費、投資方面的來源和限制。④法律和政策方面的限制。⑤可利用的信息和資源。⑥系統(tǒng)投入使用的最晚時間。3.2.3對現(xiàn)有系統(tǒng)的分析可行性研究報告的第三個內(nèi)容是對現(xiàn)有系統(tǒng)的分析。這里的現(xiàn)有系統(tǒng)是指當(dāng)前實際使用的系統(tǒng),這個系統(tǒng)可能是計算機系統(tǒng),也可能是一個機械系統(tǒng)甚至是一個人工系統(tǒng)。分析現(xiàn)有系統(tǒng)的目的是進一步闡明建議開發(fā)新系統(tǒng)或修改現(xiàn)有系統(tǒng)的必要性。A3-2說明了現(xiàn)有系統(tǒng)的簡明情況,包括工作負荷、費用開支、人員設(shè)備、局限性、其他情況等。工作負荷指現(xiàn)有系統(tǒng)所承擔(dān)的工作及工作量。費用開支指由于運行現(xiàn)有系統(tǒng)所引起的費用開支,如,人力、設(shè)備、空間、支持性服務(wù)、材料等項開支以及開支總額。人員指為了現(xiàn)有系統(tǒng)的運行和維護所需要的人員的專業(yè)技術(shù)類別和數(shù)量。設(shè)備指現(xiàn)有系統(tǒng)所使用的各種設(shè)備。還要列出本系統(tǒng)的主要的局限性,例如,處理時間趕不上需要,響應(yīng)不及時,數(shù)據(jù)存儲能力不足,處理功能不夠等。并且要說明,為什么對現(xiàn)有系統(tǒng)的改進性維護已經(jīng)不能解決問題。3.2.4對所建議系統(tǒng)的分析首先應(yīng)該說明本系統(tǒng)的改進之處,按列出的目標(biāo),逐項說明所建議系統(tǒng)相對于現(xiàn)存系統(tǒng)具有的改進。其次說明影響,說明在建立所建議系統(tǒng)時,預(yù)期將帶來的影響,包括:①對設(shè)備的影響,說明新提出的設(shè)備要求及對現(xiàn)存系統(tǒng)中尚可使用的設(shè)備須作出的修改。②對軟件的影響,說明為了使現(xiàn)存的應(yīng)用軟件和支持軟件能夠同所建議系統(tǒng)相適應(yīng),而需要對這些軟件所進行的修改和補充。③對用戶單位機構(gòu)的影響,說明為了建立和運行所建議系統(tǒng),對用戶單位機構(gòu)、人員的數(shù)量和技術(shù)水平等方面的全部要求。④對系統(tǒng)運行過程的影響,說明所建議系統(tǒng)對運行過程的影響,如:用戶的操作規(guī)程。運行中心的操作規(guī)程。運行中心與用戶之間的關(guān)系。源數(shù)據(jù)的處理。數(shù)據(jù)進入系統(tǒng)的過程。對數(shù)據(jù)保存的要求,對數(shù)據(jù)存儲、恢復(fù)的處理。輸出的處理過程、存儲媒體和調(diào)度方法。系統(tǒng)失效的后果及恢復(fù)的處理辦法。⑤對開發(fā)的影響,說明對開發(fā)的影響,如:為了支持所建議系統(tǒng)的開發(fā),用戶需進行的工作。為了建立一個數(shù)據(jù)庫所要求的數(shù)據(jù)資源。為了開發(fā)和測驗所建議系統(tǒng)而需要的計算機資源。所涉及的保密與安全問題。⑥對地點和設(shè)施的影響,說明對建筑物改造的要求及對環(huán)境設(shè)施的要求。⑦對經(jīng)費開支的影響,扼要說明為了所建議系統(tǒng)的開發(fā)、設(shè)計和維持運行而需要的各項經(jīng)費開支。最后要說明系統(tǒng)的局限性,說明所建議系統(tǒng)尚存在的局限性以及這些問題未能消除的原因。3.2.5可行性分析技術(shù)條件方面的可行性包括如下內(nèi)容:①在當(dāng)前的限制條件下,該系統(tǒng)的功能目標(biāo)能否達到。②利用現(xiàn)有的技術(shù),該系統(tǒng)的功能能否實現(xiàn)。③對開發(fā)人員的數(shù)量和質(zhì)量的要求并說明這些要求能否滿足。④在規(guī)定的期限內(nèi),本系統(tǒng)的開發(fā)能否完