軟件開發(fā)需求文檔_第1頁
軟件開發(fā)需求文檔_第2頁
軟件開發(fā)需求文檔_第3頁
軟件開發(fā)需求文檔_第4頁
軟件開發(fā)需求文檔_第5頁
已閱讀5頁,還剩49頁未讀 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

1、目錄1. 范圍2. 總體要求2.1總體功能要求 2.2軟件開發(fā)平臺(tái)要求 2.3軟件項(xiàng)目的開發(fā)實(shí)施過程管理要求 2.3.1軟件項(xiàng)目實(shí)施過程總體要求2.3.2軟件項(xiàng)目實(shí)施變更要求 2.3.3軟件項(xiàng)目實(shí)施里程碑控制3. 軟件開發(fā)3.1軟件的需求分析 3.1.1需求分析3.1.2需求分析報(bào)告的編制者 3.1.3需求報(bào)告評(píng)審3.1.4需求報(bào)告格式3.2軟件的概要設(shè)計(jì) 3.2.1概要設(shè)計(jì)3.2.2編寫概要設(shè)計(jì)的要求3.2.3概要設(shè)計(jì)報(bào)告的編寫者 3.2.4概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別 3.2.5概要設(shè)計(jì)的評(píng)審3.2.6 概要設(shè)計(jì)格式 3.3軟件的詳細(xì)設(shè)計(jì) 3.3.1詳細(xì)設(shè)計(jì)3.3.2特例3

2、.3.3詳細(xì)設(shè)計(jì)的要求3.3.4 數(shù)據(jù)庫設(shè)計(jì) 3.3.5詳細(xì)設(shè)計(jì)的評(píng)審3.3.6詳細(xì)設(shè)計(jì)格式 3.4軟件的編碼 3.4.1軟件編碼3.4.2軟件編碼的要求3.4.3 編碼的評(píng)審 3.4.4編程規(guī)范及要求3.5軟件的測(cè)試 3.5.1軟件測(cè)試3.5.2測(cè)試計(jì)戈U 3.6軟件的交付準(zhǔn)備 3.6.1交付清單3.7軟件的鑒定驗(yàn)收 3.7.1軟件的鑒定驗(yàn)收 3.7.2 驗(yàn)收人員 3.7.3驗(yàn)收具體內(nèi)容 3.7.4軟件驗(yàn)收測(cè)試大綱3.8培訓(xùn)3.8.1系統(tǒng)應(yīng)用培訓(xùn)3.8.2系統(tǒng)管理的培訓(xùn)(可選)附錄A軟件需求分析報(bào)告文檔模板 9附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板 21附錄C軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板 33附錄D軟件

3、數(shù)據(jù)庫設(shè)計(jì)報(bào)告文檔模板 43附錄E軟件測(cè)試(驗(yàn)收)大綱 51.范圍本指南用于指導(dǎo)軟件開發(fā)者為 *的過程,通過規(guī)范軟件項(xiàng)目承擔(dān)單位的開發(fā)過程達(dá)到 提高軟件質(zhì)量,降低維護(hù)成本的目的。 開發(fā)者應(yīng)根據(jù)本指南進(jìn)行軟件開發(fā)和編制軟件開發(fā)文 檔。本指南是對(duì)軟件項(xiàng)目承擔(dān)單位的基本要求。在本指南的附錄A至E中提供了文檔的編寫模板供開發(fā)者參考, 在進(jìn)行具體軟件開發(fā)時(shí),開發(fā)者可根據(jù)實(shí)際情況采編寫,但必須提供雙方約定的文檔,文檔中約定的內(nèi)容必須描述清楚。2. 總體要求2.1總體功能要求網(wǎng)絡(luò)應(yīng)用環(huán)境以Internet/lntranet技術(shù)為核心。開發(fā)者應(yīng)在充分分析需求的基礎(chǔ)上,選擇采用B/S結(jié)構(gòu)或者C/S結(jié)構(gòu)。軟件系統(tǒng)

4、的數(shù)據(jù)庫應(yīng)依照*規(guī)范進(jìn)行設(shè)計(jì)和建設(shè)。本指南中沒有規(guī)定開發(fā)者采用何種具體的軟件工程開發(fā)方法,開發(fā)者可根據(jù)項(xiàng)目具體特點(diǎn)、自身擅長(zhǎng)來選擇采用面向過程的方法、面向?qū)ο蟮姆椒ɑ蛎嫦驍?shù)據(jù)的方法,但建議開發(fā)商使用面向?qū)ο筌浖こ痰姆椒?,女口:采用目前被廣泛使用的RUP(Rational Unified Process)方法來進(jìn)行分析、設(shè)計(jì)和開發(fā)。2.2軟件開發(fā)平臺(tái)要求開發(fā)者開發(fā)的軟件必須能夠在*規(guī)定的軟件平臺(tái)上正常運(yùn)行。目前軟件平臺(tái)為:數(shù)據(jù)庫管理系統(tǒng):Oracle 9i以上版本中間件(應(yīng)用服務(wù)器)系統(tǒng):IBM WebSphereOA系統(tǒng):Lotus Domino/Notes網(wǎng)絡(luò)架構(gòu):完全支持TCP/IP協(xié)議

5、開發(fā)工具或技術(shù)體系:為保證軟件的上下兼容性,開發(fā)者應(yīng)選擇比較通用的開發(fā)工具的較新版本進(jìn)行開發(fā),如 Microsoft Visual Studio.Net ,Borland Delphi,C+ Builder,或 J2EE(Java2 P1atform Enterprise Edition)等。2.3軟件項(xiàng)目的開發(fā)實(shí)施過程管理要求2.3.1軟件項(xiàng)目實(shí)施過程總體要求(一)開發(fā)者提交軟件開發(fā)工作大綱,交通局組織專家組對(duì)工作大綱進(jìn)行評(píng)審,并提 出整改意見。(二)通過評(píng)審后,開發(fā)者根據(jù)整改意見完善工作大綱,經(jīng)過交通局認(rèn)可后組織項(xiàng)目 組進(jìn)行軟件開發(fā)。軟件開發(fā)工作按照需求分析、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、編碼、測(cè)試

6、等 幾個(gè)階段進(jìn)行,在開發(fā)過程中,開發(fā)者需分階段提交相關(guān)文檔。(三)在軟件開發(fā)工作完成后,開發(fā)者應(yīng)向交通局提交完整的軟件文檔,交通局組織 驗(yàn)收組對(duì)軟件進(jìn)行驗(yàn)收審查。2.3.2軟件項(xiàng)目實(shí)施變更要求在開發(fā)過程中,需求或設(shè)計(jì)不可避免地需要發(fā)生變更, 相關(guān)變更必須經(jīng)過交通局書面同 意方可進(jìn)行。在需求或設(shè)計(jì)發(fā)生變更時(shí), 需要對(duì)原有文檔進(jìn)行修改, 并提供完整的變更記錄, 以使變更處于可控制的狀態(tài)。變更單如下表所示:表2-1變更單需求變更申請(qǐng)申請(qǐng)變更的需求文檔輸入名稱,版本,日期等信息變更的內(nèi)客及其理由評(píng)估需求變更將對(duì) 項(xiàng)目造成的影響申請(qǐng)人簽字變更申請(qǐng)的審批意見項(xiàng)目經(jīng)理簽字審批意見:簽字日期客戶簽字(合同項(xiàng)目

7、)審批意見:簽字日期更改需求文檔變更后的需求文檔輸入名稱,版本,完成日期等信息更改人簽字重新評(píng)審需求文檔需求評(píng)審小組簽字評(píng)審意見:簽字日期變更結(jié)束項(xiàng)目經(jīng)理簽字簽字日期2.3.3軟件項(xiàng)目實(shí)施里程碑控制交通局將分四個(gè)階段進(jìn)行把關(guān),召開專家審查會(huì)。(一)需求分析(結(jié)合原型進(jìn)行審查)確認(rèn);(二)概要設(shè)計(jì)+數(shù)據(jù)庫設(shè)計(jì);(三)預(yù)驗(yàn)收(試運(yùn)行后);(四)正式驗(yàn)收(推廣使用后)。3. 軟件開發(fā)合同簽訂以后,項(xiàng)目承擔(dān)單位即可組織項(xiàng)目組進(jìn)行軟件開發(fā)工作。軟件開發(fā)必須嚴(yán)格按照軟件工程的要求進(jìn)行。開發(fā)過程包括開發(fā)者的活動(dòng)和任務(wù)。此過程由軟件需求分析、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、編碼、測(cè)試、驗(yàn)收、鑒定等活動(dòng)組成。3.1軟件的需

8、求分析3.1.1需求分析首先,開發(fā)者和交通局應(yīng)共同對(duì)交通局的應(yīng)用需求作充分的調(diào)研,提交完整的需求分析報(bào)告。在需求分析報(bào)告中必須描述的基本問題是:功能、性能、強(qiáng)加于實(shí)現(xiàn)的設(shè)計(jì)限制、屬 性、外部接口。應(yīng)當(dāng)避免把設(shè)計(jì)或項(xiàng)目需求寫入需求分析報(bào)告中。它必須說明由軟件獲得的結(jié)果,而不是獲得這些結(jié)果的手段。軟件需求可以用若干種方法來表達(dá),如通過輸入、輸出說明;使用代表性的例子; 用規(guī)范化的模型。開發(fā)者應(yīng)盡可能地使用模型的方式,因?yàn)檫@是表達(dá)復(fù)雜需求的精確和有效的方法。比如用統(tǒng)一建模語言(UML )來描述需求。編寫需求分析報(bào)告的要求a. 無歧義性對(duì)最終產(chǎn)品的每一個(gè)特性用某一術(shù)語描述;若某一術(shù)語在某一特殊的行文中

9、使用時(shí)具有多種含義,那么應(yīng)對(duì)該術(shù)語的每種含義做出解釋并指出其適用場(chǎng)合。b. 完整性需求分析報(bào)告應(yīng)該包括全部有意義的需求,無論是關(guān)系到功能的、性能的、設(shè)計(jì)約束的、還是關(guān)系到外部接口方面的需求;對(duì)所有可能出現(xiàn)的輸入數(shù)據(jù)的響應(yīng)予以定義,要對(duì)合法和非合法的輸入值的響應(yīng)做出規(guī)定;填寫全部插圖、表、圖示標(biāo)記等;定義全部術(shù)語和度量單位。c. 可驗(yàn)證性需求分析報(bào)告描述的每一個(gè)需求應(yīng)是可以驗(yàn)證的??梢酝ㄟ^一個(gè)有限處理過程來檢查軟件產(chǎn)品是否滿足需求。d. 致性在需求分析報(bào)告中的各個(gè)需求的描述不能互相矛盾。e. 可修改性需求分析報(bào)告應(yīng)具有一個(gè)有條不紊、易于使用的內(nèi)容組織; 沒有冗余,即同一需求不能在需求分析報(bào)告中出

10、現(xiàn)多次。f 可追蹤性每一個(gè)需求的源流必須清晰,在進(jìn)一步產(chǎn)生和改變文件編制時(shí),可以方便地引證每一個(gè)需求。g.運(yùn)行和維護(hù)階段的可使用性需求分析報(bào)告必須滿足運(yùn)行和維護(hù)階段的需要。在需求分析報(bào)告要寫明功能的來源和目的。3.1.2需求分析報(bào)告的編制者需求分析報(bào)告應(yīng)由交通局和開發(fā)者雙方共同完成。其中:交通局負(fù)責(zé)根據(jù)實(shí)際需要提出希望軟件實(shí)現(xiàn)的功能;軟件開發(fā)者根據(jù)交通局提出的性能需求,結(jié)合軟件開發(fā)編寫需求分析。3.1.3需求報(bào)告評(píng)審在軟件需求分析工作完成后,軟件開發(fā)者應(yīng)向交通局提交軟件需求分析報(bào)告。交通局組織有關(guān)人員對(duì)需求進(jìn)行評(píng)審, 以決定軟件需求是否完善和恰當(dāng)。 評(píng)審?fù)瓿珊?,就可以進(jìn) 入軟件的設(shè)計(jì)階段。3.

11、1.4需求報(bào)告格式軟件需求分析報(bào)告需按一定的格式進(jìn)行編寫,具體的軟件需求分析報(bào)告文檔編寫模板請(qǐng)見附錄A。3.2軟件的概要設(shè)計(jì)3.2.1概要設(shè)計(jì)在交通局和開發(fā)者雙方認(rèn)可的需求分析報(bào)告基礎(chǔ)上,開發(fā)者進(jìn)行下一一步的工作。 首先,開發(fā)者需要對(duì)軟件系統(tǒng)進(jìn)行概要設(shè)計(jì),即系統(tǒng)設(shè)計(jì)。概要設(shè)計(jì)需要對(duì)軟件系統(tǒng)的設(shè)計(jì)進(jìn)行考慮,包括系統(tǒng)的基本處理流程、系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、 運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等,為軟件的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。3.2.2編寫概要設(shè)計(jì)的要求a. 致性概要設(shè)計(jì)的要求應(yīng)該與需求分析報(bào)告所描述的需求一致。同時(shí),概要設(shè)計(jì)的各項(xiàng)要求之間也應(yīng)該一致。b. 合理性概要設(shè)計(jì)所提出的

12、設(shè)計(jì)方法和標(biāo)準(zhǔn)應(yīng)該是合理的、恰當(dāng)?shù)?。c. 可追蹤性對(duì)概要設(shè)計(jì)所提出的各項(xiàng)要求應(yīng)該可以得到它的清晰的源流,即在需求分析報(bào)告客戶有明確的需求描述。d. 可行性根據(jù)概要設(shè)計(jì)進(jìn)行詳細(xì)設(shè)計(jì)、操作和維護(hù)應(yīng)該是可行的。3.2.3概要設(shè)計(jì)報(bào)告的編寫者概要設(shè)計(jì)報(bào)告由開發(fā)者根據(jù)需求分析報(bào)告的要求進(jìn)行編寫。3.2.4概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別需求分析不涉及具體的技術(shù)實(shí)現(xiàn),而概要設(shè)計(jì)注重于從宏觀上和框架上來描述采用何 種技術(shù)手段、方法來實(shí)現(xiàn)這些需求。詳細(xì)設(shè)計(jì)相對(duì)概要設(shè)計(jì)更注重于微觀上和框架內(nèi)的設(shè)計(jì), 是編碼的依據(jù)。概要設(shè)計(jì)是指導(dǎo)詳細(xì)設(shè)計(jì)的依據(jù)。3.2.5概要設(shè)計(jì)的評(píng)審在軟件概要設(shè)計(jì)工作完成后,軟件開

13、發(fā)者應(yīng)向交通提交軟件系統(tǒng)概要設(shè)計(jì)報(bào)告。在交通局對(duì)概要設(shè)計(jì)報(bào)告評(píng)審?fù)ㄟ^后,即可進(jìn)入詳細(xì)設(shè)計(jì)階段。3.2.6概要設(shè)計(jì)格式軟件系統(tǒng)概要設(shè)計(jì)報(bào)告需按一定的格式進(jìn)行編寫,具體的軟件系統(tǒng)概要設(shè)計(jì)報(bào) 告文檔編寫模板請(qǐng)見附錄B。3.3軟件的詳細(xì)設(shè)計(jì)3.3.1詳細(xì)設(shè)計(jì)在概要設(shè)計(jì)的基礎(chǔ)上,開發(fā)者需要進(jìn)行軟件系統(tǒng)的詳細(xì)設(shè)計(jì)。在詳細(xì)設(shè)計(jì)中,描述實(shí) 現(xiàn)具體模塊所涉及到的主要算法、數(shù)據(jù)結(jié)構(gòu)、類的層次結(jié)構(gòu)及調(diào)用關(guān)系,需要說明軟件系統(tǒng) 各個(gè)層次中的每一個(gè)程序(每個(gè)模塊或子程序)的設(shè)計(jì)考慮,以便進(jìn)行編碼和測(cè)試。應(yīng)當(dāng)保證 軟件的需求完全分配給整個(gè)軟件。 詳細(xì)設(shè)計(jì)應(yīng)當(dāng)足夠詳細(xì),能夠根據(jù)詳細(xì)設(shè)計(jì)報(bào)告進(jìn)行編碼。 332特例如果軟件系統(tǒng)

14、比較簡(jiǎn)單, 層次較少,可以不必進(jìn)行專門的詳細(xì)設(shè)計(jì),而和概要設(shè)計(jì)結(jié)合起來。3.3.3詳細(xì)設(shè)計(jì)的要求a. 致性詳細(xì)設(shè)計(jì)的要求應(yīng)該與需求分析報(bào)告所描述的需求、與概要設(shè)計(jì)一致。同時(shí),詳細(xì)設(shè)計(jì)的各項(xiàng)要求之間也應(yīng)該是一致的。b. 合理性詳細(xì)設(shè)計(jì)所提出的設(shè)計(jì)方法和標(biāo)準(zhǔn)應(yīng)該是合理的、恰當(dāng)?shù)摹. 可追蹤性對(duì)詳細(xì)設(shè)計(jì)所提出的各項(xiàng)要求應(yīng)該可以得到它的清晰的源流,即可在需求分析報(bào)告、概要設(shè)計(jì)報(bào)告中有明確的需求描述。d. 可行性根據(jù)詳細(xì)設(shè)計(jì)進(jìn)行編碼、測(cè)試、操作和維護(hù)應(yīng)該是可行的。3.3.4數(shù)據(jù)庫設(shè)計(jì)如果軟件產(chǎn)品需要使用到數(shù)據(jù)庫, 軟件的詳細(xì)設(shè)計(jì)應(yīng)包括對(duì)數(shù)據(jù)庫的設(shè)計(jì)。 數(shù)據(jù)庫設(shè)計(jì) 應(yīng)在軟件的需求分析、概要設(shè)計(jì)完成之后、

15、詳細(xì)設(shè)計(jì)的其它工作之前進(jìn)行。 在進(jìn)行數(shù)據(jù)庫設(shè) 計(jì)時(shí),應(yīng)當(dāng)按照交通局制定的*市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范要求進(jìn)行。3.3.5詳細(xì)設(shè)計(jì)的評(píng)審在軟件詳細(xì)設(shè)計(jì)完成后, 軟件開發(fā)者應(yīng)向交通局提交 軟件系統(tǒng)數(shù)據(jù)庫設(shè)計(jì)報(bào)告 和軟 件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告。在交通局對(duì)軟件系統(tǒng)數(shù)據(jù)庫設(shè)計(jì)報(bào)告、軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告 評(píng)審?fù)ㄟ^后,即可進(jìn)入軟件編碼階段。3.3.6詳細(xì)設(shè)計(jì)格式軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告、軟件系統(tǒng)數(shù)據(jù)庫設(shè)計(jì)報(bào)告需按一定的格式進(jìn)行編寫, 具體的軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告文檔編寫模板和軟件系統(tǒng)數(shù)據(jù)庫設(shè)計(jì)報(bào)告文檔編寫模板請(qǐng)見附錄C、附錄D。3.4軟件的編碼3.4.1軟件編碼在軟件編碼階段,開發(fā)者根據(jù)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中對(duì)數(shù)據(jù)

16、結(jié)構(gòu)、算法分析和模塊實(shí)現(xiàn)等方面的設(shè)計(jì)要求,開始具體的編寫程序工作,分別實(shí)現(xiàn)各模塊的功能,從而實(shí)現(xiàn)對(duì) 目標(biāo)系統(tǒng)的功能、性能、接口、界面等方面的要求。3.4.2軟件編碼的要求a. 模塊化編碼b. 代碼可讀性c. 可維護(hù)性d. 模塊接口標(biāo)準(zhǔn)化e. 界面風(fēng)格統(tǒng)一e. 注釋的應(yīng)用3.4.3編碼的評(píng)審為了盡早發(fā)現(xiàn)軟件中的障礙,提高軟件產(chǎn)品的質(zhì)量, 開發(fā)者在編碼的過程中應(yīng)該強(qiáng)調(diào)代碼評(píng)審工作。將代碼評(píng)審報(bào)告作為文檔的一部分,提交給交通局。344編程規(guī)范及要求為了提高編程實(shí)現(xiàn)的質(zhì)量,軟件的程序設(shè)計(jì)必須遵照國家頒布的相關(guān)編程規(guī)范。主要內(nèi)容包括:規(guī)范化的程序內(nèi)部文檔、 數(shù)據(jù)結(jié)構(gòu)的詳細(xì)說明、清晰的語句結(jié)構(gòu)、編碼規(guī)范。

17、編碼規(guī)范的內(nèi)容包括命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī)范、熱鍵定義等。其中數(shù)據(jù)庫部分應(yīng)遵守*市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范的要求。在軟件編碼的同時(shí)應(yīng)進(jìn)行單元測(cè)試。3.5軟件的測(cè)試3.5.1軟件測(cè)試為了盡早發(fā)現(xiàn)軟件產(chǎn)品中的錯(cuò)誤,從而達(dá)到提高軟件質(zhì)量、 降低軟件維護(hù)的費(fèi)用, 開發(fā)者應(yīng)在編碼過程中對(duì)各個(gè)模塊的程序代碼進(jìn)行單元測(cè)試,系統(tǒng)集成時(shí)進(jìn)行集成測(cè)試,系統(tǒng)集成完成后對(duì)整個(gè)軟件進(jìn)行系統(tǒng)測(cè)試。單元測(cè)試是在軟件開發(fā)過程中針對(duì)程序模塊進(jìn)行正確性 檢驗(yàn)。集成測(cè)試是在單元測(cè)試的基礎(chǔ)上,將所有模塊按照設(shè)計(jì)要求組裝成系統(tǒng)或子系統(tǒng),對(duì)模塊組裝過程和模塊接口進(jìn)行正確性檢驗(yàn)。軟件系統(tǒng)測(cè)試不僅是檢測(cè)軟件的整體行為表 現(xiàn),從

18、另一個(gè)側(cè)面看,也是對(duì)軟件開發(fā)設(shè)計(jì)的再確認(rèn)。進(jìn)行軟件系統(tǒng)測(cè)試工作時(shí)。測(cè)試主要包括界面測(cè)試、可用性測(cè)試、功能測(cè)試、穩(wěn)定性(強(qiáng)度)測(cè)試、性能測(cè)試、強(qiáng)壯性(恢復(fù))測(cè)試、邏輯性測(cè)試、破壞性測(cè)試、安全性測(cè)試等。開發(fā)者針對(duì)單元測(cè)試,集成測(cè)試,系統(tǒng)測(cè)試分別制定測(cè)試計(jì)劃。集成測(cè)試需要根據(jù)需求分析報(bào)告和概要設(shè)計(jì)制作測(cè)試用例,并須經(jīng)過評(píng)審。軟件測(cè)試按照測(cè)試計(jì)劃、需求分析報(bào)告的要求進(jìn)行,最后形成軟件測(cè)試報(bào)告。3.5.2測(cè)試計(jì)劃在軟件編碼開始之前,開發(fā)者應(yīng)向交通局提交測(cè)試計(jì)劃,在軟件交付時(shí),開發(fā)者應(yīng)向交通局提交軟件測(cè)試報(bào)告,以確保開發(fā)者的軟件得到了充分的測(cè)試。開發(fā)的軟件必須 經(jīng)過充分的測(cè)試證明其符合設(shè)計(jì)要求、運(yùn)行穩(wěn)定、

19、安全可用方可交付交通局。3.6軟件的交付準(zhǔn)備3.6.1交付清單在軟件測(cè)試證明軟件達(dá)到要求后,軟件開發(fā)者應(yīng)向交通局提交開發(fā)的目標(biāo)安裝程序、數(shù)據(jù)庫的數(shù)據(jù)字典、用戶安裝手冊(cè)、用戶使用指南、需求報(bào)告、設(shè)計(jì)報(bào)告、測(cè)試報(bào)告等雙 方合同約定的產(chǎn)物。用戶安裝手冊(cè)應(yīng)詳細(xì)介紹安裝軟件對(duì)運(yùn)行環(huán)境的要求、安裝軟件的定義和內(nèi)容、在客戶端、服務(wù)器端及中間件的具體安裝步驟、安裝后的系統(tǒng)配置。用戶使用指南應(yīng)包括軟件各項(xiàng)功能的使用流程、操作步驟、相應(yīng)業(yè)務(wù)介紹、特殊提 示和注意事項(xiàng)等方面的內(nèi)容,在需要時(shí)還應(yīng)舉例說明。3.7軟件的鑒定驗(yàn)收3.7.1軟件的鑒定驗(yàn)收在軟件開發(fā)完成后,為了確保軟件是按照需求分析的要求進(jìn)行開發(fā)的,保證軟件

20、產(chǎn)品的質(zhì)量,需要對(duì)軟件產(chǎn)品進(jìn)行鑒定驗(yàn)收。在開發(fā)者如期交付軟件后,由交通局負(fù)責(zé)確定具體的鑒定驗(yàn)收日期。3.7.2驗(yàn)收人員由交通局聘請(qǐng)具有一定的分析、設(shè)計(jì)、編程和軟件測(cè)試經(jīng)驗(yàn)的驗(yàn)收組長(zhǎng)和其他專業(yè)人員 組成。驗(yàn)收組設(shè)組長(zhǎng)一名 (可設(shè)有副組長(zhǎng)),負(fù)責(zé)整個(gè)驗(yàn)收的計(jì)劃、組織工作。3.7.3驗(yàn)收具體內(nèi)容驗(yàn)收內(nèi)容應(yīng)該包括:合法性檢查、文檔檢查、軟件一致性檢查、軟件系統(tǒng)測(cè)試與測(cè)試結(jié)果評(píng)審等幾項(xiàng)工作。合法性檢查檢查軟件開發(fā)工具是否合法、使用的函數(shù)庫、控件、組件是否有合法的發(fā)布許可。文檔檢查檢查開發(fā)者提交的文檔必須齊全,質(zhì)量是否過關(guān)。需要開發(fā)者提供的文檔包括:項(xiàng)目實(shí)施計(jì)劃;詳細(xì)技術(shù)方案;軟件需求規(guī)格說明書(STP)

21、(含數(shù)據(jù)字典);概要設(shè)計(jì)說明書(PDD);詳細(xì)設(shè)計(jì)說明書(DDD)(含數(shù)據(jù)庫設(shè)計(jì)說明書);軟件測(cè)試計(jì)劃(STP)(含測(cè)試用例);軟件測(cè)試報(bào)告(STR);用戶手冊(cè)(SUM)(含操作、使用、維護(hù)、應(yīng)急處理手冊(cè));源程序(SCL)(不可修改的電子文檔);項(xiàng)目實(shí)施計(jì)劃(PIP);項(xiàng)目開發(fā)總結(jié)(PDS);軟件質(zhì)量保證計(jì)劃(SQAP);此外,驗(yàn)收組可以根據(jù)需要對(duì)其它文檔(如軟件配置計(jì)劃、項(xiàng)目進(jìn)展報(bào)表、階段評(píng)審報(bào)表等)進(jìn)行檢查。文檔的質(zhì)量根據(jù)完備性、正確性、簡(jiǎn)明性、可追蹤性、自說明性、規(guī)范件等方面進(jìn)行蹤合評(píng)定。驗(yàn)收需要對(duì)軟件代碼進(jìn)行檢查,以確保其符合規(guī)范,并檢查其一致性。3.7.4軟件驗(yàn)收測(cè)試大綱在軟件進(jìn)行

22、鑒定驗(yàn)收前,開發(fā)者需按照一定的格式編寫軟件驗(yàn)收測(cè)試大綱,具體的格式請(qǐng)見附錄E。3.8培訓(xùn)3.8.1系統(tǒng)應(yīng)用培訓(xùn)主要培訓(xùn)內(nèi)容包括:系統(tǒng)操作使用、業(yè)務(wù)管理流程。培訓(xùn)對(duì)象:應(yīng)用操作人員。3.8.2系統(tǒng)管理的培訓(xùn)(可選)主要培訓(xùn)內(nèi)容包括:系統(tǒng)安裝、調(diào)試、維護(hù);系統(tǒng)管理。培訓(xùn)對(duì)象:系統(tǒng)管理人員。開發(fā)者應(yīng)詳細(xì)列出培訓(xùn)計(jì)劃,包括培訓(xùn)內(nèi)容、教材、時(shí)間和人員等。附錄A軟件需求分析報(bào)告文檔模板1.引言1.1 編寫目的 1.2項(xiàng)目風(fēng)險(xiǎn)1.3文檔約定1.4預(yù)期讀者和閱讀建議 1.5產(chǎn)品范圍1.6 參考文獻(xiàn) 2. 綜合描述2.1產(chǎn)品的狀況2.2產(chǎn)品的功能2.3用戶類和特性 2.4運(yùn)行環(huán)境2.5 設(shè)計(jì)和實(shí)現(xiàn)上的限制 2.

23、6假設(shè)和約束(依賴)3. 外部接口需求3.1用戶界面3.2硬件接口 3.3軟件接口 3.4通訊接口 4. 系統(tǒng)功能需求 4.1 說明和優(yōu)先級(jí) 4.2激勵(lì)/響應(yīng)序列 4.3輸入/輸出數(shù)據(jù) 5. 其它非功能需求5.1性能需求5.2安全措施需求 5.3安全性需求5.4軟件質(zhì)量屬性5.5業(yè)務(wù)規(guī)則5.6 用戶文檔 6. 詞匯表7. 數(shù)據(jù)定義8. 分析模型9. 待定問題列表1.引言引言是對(duì)這份軟件產(chǎn)品需求分析報(bào)告的概覽,是為了幫助閱讀者了解這份文檔是如何編寫的,并且應(yīng)該如何閱讀、理解和解釋這份文檔。1.1編寫目的說明這份軟件產(chǎn)品需求分析報(bào)告是為哪個(gè)軟件產(chǎn)品編寫的,開發(fā)這個(gè)軟件產(chǎn)品意義、 作用、以及最終要達(dá)

24、到的意圖。 通過這份軟件產(chǎn)品需求分析報(bào)告詳盡說明了該軟件產(chǎn)品的需求 規(guī)格,包括修正和(或)發(fā)行版本號(hào),從而對(duì)該軟件產(chǎn)品進(jìn)行準(zhǔn)確的定義。如果這份軟件產(chǎn)品需求分析報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系,那么只定義軟件產(chǎn)品需求分析報(bào)告中說明的那個(gè)部分或子系統(tǒng)。1.2項(xiàng)目風(fēng)險(xiǎn)具體說明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者,以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn),首要風(fēng)險(xiǎn)承擔(dān)者包括:任務(wù)提出者;軟件開發(fā)者;產(chǎn)品使用者。1.3文檔約定描述編寫文檔時(shí)所采用的標(biāo)準(zhǔn) (如果有標(biāo)準(zhǔn)的話),或者各種排版約定。排版約定應(yīng)該包括:正文風(fēng)格;提示方式;重要符號(hào);也應(yīng)該說明高層次需求是否可以被其所有細(xì)化的需求所繼承,或者每個(gè)需求陳述是否都

25、有其自己的優(yōu)先級(jí)。1.4預(yù)期讀者和閱讀建議列舉本軟件產(chǎn)品需求分析報(bào)告所針對(duì)的各種不同的預(yù)期讀者,例如,可能包括:用戶;開發(fā)人員;項(xiàng)目經(jīng)理;營銷人員;測(cè)試人員;文檔編寫入員。并且描述了文檔中,其余部分的內(nèi)容及其組織結(jié)構(gòu),并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。1.5產(chǎn)品范圍說明該軟件產(chǎn)品及其開發(fā)目的的簡(jiǎn)短描述,包括利益和目標(biāo)。把軟件產(chǎn)品開發(fā)與企業(yè)目標(biāo),或者業(yè)務(wù)策略相聯(lián)系。描述產(chǎn)品范圍時(shí)需注意,可以參考項(xiàng)目視圖和范圍文檔, 但是不能將其內(nèi)容復(fù)制到這里。1.6參考文獻(xiàn)列舉編寫軟件產(chǎn)品需求分析報(bào)告時(shí)所用到的參考文獻(xiàn)及資料,可能包括:本項(xiàng)目的合同書; 上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文; 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃

26、任務(wù)書;用戶界面風(fēng)格指導(dǎo); 開發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)淮;系統(tǒng)規(guī)格需求說明;使用實(shí)例文檔;屬于本項(xiàng)目的其它己發(fā)表文件; 本軟件產(chǎn)品需求分析報(bào)告中所引用的文件、資料;相關(guān)軟件產(chǎn)品需求分析報(bào)告;為了方便讀者查閱, 所有參考資料應(yīng)該按一定順序排列。如果可能,每份資料都應(yīng)該給出:標(biāo)題名稱;作者或者合同簽約者;文件編號(hào)或者版本號(hào); 發(fā)表日期或者簽約日期;出版單位或者資料來源。2. 綜合描述這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運(yùn)行的環(huán)境、使用該軟件產(chǎn)品的用戶、對(duì)該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依賴。2.1產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報(bào)告中所定義的軟件產(chǎn)品的背景和起源。

27、說明了該軟件產(chǎn)品是否屬于下列情況:是否是產(chǎn)品系列中的下一成員;是否是成熟產(chǎn)品所改進(jìn)的下一代產(chǎn)品;是否是現(xiàn)有應(yīng)用軟件的替代品(升級(jí)產(chǎn)品); 是否是一個(gè)新型的、自主型的產(chǎn)品。如果該軟件產(chǎn)品需求分析報(bào)告定義的軟件系統(tǒng)是: 大系統(tǒng)的一個(gè)組成部分;與其它系統(tǒng)和其它機(jī)構(gòu)之間存在基本的相互關(guān)系。那么必須說明軟件產(chǎn)品需求分析報(bào)告定義的這部分軟件是怎樣與整個(gè)大系統(tǒng)相關(guān)聯(lián)的, 或者(同時(shí))說明相互關(guān)系的存在形式,并且要定義出兩者之間的全部接口。2.2產(chǎn)品的功能因?yàn)閷⒃谛枨蠓治鰣?bào)告的第 4部分中詳細(xì)描述軟件產(chǎn)品的功能,所以在此只需要概略地 總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能,在描述功能時(shí)應(yīng)該針對(duì)每一

28、項(xiàng)需求準(zhǔn)確地描述其各項(xiàng)規(guī)格說明。如果存在引起誤解的可能,在陳述本軟件產(chǎn)品主要功能的作 用領(lǐng)域時(shí),也需要對(duì)應(yīng)陳述本軟件產(chǎn)品的非作用領(lǐng)域,以利讀者理解本軟件產(chǎn)品。為了很好地組織產(chǎn)品功能,使每個(gè)讀者都容易理解, 可以采用列表的方法給出。 也可以采用圖形方式,將主要的需求分組以及它們之間的聯(lián)系使用數(shù)據(jù)流程圖的頂層圖或類圖進(jìn)行 表示,這種表示方法是很有用的。參考用戶當(dāng)前管理組織構(gòu)架,了解各個(gè)機(jī)構(gòu)的主要職能,將有助于陳述軟件產(chǎn)品的主要 功能。2.3用戶類和特性確定有可能使用該軟件產(chǎn)品的不同用戶類,并且描述它們相關(guān)的特征。往往有一些軟件需求,只與特定的用戶類有關(guān)。 描述時(shí),應(yīng)該將該軟件產(chǎn)品的重要用戶類與非重

29、要用戶類區(qū) 分開。用戶不一定是軟件產(chǎn)品的直接使用者, 通過報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口得到軟 件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機(jī)構(gòu)也有他們的需求。所以,應(yīng)該將這些外部需求視為通過 報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附加用戶類。2.4運(yùn)行環(huán)境描述了本軟件的運(yùn)行環(huán)境,一般包括:硬件平臺(tái);操作系統(tǒng)和版本;支撐環(huán)境(例如:數(shù)據(jù)庫等)和版本;其它與該軟件有關(guān)的軟件組件; 與該軟件共存的應(yīng)用程序。2.5設(shè)計(jì)和實(shí)現(xiàn)上的限制確定影響開發(fā)人員自由選擇的問題,并且說明這些問題為什么成為一種限制??赡艿南拗瓢ㄏ铝袃?nèi)容: 必須使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫; 避免使用的特定技術(shù)、工具、編程語言

30、和數(shù)據(jù)庫;要求遵循的開發(fā)規(guī)范和標(biāo)準(zhǔn)例如,如果由客戶的公司或者第三方公司負(fù)責(zé)軟件維護(hù),就必須定義轉(zhuǎn)包者所使用的設(shè)計(jì)符號(hào)表示和編碼標(biāo)準(zhǔn);企業(yè)策略的限制; 政府法規(guī)的限制;工業(yè)標(biāo)準(zhǔn)的限制;硬件的限制例如,定時(shí)需求或存儲(chǔ)器限制; 數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。2.6假設(shè)和約束(依賴)列舉出對(duì)軟件產(chǎn)品需求分析報(bào)告中,影響需求陳述的假設(shè)因素(與己知因素相對(duì)立)。如果這些假設(shè)因素不正確、 不一致或者被修改, 就會(huì)使軟件產(chǎn)品開發(fā)項(xiàng)目受到影響。 這些假設(shè) 的因素可能包括: 計(jì)劃使用的商業(yè)組件,或者其它軟件中的某個(gè)部件; 假定產(chǎn)品中某個(gè)用戶界面將符合一個(gè)特殊的設(shè)計(jì)約定; 有關(guān)本軟件用戶的若干假定 (例如:假定用戶會(huì)熟練

31、使用SQL語言。); 有關(guān)本軟件開發(fā)工作的若干假定 (例如:用戶承諾的優(yōu)惠、方便、上級(jí)部門給予的特 殊政策和支持等。); 有關(guān)本軟件運(yùn)行環(huán)境的一些問題;此外,確定本軟件開發(fā)項(xiàng)目對(duì)外部約束因素所存在的依賴。有關(guān)的約束可能包括:工期約束;經(jīng)費(fèi)約束;人員約束;設(shè)備約束;地理位置約束;其它有關(guān)項(xiàng)目約束;3. 外部接口需求通過本節(jié)描述可以確定,保證軟件產(chǎn)品能和外部組件正確連接的需求。關(guān)聯(lián)圖僅能表示高層抽象的外部接口, 必須對(duì)接口數(shù)據(jù)和外部組件進(jìn)行詳細(xì)描述,并且寫入數(shù)據(jù)定義中。 如果產(chǎn)品的不同部分有不同的外部接口,那么應(yīng)該把這些外部接口的全部詳細(xì)需求并入到這一部分實(shí)例中。注意:必須將附加用戶類的特征與外部

32、接口需求加以區(qū)分,附加用戶類的特征描述的是通過接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求;而外部接口需求描述的是接口本身的需 求。3.1用戶界面陳述需要使用在用戶界面上的軟件組件,描述每一個(gè)用戶界面的邏輯特征。必須注意, 這里需要描述的是用戶界面的邏輯特征,而不是用戶界面。以下是可能包括的一些特征: 將要采用的圖形用戶界面(GUI)標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格; 有關(guān)屏幕布局或者解決方案的限制; 將要使用在每一個(gè)屏幕(圖形用戶界面)上的軟件組件,可能包括:選單;標(biāo)準(zhǔn)按鈕;導(dǎo)航鏈接;各種功能組件;消息欄;快捷鍵; 各種顯示格式的規(guī)定,可能包括: 不同情況下文字的對(duì)齊方式; 不同情況下數(shù)字的表現(xiàn)格式與對(duì)齊方

33、式 日期的表現(xiàn)方法與格式; 計(jì)時(shí)方法與時(shí)間格式;錯(cuò)誤信息顯示標(biāo)準(zhǔn);對(duì)于用戶界面的細(xì)節(jié),例如:一個(gè)特定對(duì)話框的布局,應(yīng)該寫入具體的用戶界面設(shè)計(jì)說 明中,而不能寫入軟件需求規(guī)格說明中。如果采用現(xiàn)成的、合適的用戶界面設(shè)計(jì)規(guī)范(標(biāo)準(zhǔn)),或者另文描述,可以在這里直接說明,并且將其加入?yún)⒖嘉墨I(xiàn)。3.2硬件接口描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征,若有多個(gè)硬件接口,則必須全都描述。 接口特征的描述內(nèi)容可能包括:支持的硬件類型;軟、硬件之間交流的數(shù)據(jù);控制信息的性質(zhì);使用的通訊協(xié)議;3.3軟件接口描述該軟件產(chǎn)品與其它外部組件的連接,這些外部組件必須明確它們的名稱和版本號(hào)以資識(shí)別,可能的外部組件包括:操作系

34、統(tǒng);數(shù)據(jù)庫;工具;函數(shù)庫;集成的商業(yè)組件說明:這里所說的“集成的商業(yè)組件”,是指與系統(tǒng)集成的商業(yè)組件,而不是與軟件產(chǎn)品集成的商業(yè)組件。例如:中間件、消息服務(wù),等等。描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需要的服務(wù), 以及與內(nèi)部組件通訊的性質(zhì)。確定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。如果必須使用一種特殊的方法來實(shí)現(xiàn)數(shù)據(jù)共享機(jī)制,例如:在多用戶系統(tǒng)中的一個(gè)全局?jǐn)?shù)據(jù)區(qū),那么就必須把它定義為一種實(shí)現(xiàn)上的限制。3.4通訊接口描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求,包括:電子郵件; WEB瀏覽器;網(wǎng)絡(luò)通訊標(biāo)準(zhǔn)或者協(xié)議;數(shù)據(jù)交互用電子表格; 必須定義相關(guān)的:消息格式; 通訊安全或加密

35、問題;數(shù)據(jù)傳輸速率; 同步和異步通訊機(jī)制;4. 系統(tǒng)功能需求需要進(jìn)行詳細(xì)的需求記錄,詳細(xì)列出與該系統(tǒng)功能相關(guān)的詳細(xì)功能需求,并且,唯一地標(biāo)識(shí)每一項(xiàng)需求。這是必須提交給用戶的軟件功能,使得用戶可以使用所提供的功能執(zhí)行服務(wù)或者使用所指定的使用實(shí)例執(zhí)行任務(wù)。描述軟件產(chǎn)品如何響應(yīng)己知的出錯(cuò)條件、非法輸入、非法動(dòng)作。如果每一項(xiàng)功能需求都能用一項(xiàng), 也只需要用一項(xiàng)測(cè)試用例就能進(jìn)行驗(yàn)證, 那么就可以 認(rèn)為功能需求已經(jīng)適當(dāng)?shù)剡M(jìn)行描述了。 如果某項(xiàng)功能需求找不到合適的測(cè)試用例, 或者必須 使用多項(xiàng)測(cè)試用例才能驗(yàn)證,那么該項(xiàng)功能需求的描述必然存在某些問題。功能需求是根據(jù)系統(tǒng)功能, 即軟件產(chǎn)品所提供的主要服務(wù)來組織

36、的??梢酝ㄟ^使用實(shí)例、運(yùn)行模式、用戶類、對(duì)象類或者功能等級(jí)來組織這部分內(nèi)容,也可以便用這些元素的組合。 總而言之,必須選擇一種是讀者容易理解預(yù)期產(chǎn)品的組織方案。用簡(jiǎn)短的語句說明功能的名稱,例如:“ 4.1系統(tǒng)參數(shù)管理”。按照服務(wù)組織的順序,逐條闡述系統(tǒng)功能。無論說明的是何種功能,都應(yīng)該針對(duì)該系統(tǒng)功能重復(fù)敘述4.1 4.3這三個(gè)部分??梢酝ㄟ^各種方式來組織這一部分內(nèi)容,例如采用:使用實(shí)例、運(yùn)行模式、用戶類、對(duì) 象類、功能等級(jí)等,也可以采用它們的組合。其最終目的是,讓讀者容易理解即將開發(fā)的軟 件產(chǎn)品。一般來說,每個(gè)使用實(shí)例都對(duì)應(yīng)一個(gè)系統(tǒng)功能,因而按照使用實(shí)例來組織內(nèi)容比較容易讓用戶理解。對(duì)應(yīng)一些被

37、共享的獨(dú)立使用實(shí)例,可以定義一些公用系統(tǒng)功能。必須特別注意的是,在2.2節(jié)“產(chǎn)品的功能”中描述的全部需求,以及它們的規(guī)格說明; 必須在某個(gè)系統(tǒng)功能描述中有所反映,而且不應(yīng)重復(fù)。4.1說明和優(yōu)先級(jí)對(duì)該系統(tǒng)功能進(jìn)行簡(jiǎn)短的說明,并且指出該系統(tǒng)功能的優(yōu)先級(jí)是:高、中、還是低。需 要的話,還可以包括對(duì)特定優(yōu)先級(jí)部分的評(píng)價(jià),例如:利益、損失、費(fèi)用和風(fēng)險(xiǎn),其相對(duì)優(yōu) 先等級(jí)可以從1(低)到9(高)。4.2激勵(lì)/響應(yīng)序列列出輸入激勵(lì)(用戶動(dòng)作、來自外部設(shè)備的信號(hào)或者其它觸發(fā))并且定義針對(duì)這一一功能 行為的系統(tǒng)響應(yīng)序列,這些序列將與使用實(shí)例中相關(guān)的對(duì)話元素相對(duì)應(yīng)。描述激勵(lì)/響應(yīng)序列時(shí),不僅需要描述基本過程,而且應(yīng)

38、該描述可選(擴(kuò)充)過程,包括例外(引起任務(wù)不能順序完成的情況稱為例外 )。疏忽了可選過程,有可能影響軟件產(chǎn)品的功 能;如果遺漏例外過程,則有可能會(huì)引發(fā)系統(tǒng)崩潰。如果采用流程圖來描述激勵(lì)/響應(yīng)序列,比較容易讓用戶理解。4.3輸入/輸出數(shù)據(jù)列出輸入數(shù)據(jù)(用戶輸入、來自外部接口的輸入或者其它輸入 )并且定義針對(duì)這些輸入數(shù) 據(jù)的處理(計(jì)算)方法,以及相應(yīng)地輸出數(shù)據(jù),描述對(duì)應(yīng)區(qū)別:輸入數(shù)據(jù)和輸出數(shù)據(jù)。當(dāng)有大量數(shù)據(jù)需要描述時(shí),也可以分類描述數(shù)據(jù),并且注明各項(xiàng)數(shù)據(jù)的輸入、輸出屬性。 對(duì)于每一項(xiàng)數(shù)據(jù),均需要描述:數(shù)據(jù)名稱;實(shí)際含義;數(shù)據(jù)類型;數(shù)據(jù)格式;數(shù)據(jù)約束;對(duì)于復(fù)雜的處理方法, 僅僅給出算法原理是不夠的,

39、必須描述詳細(xì)的計(jì)算過程,并且列出每一步具體使用的實(shí)際算式;如果計(jì)算過程中涉及查表、判斷、迭代等處理方法,應(yīng)該給出處理依據(jù)和相關(guān)數(shù)據(jù)。如果計(jì)算方法很簡(jiǎn)單,也可以將其從略,不加描述。5. 其它非功能需求在這里列舉出所有非功能需求,主要包括可靠性、安全性、可維護(hù)性、可擴(kuò)展性、可測(cè) 試性等。5.1性能需求闡述不同應(yīng)用領(lǐng)域?qū)浖a(chǎn)品性能的需求,并且說明提出需求的原理或者依據(jù),以幫助開發(fā)人員做出合理的設(shè)計(jì)選擇。盡可能詳細(xì)地描述性能需求,如果需要,可以針對(duì)每個(gè)功能 需求或者特征分別陳述其性能需求。在這里確定:相互合作的用戶數(shù)量;系統(tǒng)支持的并發(fā)操作數(shù)量;響應(yīng)時(shí)間;與實(shí)時(shí)系統(tǒng)的時(shí)間關(guān)系:容量需求存儲(chǔ)器; 磁盤空

40、間; 數(shù)據(jù)庫中表的最大行數(shù)。5.2安全措施需求詳盡陳述與軟件產(chǎn)品使用過程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。 定義必須采取的安全保護(hù)或動(dòng)作,以及必須預(yù)防的潛在危險(xiǎn)動(dòng)作。明確軟件產(chǎn)品必須遵從的安全標(biāo)準(zhǔn)、 策略、或規(guī)則。5.3安全性需求詳盡陳述與系統(tǒng)安全性、 完整性問題相關(guān)的需求,或者與個(gè)人隱私問題相關(guān)的需求。這些問題將會(huì)影響到軟件產(chǎn)品的使用,和軟件產(chǎn)品所創(chuàng)建或者使用的數(shù)據(jù)的保護(hù)。定義用戶身份認(rèn)證,或備授權(quán)需求。明確軟件產(chǎn)品必須滿足的安全性或者保密性策略。也可以通過稱為完整性的質(zhì)量屬性來闡述這些需求。一個(gè)典型的軟件系統(tǒng)安全需求范例如下:“每個(gè)用戶在第一次登錄后,必須更改他的系統(tǒng)預(yù)置登錄密碼,系

41、統(tǒng)預(yù)置的登錄密碼不能重用?!?.4軟件質(zhì)量屬性詳盡陳述對(duì)客戶和開發(fā)人員至關(guān)重要的在軟件產(chǎn)品其它方面表現(xiàn)出來的質(zhì)量功能。這些功能必須是確定的、 定量的、在需要時(shí)是可以驗(yàn)證的。 至少也應(yīng)該指明不同屬性的相對(duì)側(cè)重 點(diǎn),例如:易用性優(yōu)于易學(xué)性,或者可移植性優(yōu)于有效性。5.5業(yè)務(wù)規(guī)則列舉出有關(guān)軟件產(chǎn)品的所有操作規(guī)則,例如:那些人在特定環(huán)境下可以進(jìn)行何種操作。這些本身不是功能需求, 但是他們可以暗示某些功能需求執(zhí)行這些規(guī)則。一個(gè)業(yè)務(wù)規(guī)則的范例如下:“進(jìn)行達(dá)到或者超過 10,000, 00元人民幣的儲(chǔ)蓄業(yè)務(wù)時(shí),必須通過附加的管理員 認(rèn)證?!绷信e業(yè)務(wù)規(guī)則時(shí),可以根據(jù)規(guī)則的數(shù)量,選取合適的編目方式。5.6用戶文

42、檔列舉出將與軟件產(chǎn)品一同交付的用戶文檔,并且明確所有己知用戶文檔的交付格式或標(biāo)準(zhǔn),例如:安裝指南紙質(zhì)文檔,16開本;用戶手冊(cè)紙質(zhì)文檔,16開本;在線幫助電子文檔,與軟件產(chǎn)品一同分發(fā)、配置;使用教程電子文檔,與軟件產(chǎn)品一同分發(fā)、配置。6.詞匯表列出本文件中用到的專業(yè)術(shù)語的定義,以及有關(guān)縮寫的定義(如有可能,列出相關(guān)的外文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件產(chǎn)品需求分析報(bào)告,要求使 用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語描述軟件需求。所以這里所指的專業(yè)術(shù)語,是指業(yè)務(wù)層面上的專業(yè)術(shù)語,而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語。但是,對(duì)于無法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語,也應(yīng)該列入詞匯表并

43、且加以準(zhǔn)確定義。7. 數(shù)據(jù)定義數(shù)據(jù)定義是一個(gè)定義了應(yīng)用程序中使用的所有數(shù)據(jù)元素和結(jié)構(gòu)的共享文檔,其中對(duì)每個(gè)數(shù)據(jù)元素和結(jié)構(gòu)都準(zhǔn)確描述:含義、類型、數(shù)據(jù)大小、格式、計(jì)量單位、精度以及取值范圍。數(shù)據(jù)定義的維護(hù)獨(dú)立于軟件需求規(guī)格說明,并且在軟件產(chǎn)品開發(fā)和維護(hù)的任何階段,均向風(fēng)險(xiǎn)承擔(dān)者開放。如果為軟件開發(fā)項(xiàng)目創(chuàng)建一個(gè)獨(dú)立的數(shù)據(jù)定義,而不是為每一項(xiàng)特性描述有關(guān)的數(shù)據(jù) 項(xiàng),有利于避免冗余和不一致性。 但是卻不利于多人協(xié)同編寫需求分析報(bào)告,容易遺漏數(shù)據(jù),也不方便閱讀。因此還是建議為每個(gè)特性描述有關(guān)的數(shù)據(jù)項(xiàng),匯總數(shù)據(jù)項(xiàng)創(chuàng)建數(shù)據(jù)定義,再根據(jù)數(shù)據(jù)定義復(fù)核全部數(shù)據(jù),使得它們的名稱和含義完全一致。必須注意的是,為了避免

44、二義性,在匯總數(shù)據(jù)項(xiàng)時(shí)應(yīng)該根據(jù)數(shù)據(jù)項(xiàng)所代表的實(shí)際意義匯總,而不是根據(jù)數(shù)據(jù)項(xiàng)的名稱匯總。在數(shù)據(jù)定義中,每個(gè)數(shù)據(jù)項(xiàng)除了有一個(gè)中文名稱外,還應(yīng)該為它取一個(gè)簡(jiǎn)短的英文名稱, 該英文名稱應(yīng)該符合命名規(guī)范,因?yàn)樵谲浖_發(fā)時(shí)將沿用該英文名稱??梢允褂玫忍?hào)表示數(shù)據(jù)項(xiàng),名稱寫在左邊,定義寫在右邊。常見數(shù)據(jù)項(xiàng)的描述方式如下:原數(shù)據(jù)元素一個(gè)原數(shù)據(jù)元素是不可分解的,可以將一個(gè)數(shù)量值賦給它。定義原數(shù)據(jù)元素必須確定其 含義、類型、數(shù)據(jù)大小、格式、計(jì)量單位、精度以及取值范圍。采用以星號(hào)為界的一行 注釋文本,描述原數(shù)據(jù)元素的定義。選擇項(xiàng)選擇項(xiàng)是一種只可以取有限離散值的特殊原數(shù)據(jù)元素,描述時(shí)一一枚舉這些值, 并用方括號(hào)括起來寫

45、在原數(shù)據(jù)元素的定義前。在兩項(xiàng)離散值之間,使用管道符分隔。組合項(xiàng)組合項(xiàng)是一個(gè)數(shù)據(jù)結(jié)構(gòu)或者記錄,其中包含了多個(gè)數(shù)據(jù)項(xiàng)。 這些數(shù)據(jù)項(xiàng)可以是原數(shù)據(jù)元素,也可以是組合數(shù)據(jù)項(xiàng), 各數(shù)據(jù)項(xiàng)之間用加號(hào)連接。 其中每個(gè)數(shù)據(jù)項(xiàng)都必須是數(shù)據(jù)定 義中定義過的,結(jié)構(gòu)中也可以包括其它結(jié)構(gòu),但是絕對(duì)不允許遞歸。 如果數(shù)據(jù)結(jié)構(gòu)中有可選項(xiàng),使用圓括號(hào)把該項(xiàng)括起來。重復(fù)項(xiàng)重復(fù)項(xiàng)是組合項(xiàng)的一種特例,其中有一項(xiàng)將有多個(gè)實(shí)例出現(xiàn)在數(shù)據(jù)結(jié)構(gòu)中,使用花括號(hào)把該項(xiàng)括起來。如果知道該項(xiàng)可能允許的范圍,就按“最小值:最大值”的形式寫在花 括號(hào)前。8. 分析模型這是一個(gè)可選部分,包括或涉及到相關(guān)的分析模型,例如: 數(shù)據(jù)流程圖;類圖;狀態(tài)轉(zhuǎn)換圖;實(shí)

46、體-關(guān)系圖。9. 待定問題列表編輯一張?jiān)谲浖a(chǎn)品需求分析報(bào)告中待確定問題時(shí)的列表,把每一個(gè)表項(xiàng)都編上號(hào),以 便跟蹤調(diào)查。附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板1. 引言i.i編寫目的1.2項(xiàng)目風(fēng)險(xiǎn)1.3預(yù)期讀者和閱讀建議 1.4參考資料2. 設(shè)計(jì)概述2.1限制和約束 2.2設(shè)計(jì)原則和設(shè)計(jì)要求 3. 系統(tǒng)邏輯設(shè)計(jì)3.1系統(tǒng)組織設(shè)計(jì) 3.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 3.2.1系統(tǒng)特性表3.2.2系統(tǒng)特性結(jié)構(gòu)圖 3.3系統(tǒng)接口設(shè)計(jì) 3.3.1系統(tǒng)接口表3.3.2系統(tǒng)接口傳輸協(xié)議說明 3.4系統(tǒng)完整性設(shè)計(jì) 4. 系統(tǒng)出錯(cuò)處理設(shè)計(jì)4.1系統(tǒng)出錯(cuò)處理表 4.2維護(hù)處理過程表 5. 技術(shù)設(shè)計(jì)5.1系統(tǒng)開發(fā)技術(shù)說明表 5.2開發(fā)

47、技術(shù)應(yīng)用說明 6. 數(shù)據(jù)庫設(shè)計(jì)7. 詞匯表8. 進(jìn)度計(jì)劃1.引言引言是對(duì)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告的概覽,是為了幫助閱讀者了解這份文檔是如何編寫的,并且應(yīng)該如何閱讀、理解和解釋這份文檔。1.1編寫目的說明這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求規(guī)格說明書編寫的,開發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。 通過這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告詳盡說明了 該軟件產(chǎn)品的軟件結(jié)構(gòu),包括數(shù)據(jù)庫結(jié)構(gòu)和出錯(cuò)處理,從而對(duì)該軟件產(chǎn)品的結(jié)構(gòu)的描述。如果這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系,那么只定義軟件系統(tǒng)概要設(shè)計(jì)報(bào)告中說明的那個(gè)部分或子系統(tǒng)。1.2項(xiàng)目風(fēng)險(xiǎn)具體說明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)

48、者,以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn),首要風(fēng)險(xiǎn)承擔(dān)者包括:任務(wù)提出者;軟件開發(fā)者;產(chǎn)品使用者。1.3預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者,例如,可能的讀者包括:用戶;開發(fā)人員;項(xiàng)目經(jīng)理;營銷人員;測(cè)試人員;文檔編寫人員;等等。描述文檔中,其余部分的內(nèi)容及其組織結(jié)構(gòu),并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。1.4參考資料列舉編寫軟件產(chǎn)品概要設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料,可能包括:本項(xiàng)目的合同書;上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文; 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書;用戶界面風(fēng)格指導(dǎo);開發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)準(zhǔn);系統(tǒng)規(guī)格需求說明;使用實(shí)例文檔;屬于本項(xiàng)目的其它已發(fā)表文

49、件;本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告中所引用的文件、資料:相關(guān)軟件系統(tǒng)概要設(shè)計(jì)報(bào)告:等等。為了方便讀者查閱,所有參考資料應(yīng)該按一定順排列。如果可能,每份資料都應(yīng)該給出:標(biāo)題名稱;作者或者合同簽約者;文件編號(hào)或者版本號(hào);發(fā)表日期或者簽約日期; 出版單位或者資料來源。2. 設(shè)計(jì)概述本節(jié)描述現(xiàn)有開發(fā)條件和需要實(shí)現(xiàn)的目標(biāo),說明進(jìn)行概要設(shè)計(jì)時(shí)應(yīng)該遵循的設(shè)計(jì)原則和必須采用的設(shè)計(jì)方法。2.1限制和約束簡(jiǎn)要描述起到限制和約束作用的各種可能存在的條件,例如:技術(shù)條件;資金狀況;開發(fā)環(huán)境(包括:工具和平臺(tái));時(shí)間限制;等等。并且說明在上述條件下,應(yīng)該實(shí)現(xiàn)的系統(tǒng)目標(biāo),2.2設(shè)計(jì)原則和設(shè)計(jì)要求描述對(duì)本軟件系統(tǒng)進(jìn)行概要設(shè)計(jì)的原則

50、,通??梢钥紤]以下幾方面的內(nèi)容: 命名規(guī)則;模塊獨(dú)立性原則:邊界設(shè)計(jì)原則;數(shù)據(jù)庫設(shè)計(jì)規(guī)則;必須的安全措施;安全性和保密原則;系統(tǒng)靈活性要求;系統(tǒng)易操作性要求;系統(tǒng)可維護(hù)性要求;等等。3. 系統(tǒng)邏輯設(shè)計(jì)本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說明書和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng)的邏輯模型。此種模型暫時(shí)與系統(tǒng)的物理因素(例如:計(jì)算機(jī)、數(shù)據(jù)庫管理系統(tǒng) )無關(guān)。它是系統(tǒng)需求與物理實(shí)現(xiàn)的中間結(jié)構(gòu),它的主要結(jié)果是建立:系統(tǒng)結(jié)構(gòu)圖、系統(tǒng)界面結(jié)構(gòu)圖、系統(tǒng)出錯(cuò)處理、 以及系統(tǒng)開發(fā)技術(shù)說明。說明:如果進(jìn)行系統(tǒng)設(shè)計(jì)時(shí)尚未編寫軟件數(shù)據(jù)字典:應(yīng)首先參照附錄B說明,編寫軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后,再進(jìn)行系統(tǒng)設(shè)計(jì)。3.1系統(tǒng)組

51、織設(shè)計(jì)系統(tǒng)組織設(shè)計(jì)通過系統(tǒng)組織表描述本系統(tǒng)由哪些子系統(tǒng)(模塊)組成,這些子系統(tǒng)與業(yè)務(wù)職能之間的關(guān)系,以及各個(gè)子系統(tǒng)的安裝地點(diǎn)。系統(tǒng)組織表的格式如下:子系統(tǒng)編號(hào)英文名稱中文名稱業(yè)務(wù)職能安裝地點(diǎn)備注其中:子系統(tǒng)編號(hào)給出本系統(tǒng)中指定子系統(tǒng)的順序編號(hào)。如果本系統(tǒng)末劃分為多個(gè)子系統(tǒng),僅由一 個(gè)運(yùn)行模塊組成;則本項(xiàng)內(nèi)容仍需要描述,但是本表內(nèi)容只有一行。說明:在一個(gè)系統(tǒng)中有可能安裝若干個(gè)相同的子系統(tǒng),在這種情況下,應(yīng)該視為 一個(gè)子系統(tǒng),并且對(duì)多個(gè)安裝地點(diǎn)分別進(jìn)行描述。如果相同的子系統(tǒng)通過系統(tǒng)設(shè) 置,實(shí)現(xiàn)的業(yè)務(wù)職能具有明顯差異時(shí),應(yīng)該采用多行進(jìn)行分別描述,并且在備注 中說明其差異所在。子系統(tǒng)英文名稱給出本子系

52、統(tǒng)的英文名稱,該名稱是在應(yīng)用軟件中實(shí)際使用的可執(zhí)行文件名稱, 必須能夠說明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng),則本項(xiàng)內(nèi)容仍需要描述,但是本表內(nèi)容只有一行。 子系統(tǒng)中文名稱給出本子系統(tǒng)的中文名稱,該名稱必須能夠說明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng),則本項(xiàng)內(nèi)容仍需要描述,但是本表內(nèi)容只有一行。業(yè)務(wù)職能描述該子系統(tǒng)完成的核心業(yè)務(wù)。安裝地點(diǎn)描述該子系統(tǒng)實(shí)際安裝的部門、或者某個(gè)具體地點(diǎn)。備注針對(duì)該子系統(tǒng),需要說明的其它有關(guān)問題。3.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì)本節(jié)將對(duì)系統(tǒng)特性作較為詳細(xì)的描述,并給出系統(tǒng)特性結(jié)構(gòu)圖。3.2.1系統(tǒng)特性表系統(tǒng)特性是系統(tǒng)中完成某項(xiàng)具體操作的基本單元,它由入口參數(shù),出口參數(shù)以及處理過程三部分組成。系統(tǒng)特性可以具有操作界面,也可以沒有操作界面;可以被其它操作界面、或者系統(tǒng)特 性調(diào)用,也可以調(diào)用其它操作界面、非操作界面、或者系統(tǒng)特性;但是不允許遞歸調(diào)用(調(diào)用自己),包括間接遞歸調(diào)用。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí),每個(gè)子系統(tǒng)分別使用一張系統(tǒng)特性表進(jìn)行描述。系 統(tǒng)特性表的格式如下:子系統(tǒng)編號(hào): 子系統(tǒng)英文名稱: 子系統(tǒng)中文名稱:特性編號(hào)系統(tǒng)特征 英文名稱系統(tǒng)特征 中文名稱操作功能調(diào)用對(duì)象被調(diào)用 對(duì)象備注說明:其中子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論