![軟件開發(fā)需求分析文檔_第1頁](http://file2.renrendoc.com/fileroot_temp3/2021-11/30/e2e3b76b-bfaf-47ff-b019-94c4e1e22087/e2e3b76b-bfaf-47ff-b019-94c4e1e220871.gif)
![軟件開發(fā)需求分析文檔_第2頁](http://file2.renrendoc.com/fileroot_temp3/2021-11/30/e2e3b76b-bfaf-47ff-b019-94c4e1e22087/e2e3b76b-bfaf-47ff-b019-94c4e1e220872.gif)
![軟件開發(fā)需求分析文檔_第3頁](http://file2.renrendoc.com/fileroot_temp3/2021-11/30/e2e3b76b-bfaf-47ff-b019-94c4e1e22087/e2e3b76b-bfaf-47ff-b019-94c4e1e220873.gif)
![軟件開發(fā)需求分析文檔_第4頁](http://file2.renrendoc.com/fileroot_temp3/2021-11/30/e2e3b76b-bfaf-47ff-b019-94c4e1e22087/e2e3b76b-bfaf-47ff-b019-94c4e1e220874.gif)
![軟件開發(fā)需求分析文檔_第5頁](http://file2.renrendoc.com/fileroot_temp3/2021-11/30/e2e3b76b-bfaf-47ff-b019-94c4e1e22087/e2e3b76b-bfaf-47ff-b019-94c4e1e220875.gif)
版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報或認(rèn)領(lǐng)
文檔簡介
1、軟件開發(fā)需求分析文檔目錄1. 范圍12 總體要求12. 1總體功能要求122軟件開發(fā)平臺要求12. 3軟件項目的開發(fā)實施過程管理要求22. 3. 1軟件項目實施過程總體要求22. 3. 2軟件項目實施變更要求22. 3. 3軟件項0實施里程碑控制23. 軟件開發(fā)33.1軟件的需求分析33. 1. 1需求分析33. 1. 2需求分析報告的編制者43. 1.3需求報告評審43.1.4需求報告格式43.2軟件的概要設(shè)計43. 2. 1概要設(shè)計4 3.2.2編寫概要設(shè)計的要求43. 2.3概要設(shè)計報告的編寫者43.2.4概要設(shè)計和需求分析、詳細(xì)設(shè)計之間的關(guān)系和區(qū)別43.2.5概要設(shè)計的評審43. 2.
2、 6概要設(shè)計格式43.3軟件的詳細(xì)設(shè)計53. 3. 1詳細(xì)設(shè)計53. 3. 2特例53. 3.3詳細(xì)設(shè)計的要求53. 3. 4數(shù)據(jù)庫設(shè)計53. 3. 5詳細(xì)設(shè)計的評審53. 3. 6詳細(xì)設(shè)計格式53.4軟件的編碼53.4. 1軟件編碼53.4.2軟件編碼的要求53.4.3編碼的評審63. 4. 4編程規(guī)范及要求63.5軟件的測試63. 5. 1軟件測試63. 5. 2測試計劃63.6軟件的交付準(zhǔn)備63. 6. 1交付清單6 3.7軟件的鑒定驗收73. 7. 1軟件的鑒定驗收73. 7. 2驗收人員73. 7.3驗收具體內(nèi)容73. 7.4軟件驗收測試大綱 73.8培訓(xùn) 73.8. 1系統(tǒng)應(yīng)用培訓(xùn)
3、73.8.2系統(tǒng)管理的培訓(xùn)(可選)8附錄a軟件需求分析報告文檔模板9附錄b軟件概要設(shè)計報告文檔模板21附錄c軟件詳細(xì)設(shè)計報告文檔模板33附錄d軟件數(shù)據(jù)庫設(shè)計報告文檔模板43附錄e軟件測試驗收大綱55范圉本指南用于指導(dǎo)軟件開發(fā)者為南京市交通局開發(fā)軟件項目的過程,通過規(guī)范 軟件項目承擔(dān)單位的開發(fā)過程達(dá)到提高軟件質(zhì)量,降低維護(hù)成本的目的。開發(fā)者 應(yīng)根據(jù)本指南進(jìn)行軟件開發(fā)和編制軟件開發(fā)文檔。本指南是對軟件項目承擔(dān)單位 的基木要求。在木指南的附錄a至e中提供了文檔的編寫模板供開發(fā)者參考,在 進(jìn)行具體軟件開發(fā)時,開發(fā)者可根據(jù)實際情況采編寫,但必須提供雙方約定的文檔,文檔中約定的內(nèi)容必須描述清楚??傮w要求總
4、體功能要求網(wǎng)絡(luò)應(yīng)用環(huán)境以internet/intremet技術(shù)為核心。開發(fā)者應(yīng)在充分分析需求的基礎(chǔ)上,選擇采用b/s結(jié)構(gòu)或者c/s結(jié)構(gòu)。軟件系統(tǒng)的數(shù)據(jù)庫應(yīng)依照南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范進(jìn)行設(shè)計 和建設(shè)。本指南中沒有規(guī)定開發(fā)者采用何種具體的軟件工程開發(fā)方法,開發(fā)者可根據(jù) 項目具體特點、自身擅長來選擇采用面向過程的方法、面向?qū)ο蟮姆椒ɑ蛎嫦驍?shù) 據(jù)的方法,但建議開發(fā)商使用而向?qū)ο筌浖こ痰姆椒?,?采用目前被廣泛使 用的ruprational unified process方法來進(jìn)行分析、設(shè)計和開發(fā)。軟件開發(fā)平臺要求開發(fā)者開發(fā)的軟件必須能夠在南京市交通局規(guī)定的軟件平臺上正常運行。目 前軟件平臺
5、為:數(shù)據(jù)庫管理系統(tǒng):oracle 9i以上版本屮間件應(yīng)用服務(wù)器系統(tǒng):ibm websphere0a系統(tǒng):lotus domino/notes網(wǎng)絡(luò)架構(gòu):完全支持tcp/ip協(xié)議開發(fā)工具或技術(shù)體系:為保證軟件的上下兼容性,開發(fā)者應(yīng)選擇比較通用的開發(fā)工具的較新版本進(jìn) 行開發(fā),如 microsoft visual studio. net, borland delphi, c+ builder,或 j2eejava2 platform enterprise edition 等。軟件項目的開發(fā)實施過程管理要求軟件項目實施過程總體要求開發(fā)者提交軟件開發(fā)工作大綱,交通局組織專家組對工作大綱進(jìn)行評審,并 提出整
6、改意見。通過評審后,開發(fā)者根據(jù)整改意見完善工作大綱,經(jīng)過交通局認(rèn)可后組織項 目組進(jìn)行軟件開發(fā)。軟件開發(fā)工作按照需求分析、概要設(shè)計、詳細(xì)設(shè)計、編碼、 測試等幾個階段進(jìn)行,在開發(fā)過程中,開發(fā)者需分階段提交相關(guān)文檔。在軟件開發(fā)工作完成后,開發(fā)者應(yīng)向交通局提交完整的軟件文檔,交通局組 織驗收組對軟件進(jìn)行驗收審查。軟件項目實施變更要求在開發(fā)過程中,需求或設(shè)計不可避免地需要發(fā)生變更,相關(guān)變更必須經(jīng)過交 通局書面同意方可進(jìn)行。在需求或設(shè)計發(fā)生變更時,需要對原有文檔進(jìn)行修改, 并提供完整的變更記錄,以使變更處于可控制的狀態(tài)。變更單如下表所示:表2-1變更單需求變更申請申請變更的需求文檔輸入名稱,版本,h期等信
7、息變更的內(nèi)客及其理由評估需求變更將對項目造成的影響中請人簽字變更申請的審批意見項目經(jīng)理簽字審批意見:簽字日期客戶簽字合同項目審批意見:簽字日期更改需求文檔變更后的需求文檔輸入名稱,版本,完成h期等信息更改人簽字重新評審需求文檔需求評審小組簽字 評審意見:簽字日期變更結(jié)束項目經(jīng)理簽字 簽字口期軟件項目實施里程碑控制交通局將分四個階段進(jìn)行把關(guān),召開專家審查會。需求分析(結(jié)合原型進(jìn)行審查)確認(rèn);概要設(shè)計+數(shù)據(jù)庫設(shè)計;預(yù)驗收(試運行后);正式驗收(推廣使用后)。軟件開發(fā)合同簽訂以后,項目承擔(dān)單位即可組織項目組進(jìn)行軟件開發(fā)工作。軟件開發(fā) 必須嚴(yán)格按照軟件工程的要求進(jìn)行。開發(fā)過程包括開發(fā)者的活動和任務(wù)。此
8、過程 由軟件需求分析、概要設(shè)計、詳細(xì)設(shè)計、編碼、測試、驗收、鑒定等活動組成。軟件的需求分析需求分析首先,開發(fā)者和交通局應(yīng)共同對交通局的應(yīng)用需求作充分的調(diào)研,提交完整 的需求分析 報告。在需求分析報告中必須描述的基木問題是:功能、性能、強 加于實現(xiàn)的設(shè)計限制、屬 性、外部接口。應(yīng)當(dāng)避免把設(shè)計或項目需求寫入需求 分析報告中。它必須說明由軟件獲得的結(jié)果,而不是獲得這些結(jié)果的手段。軟件需求可以用若干種方法來表達(dá),如通過輸入、輸出說明;使用代表性的例 子;用規(guī)范化的模型。開發(fā)者應(yīng)盡可能地使用模型的方式,因為這是表達(dá)復(fù)雜需求 的精確和有效的方法。比如用統(tǒng)一建模語言(uml)來描述需求。編寫需求分析報告的要
9、求a. 無歧義性對最終產(chǎn)品的每一個特性用某一術(shù)語描述;若某一術(shù)語在某一特殊的行文中 使用時具有多種含義,那么應(yīng)對該術(shù)語的每種含義做出解釋并指出其適用場合。b. 完整性需求分析報告應(yīng)該包括全部有意義的需求,無論是關(guān)系到功能的、性能的、 設(shè)計約束的、述是關(guān)系到外部接口方面的需求;對所有可能出現(xiàn)的輸入數(shù)據(jù)的響 應(yīng)予以定義,要對合法和非合法的輸入值的響應(yīng)做出規(guī)定;填寫全部插圖、表、圖 示標(biāo)記等;定義全部術(shù)語和度量單位。c. 可驗證性需求分析報告描述的每一個需求應(yīng)是可以驗證的??梢酝ㄟ^一個有限處理過 程來檢查軟件產(chǎn)品是否滿足需求。d. 一致性在需求分析報告屮的各個需求的描述不能互相矛盾。e. 可修改性需
10、求分析報告應(yīng)具有一個有條不紊、易于使用的內(nèi)容組織;沒有冗余,即同一 需求不能在需求分析報告中出現(xiàn)多次。f可追蹤性每一個需求的源流必須清晰,在進(jìn)一步產(chǎn)生和改變文件編制時,可以方便地 引證每一個需求。g.運行和維護(hù)階段的可使用性需求分析報告必須滿足運行和維護(hù)階段的需要。在需求分析報告要寫明功能 的來源和目的。需求分析報告的編制者需求分析報告應(yīng)由交通局和開發(fā)者雙方共同完成。其中:交通局負(fù)責(zé)根據(jù)實 際需要提出希望軟件實現(xiàn)的功能;軟件開發(fā)者根據(jù)交通局提出的性能需求,結(jié)合 軟件開發(fā)編寫需求分析。需求報告評審在軟件需求分析工作完成后,軟件開發(fā)者應(yīng)向交通局提交軟件需求分析報 告。交通局組織有關(guān)人員對需求進(jìn)行評
11、審,以決定軟件需求是否完善和恰當(dāng)。評 審?fù)瓿珊?,就可以進(jìn)入軟件的設(shè)計階段。需求報告格式軟件需求分析報告需按一定的格式進(jìn)行編寫,具體的軟件需求分析報 告文檔編寫模板請見附錄a。軟件的概要設(shè)計概要設(shè)計在交通局和開發(fā)者雙方認(rèn)可的需求分析報告基礎(chǔ)上,開發(fā)者進(jìn)行下?步 的工作。首先,開發(fā)者需要對軟件系統(tǒng)進(jìn)行概要設(shè)計,即系統(tǒng)設(shè)計。概要設(shè)計需 要對軟件系統(tǒng)的設(shè)計進(jìn)行考慮,包括系統(tǒng)的基木處理流程、系統(tǒng)的組織結(jié)構(gòu)、模 塊劃分、功能分配、接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等, 為軟件的詳細(xì)設(shè)計提供基礎(chǔ)。編寫概要設(shè)計的要求a. 一致性概要設(shè)計的要求應(yīng)該與需求分析報告所描述的需求一致。同時,概要設(shè)計的 各
12、項要求之間也應(yīng)該一致。b. 合理性概要設(shè)計所提出的設(shè)計方法和標(biāo)準(zhǔn)應(yīng)該是合理的、恰當(dāng)?shù)?。c. 可追蹤性對概要設(shè)計所提出的各項要求應(yīng)該可以得到它的清晰的源流,即在需求分析 報告客戶有明確的需求描述。d. 可行性根據(jù)概要設(shè)計進(jìn)行詳細(xì)設(shè)計、操作和維護(hù)應(yīng)該是可行的。概要設(shè)計報告的編寫者概要設(shè)計報告由開發(fā)者根據(jù)需求分析報告的要求進(jìn)行編寫。概要設(shè)計和需求分析、詳細(xì)設(shè)計之間的關(guān)系和區(qū)別需求分析不涉及具體的技術(shù)實現(xiàn),而概要設(shè)計注重于從宏觀上和框架上來描 述采用何種技術(shù)手段、方法來實現(xiàn)這些需求。詳細(xì)設(shè)計相對概要設(shè)計更注重于微 觀上和框架內(nèi)的設(shè)計,是編碼的依據(jù)。概要設(shè)計是指導(dǎo)詳細(xì)設(shè)計的依據(jù)。概要設(shè)計的評審在軟件概要
13、設(shè)計工作完成后,軟件開發(fā)者應(yīng)向交通提交軟件系統(tǒng)概要設(shè)計 報告。在交通局對概要設(shè)計報告評審?fù)ㄟ^后,即可進(jìn)入詳細(xì)設(shè)計階段。概要設(shè)計格式軟件系統(tǒng)概要設(shè)計報告需按一定的格式進(jìn)行編寫,具體的軟件系統(tǒng)概 要設(shè)計報 告文檔編寫模板請見附錄b。軟件的詳細(xì)設(shè)計詳細(xì)設(shè)計在概要設(shè)計的基礎(chǔ)上,開發(fā)者需要進(jìn)行軟件系統(tǒng)的詳細(xì)設(shè)計。在詳細(xì)設(shè)計中, 描述實現(xiàn)具體模塊所涉及到的主要算法、數(shù)據(jù)結(jié)構(gòu)、類的層次結(jié)構(gòu)及調(diào)用關(guān)系, 需要說明軟件系統(tǒng)各個層次中的每一個程序每個模塊或子程序的設(shè)計考慮,以便 進(jìn)行編碼和測試。應(yīng)當(dāng)保證軟件的需求完全分配給整個軟件。詳細(xì)設(shè)計應(yīng)當(dāng)足 夠詳細(xì),能夠根據(jù)詳細(xì)設(shè)計報告進(jìn)行編碼。特例如果軟件系統(tǒng)比較簡單,層
14、次較少,可以不必進(jìn)行專門的詳細(xì)設(shè)計,而和概耍 設(shè)計結(jié)合起來。詳細(xì)設(shè)計的要求a. 一致性詳細(xì)設(shè)計的要求應(yīng)該與需求分析報告所描述的需求、與概要設(shè)計一致。同時, 詳細(xì)設(shè)計的各項要求之間也應(yīng)該是一致的。b. 合理性詳細(xì)設(shè)計所提出的設(shè)計方法和標(biāo)準(zhǔn)應(yīng)該是合理的、恰當(dāng)?shù)摹. 可追蹤性對詳細(xì)設(shè)計所提岀的各項要求應(yīng)該可以得到它的清晰的源流,即可在需求分 析報告、概要設(shè)計報告中有明確的需求描述。d可行性根據(jù)詳細(xì)設(shè)計進(jìn)行編碼、測試、操作和維護(hù)應(yīng)該是可行的。數(shù)據(jù)庫設(shè)計如果軟件產(chǎn)品需要使用到數(shù)據(jù)庫,軟件的詳細(xì)設(shè)計應(yīng)包括對數(shù)據(jù)庫的設(shè)計。數(shù)據(jù)庫設(shè)計應(yīng)在軟件的需求分析、概要設(shè)計完成之后、詳細(xì)設(shè)計的其它工作之前 進(jìn)行。在進(jìn)行
15、數(shù)據(jù)庫設(shè)計吋,應(yīng)當(dāng)按照交通局制定的南京市交通局信息化數(shù)據(jù) 庫建設(shè)規(guī)范要求進(jìn)行。詳細(xì)設(shè)計的評審在軟件詳細(xì)設(shè)計完成后,軟件開發(fā)者應(yīng)向交通局提交軟件系統(tǒng)數(shù)據(jù)庫設(shè)計 報告和軟件系統(tǒng)詳細(xì)設(shè)計報告。在交通局對軟件系統(tǒng)數(shù)據(jù)庫設(shè)計報告、軟件系統(tǒng)詳細(xì)設(shè)計報告評審?fù)ㄟ^后,即可進(jìn)入軟件編碼階段。詳細(xì)設(shè)計格式軟件系統(tǒng)詳細(xì)設(shè)計報告、軟件系統(tǒng)數(shù)據(jù)庫設(shè)計報告需按一定的格式進(jìn) 行編寫,具體的軟件系統(tǒng)詳細(xì)設(shè)計報告文檔編寫模板和軟件系統(tǒng)數(shù)據(jù)庫設(shè) 計報告文檔編寫模板請見附錄c、附錄d。軟件的編碼軟件編碼在軟件編碼階段,開發(fā)者根據(jù)軟件系統(tǒng)詳細(xì)設(shè)計報告中對數(shù)據(jù)結(jié)構(gòu)、算 法分析和模塊實現(xiàn)等方面的設(shè)計要求,開始具體的編寫程序工作,分別實現(xiàn)
16、各模塊的功能,從而實現(xiàn)對目標(biāo)系統(tǒng)的功能、性能、接口、界面等方面的要求。軟件編碼的要求a. 模塊化編碼b. 代碼可讀性c. 可維護(hù)性d. 模塊接口標(biāo)準(zhǔn)化e. 界面風(fēng)格統(tǒng)一e注釋的應(yīng)用編碼的評審為了盡早發(fā)現(xiàn)軟件中的障礙,提高軟件產(chǎn)品的質(zhì)量,開發(fā)者在編碼的過程中 應(yīng)該強調(diào)代碼評審工作。將代碼評審報告作為文檔的一部分,提交給交通局。編程規(guī)范及要求為了提高編程實現(xiàn)的質(zhì)量,軟件的程序設(shè)計必須遵照國家頒布的相關(guān)編程規(guī) 范。主要內(nèi)容包括:規(guī)范化的程序內(nèi)部文檔、數(shù)據(jù)結(jié)構(gòu)的詳細(xì)說明、清晰的語句 結(jié)構(gòu)、編碼規(guī)范。編碼規(guī)范的內(nèi)容包括命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī) 范、熱鍵定義等。其中數(shù)據(jù)庫部分應(yīng)遵守南京市交通局
17、信息化數(shù)據(jù)庫建設(shè)規(guī)范的要求。在軟件編碼的同吋應(yīng)進(jìn)行單元測試。軟件的測試軟件測試為了盡早發(fā)現(xiàn)軟件產(chǎn)品屮的錯誤,從而達(dá)到提高軟件質(zhì)量、降低軟件維護(hù)的 費用,開發(fā)者應(yīng)在編碼過程中對各個模塊的程序代碼進(jìn)行單元測試,系統(tǒng)集成時 進(jìn)行集成測試,系統(tǒng)集成完成后對整個軟件進(jìn)行系統(tǒng)測試。單元測試是在軟件開 發(fā)過程中針對程序模塊進(jìn)行正確性檢驗。集成測試是在單元測試的基礎(chǔ)上,將所 有模塊按照設(shè)計要求組裝成系統(tǒng)或子系統(tǒng),對模塊組裝過程和模塊接口進(jìn)行正確 性檢驗。軟件系統(tǒng)測試不僅是檢測軟件的整體行為表 現(xiàn),從另一個側(cè)而看,也是 對軟件開發(fā)設(shè)計的再確認(rèn)。進(jìn)行軟件系統(tǒng)測試工作時。測試主要包括界面測試、 可用性測試、功能測試
18、、穩(wěn)定性強度測試、性能測試、強壯性恢復(fù)測試、邏輯性 測試、破壞性測試、安全性測試等。開發(fā)者針對單元測試,集成測試,系統(tǒng)測試分別制定測試計劃。集成測試 需要根據(jù)需求分析報告和概要設(shè)計制作測試用例,并須經(jīng)過評審。軟件測試按照 測試計劃、需求分析報告的要求進(jìn)行,最后形成軟件測試報告。測試計劃在軟件編碼開始之前,開發(fā)者應(yīng)向交通局提交測試計劃,在軟件交付時, 開發(fā)者應(yīng)向交通局提交軟件測試報告,以確保開發(fā)者的軟件得到了充分的測 試。開發(fā)的軟件必須經(jīng)過充分的測試證明其符合設(shè)計耍求、運行穩(wěn)定、安全可用 方可交付交通局。軟件的交付準(zhǔn)備交付清單在軟件測試證明軟件達(dá)到要求后,軟件開發(fā)者應(yīng)向交通局提交開發(fā)的目標(biāo)安 裝
19、程序、數(shù)據(jù)庫的數(shù)據(jù)字典、用戶安裝手冊、用戶使用指南、需求報告、設(shè) 計報告、測試報告等雙方合同約定的產(chǎn)物。用戶安裝手冊應(yīng)詳細(xì)介紹安裝軟件對運行環(huán)境的要求、安裝軟件的定義和內(nèi)容、在客戶端、服務(wù)器端及中間件的具體安裝步驟、安裝后的系統(tǒng)配置。用戶使用指南應(yīng)包括軟件各項功能的使用流程、操作步驟、相應(yīng)業(yè)務(wù)介 紹、特殊提示和注意事項等方面的內(nèi)容,在需要時還應(yīng)舉例說明。軟件的鑒定驗收軟件的鑒定驗收在軟件開發(fā)完成后,為了確保軟件是按照需求分析的要求進(jìn)行開發(fā)的,保證 軟件產(chǎn)品的質(zhì)量,需要對軟件產(chǎn)品進(jìn)行鑒定驗收。在開發(fā)者如期交付軟件后,由交 通局負(fù)責(zé)確定具體的鑒定驗收h期。驗收人員由交通局聘請具有一定的分析、設(shè)計、
20、編程和軟件測試經(jīng)驗的驗收組長和其 他專業(yè)人員組成。驗收組設(shè)組長一名可設(shè)有副組長,負(fù)責(zé)整個驗收的計劃、組織 工作。驗收具體內(nèi)容驗收內(nèi)容應(yīng)該包括:合法性檢查、文檔檢查、軟件一致性檢查、軟件系統(tǒng)測 試與測試結(jié)果評審等幾項工作。合法性檢查檢查軟件開發(fā)工具是否合法、使用的函數(shù)庫、控件、組件是否有 合法的發(fā)布許可。文檔檢查檢查開發(fā)者提交的文檔必須齊全,質(zhì)量是否過關(guān)。需要開發(fā)者提供 的文檔包括:項目實施計劃;詳細(xì)技術(shù)方案;軟件需求規(guī)格說明書stp含數(shù)據(jù)字典;概要設(shè)計說明書pdd;詳細(xì)設(shè)計說明書ddd含數(shù)據(jù)庫設(shè)計說明書;軟件測試計劃stp含測試用例;軟件測試報告str;用戶手冊sum含操作、使用、維護(hù)、應(yīng)急處
21、理手冊;源程序scl不可修改的電子文檔;項目實施計劃pip;項目開發(fā)總結(jié)pds;軟件質(zhì)量保證計劃sqap;此外,驗收組可以根據(jù)需要對其它文檔如軟件配置計劃、項日進(jìn)展報表、階 段評審報表等進(jìn)行檢查。文檔的質(zhì)量根據(jù)完備性、正確性、簡明性、可追蹤性、自說明性、規(guī)范件等 方面進(jìn)行蹤合評定。驗收需要對軟件代碼進(jìn)行檢查,以確保其符合規(guī)范,并檢查其一致性。軟件驗收測試大綱在軟件進(jìn)行鑒定驗收前,開發(fā)者需按照一定的格式編寫軟件驗收測試大綱, 具體的格式請見附錄e。培訓(xùn)系統(tǒng)應(yīng)用培訓(xùn)主要培訓(xùn)內(nèi)容包括:系統(tǒng)操作使用、業(yè)務(wù)管理流程。培訓(xùn)對象:應(yīng)用操作人員。系統(tǒng)管理的培訓(xùn)1(可選)主要培訓(xùn)內(nèi)容包括:系統(tǒng)安裝、調(diào)試、維護(hù);
22、系統(tǒng)管理。培訓(xùn)對象:系統(tǒng)管理人員。開發(fā)者應(yīng)詳細(xì)列出培訓(xùn)計劃,包括培訓(xùn)內(nèi)容、教材、時間和人員等。附錄a軟件需求分析報告文檔模板1. 引言111. 1編寫目的111.2項目風(fēng)險 111.3文檔約定111.4預(yù)期讀者和閱讀建議1115產(chǎn)甜范圍121.6參考文獻(xiàn)122. 綜合描述122. 1產(chǎn)品的狀況122.2產(chǎn)品的功能132.3用戶類和特性132.4運行環(huán)境132.5設(shè)計和實現(xiàn)上的限制132. 6假設(shè)和約束依賴143. 外部接口需求 143.1用戶界面 143.2硬件接口153.3軟件接口 15 3.4通訊接口 164. 系統(tǒng)功能需求 164. 1說明和優(yōu)先級 164. 2激勵/響應(yīng)序列1743輸入
23、/輸出數(shù)據(jù)175. 其它非功能需求175. 1性能需求 175.2安全措施需求185.3安全性需求185.4軟件質(zhì)量屬性185. 5業(yè)務(wù)規(guī)則 185.6用戶文檔 186. 詞匯表 197. 數(shù)據(jù)定義198分析模型209.待定問題列表 20引言引言是對這份軟件產(chǎn)品需求分析報告的概覽,是為了幫助閱讀者了解這份文 檔是如何編寫的,并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫目的說明這份軟件產(chǎn)品需求分析報告是為哪個軟件產(chǎn)品編寫的,開發(fā)這個軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過這份軟件產(chǎn)品需求分析報告詳盡說 明了該軟件產(chǎn)品的需求規(guī)格,包括修正和或發(fā)行版本號,從而對該軟件產(chǎn)品進(jìn)行 準(zhǔn)確的定義。如果這
24、份軟件產(chǎn)品需求分析報告只與整個系統(tǒng)的某一部分有關(guān)系,那么只定 義軟件產(chǎn)甜需求分析報告中說明的那個部分或子系統(tǒng)。項目風(fēng)險具體說明本軟件開發(fā)項目的全部風(fēng)險承擔(dān)者,以及各白在本階段所需要承擔(dān) 的主要風(fēng)險,首要風(fēng)險承擔(dān)者包括:任務(wù)提出者;軟件開發(fā)者;產(chǎn)品使用者。文檔約定描述編寫文檔時所采用的標(biāo)準(zhǔn)如果有標(biāo)準(zhǔn)的話,或者各種排版約定。排版約 定應(yīng)該包括:正文風(fēng)格;提示方式;重要符號;也應(yīng)該說明高層次需求是否可以被其所有細(xì)化的需求所繼承,或者每個需求 陳述是否都有其自己的優(yōu)先級。預(yù)期讀者和閱讀建議列舉木軟件產(chǎn)品需求分析報告所針對的各種不同的預(yù)期讀者,例如,可能包 括:用戶;開發(fā)人員;項目經(jīng)理;營銷人員;測試人
25、員;文檔編寫入員。并且描述了文檔屮,其余部分的內(nèi)容及其組織結(jié)構(gòu),并且針對每一類讀者提 出最適合的文檔閱讀建議。產(chǎn)品范圍說明該軟件產(chǎn)品及其開發(fā)目的的簡短描述,包括利益和目標(biāo)。把軟件產(chǎn)品開 發(fā)與企業(yè)目標(biāo),或者業(yè)務(wù)策略相聯(lián)系。描述產(chǎn)品范圍時需注意,可以參考項目視圖和范圍文檔,但是不能將其內(nèi)容 復(fù)制到這里。參考文獻(xiàn)列舉編寫軟件產(chǎn)品需求分析報告時所用到的參考文獻(xiàn)及資料,可能包括:木項目的合同書;上級機關(guān)有關(guān)本項目的批文;本項目已經(jīng)批準(zhǔn)的計劃任務(wù)書;用戶界面風(fēng)格指導(dǎo);開發(fā)本項目時所要用到的標(biāo)淮;系統(tǒng)規(guī)格需求說明;使用實例文檔;屬于本項目的其它己發(fā)表文件;本軟件產(chǎn)甜需求分析報告中所引用的文件、資料;相關(guān)軟件
26、產(chǎn)品需求分析報告;為了方便讀者查閱,所有參考資料應(yīng)該按一定順序排列。如果可能,每份資料 都應(yīng)該給出:標(biāo)題名稱;作者或者合同簽約者;文件編號或者版本號;發(fā)表日期或者簽約日期;出版單位或者資料來源。綜合描述這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運行的 環(huán)境、使用該軟件產(chǎn)品的用戶、對該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假 設(shè)和依賴。產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報告中所定義的軟件產(chǎn)品的背景和起源。說明了 該軟件產(chǎn)品是否屬于下列情況:是否是產(chǎn)品系列中的下一成員;是否是成熟產(chǎn)品所改進(jìn)的下一代產(chǎn)品;是否是現(xiàn)有應(yīng)用軟件的替代品升級產(chǎn)品;是否是一個新型的、自主型的產(chǎn)品。如果該軟件產(chǎn)品
27、需求分析報告定義的軟件系統(tǒng)是:大系統(tǒng)的一個組成部分;與其它系統(tǒng)和其它機構(gòu)之間存在基本的相互關(guān)系。那么必須說明軟件產(chǎn)品需求分析報告定義的這部分軟件是怎樣與整個大系 統(tǒng)相關(guān)聯(lián)的,或者(同時)說明相互關(guān)系的存在形式,并且要定義出兩者z間的全 部接口。產(chǎn)品的功能因為將在需求分析報告的第4部分屮詳細(xì)描述軟件產(chǎn)品的功能,所以在此只 需要概略地總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能,在描述功 能時應(yīng)該針對每一項需求準(zhǔn)確地描述其各項規(guī)格說明。如果存在引起誤解的可能, 在陳述本軟件產(chǎn)品主要功能的作用領(lǐng)域時,也需要對應(yīng)陳述本軟件產(chǎn)甜的非作用 領(lǐng)域,以利讀者理解木軟件產(chǎn)品。為了很好地組織產(chǎn)品功能,使每個
28、讀者都容易理解,可以采用列表的方法給 出。也可以采用圖形方式,將主要的需求分組以及它們之間的聯(lián)系使用數(shù)據(jù)流程 圖的頂層圖或類圖進(jìn)行表示,這種表示方法是很有用的。參考用戶當(dāng)前管理組織構(gòu)架,了解各個機構(gòu)的主要職能,將有助于陳述軟件 產(chǎn)品的主要功能。用戶類和特性確定有可能使用該軟件產(chǎn)品的不同用戶類,并且描述它們相關(guān)的特征。往往 有一些軟件需求,只與特定的用戶類有關(guān)。描述時,應(yīng)該將該軟件產(chǎn)品的重要用戶 類與非重要用戶類區(qū)分開。用戶不一定是軟件產(chǎn)品的育接使用者,通過報表、應(yīng)用程序接口、系統(tǒng)硬件 接口得到軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機構(gòu)也有他們的需求。所以,應(yīng)該將 這些外部需求視為通過報表、應(yīng)用程序接口
29、、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附 加用戶類。運行環(huán)境描述了本軟件的運行環(huán)境,一般包括:硬件平臺;操作系統(tǒng)和版木;支撐環(huán)境例如:數(shù)據(jù)庫等和版本;其它與該軟件有關(guān)的軟件組件;與該軟件共存的應(yīng)用程序。設(shè)計和實現(xiàn)上的限制確定影響開發(fā)人員自由選擇的問題,并且說明這些問題為什么成為一種限 制??赡艿南拗瓢ㄏ铝袃?nèi)容:必須使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫;避免使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫;要求遵循的開發(fā)規(guī)范和標(biāo)準(zhǔn)例如,如果由客戶的公司或者第三方公司負(fù)責(zé)軟件維護(hù),就必須定義轉(zhuǎn)包者所使用的設(shè)計符號表示和編碼標(biāo)準(zhǔn);企業(yè)策略的限制;政府法規(guī)的限制;工業(yè)標(biāo)準(zhǔn)的限制;硬件的限制例如,定時需求或存儲器限制
30、;數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。假設(shè)和約束依賴列舉出對軟件產(chǎn)品需求分析報告中,影響需求陳述的假設(shè)因素與己知因素相 對立。如果這些假設(shè)因素不正確、不一致或者被修改,就會使軟件產(chǎn)品開發(fā)項目 受到影響。這些假設(shè)的因素可能包括:計劃使用的商業(yè)組件,或者其它軟件中的某個部件;假定產(chǎn)品屮某個用戶界面將符合一個特殊的設(shè)計約定;有關(guān)本軟件用戶的若干假定例如:假定用戶會熟練使用sql語言。;有關(guān)本軟件開發(fā)工作的若干假定例如:用戶承諾的優(yōu)惠、方便、上級部門給 予的特殊政策和支持等。;有關(guān)木軟件運行環(huán)境的一些問題;此外,確定本軟件開發(fā)項目對外部約束因素所存在的依賴。有關(guān)的約束可能 包括:工期約束;經(jīng)費約束;人員約束;設(shè)備
31、約束;地理位置約束;其它有關(guān)項目約束;外部接口需求通過木節(jié)描述可以確定,保證軟件產(chǎn)品能和外部組件正確連接的需求。關(guān)聯(lián) 圖僅能表示高層抽彖的外部接口,必須對接口數(shù)據(jù)和外部組件進(jìn)行詳細(xì)描述,并且寫入數(shù)據(jù)定義中。如果產(chǎn)品的不同部分有不同的外部接口,那么應(yīng)該把這些外 部接口的全部詳細(xì)需求并入到這一部分實例中。注意:必須將附加用戶類的特征與外部接口需求加以區(qū)分,附加用戶類的特 征描述的是通過接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求;而外部接口需求描 述的是接口本身的需求。用戶界面陳述需要使用在用戶界面上的軟件組件,描述每一個用戶界面的邏輯特征。 必須注意,這里需要描述的是用戶界面的邏輯特征,而不是用戶界面
32、。以下是可能 包括的一些特征:將要采用的圖形用戶界而gui標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格;有關(guān)屏幕布局或者解決方案的限制;將要使用在每一個屏幕圖形用戶界面上的軟件組件,可能包括:選單;標(biāo)準(zhǔn)按鈕;導(dǎo)航鏈接;各種功能組件;消息欄;快捷鍵;各種顯示格式的規(guī)定,可能包括:不同情況下文字的對齊方式;不同情況下數(shù)字的表現(xiàn)格式與對齊方式口期的表現(xiàn)方法與格式;計時方法與時間格式;等等。錯誤信息顯示標(biāo)準(zhǔn);對于用戶界面的細(xì)節(jié),例如:一個特定對話框的布局,應(yīng)該寫入具體的用戶界 而設(shè)計說明中,而不能寫入軟件需求規(guī)格說明中。如果釆用現(xiàn)成的、合適的用戶界面設(shè)計規(guī)范標(biāo)準(zhǔn),或者另文描述,可以在這里 直接說明,并且將其加入?yún)⒖嘉墨I(xiàn)。碩
33、件接口描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征,若有多個硬件接口,則必須全都描述。接口特征的描述內(nèi)容可能包括:支持的硬件類型;軟、硬件z間交流的數(shù)據(jù);控制信息的性質(zhì);使用的通訊協(xié)議;軟件接口描述該軟件產(chǎn)品與其它外部組件的連接,這些外部組件必須明確它們的名稱 和版本號以資識別,可能的外部組件包括:操作系統(tǒng);數(shù)據(jù)庫;工具;函數(shù)庫;集成的商業(yè)組件說明:這里所說的“集成的商業(yè)組件”,是指與系統(tǒng)集成的商業(yè)組件,而不是 與軟件產(chǎn)甜集成的商業(yè)組件。例如:中間件、消息服務(wù),等等。描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需 要的服務(wù),以及與內(nèi)部組件通訊的性質(zhì)。確定軟件產(chǎn)品將與組件z間共享
34、的數(shù)據(jù)。 如果必須使用一種特殊的方法來實現(xiàn)數(shù)據(jù)共享機制,例如:在多用戶系統(tǒng)中的一 個全局?jǐn)?shù)據(jù)區(qū),那么就必須把它定義為一種實現(xiàn)上的限制。通訊接口描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求,包括:電子郵件;web瀏覽器;網(wǎng)絡(luò)通訊標(biāo)準(zhǔn)或者協(xié)議;數(shù)據(jù)交互用電子表格;必須定義相關(guān)的:消息格式;通訊安全或加密問題;數(shù)據(jù)傳輸速率;同步和異步通訊機制;系統(tǒng)功能需求需要進(jìn)行詳細(xì)的需求記錄,詳細(xì)列出與該系統(tǒng)功能相關(guān)的詳細(xì)功能需求,并 且,唯一地標(biāo)識每一項需求。這是必須提交給用戶的軟件功能,使得用戶可以使用 所提供的功能執(zhí)行服務(wù)或者使用所指定的使用實例執(zhí)行任務(wù)。描述軟件產(chǎn)品如何 響應(yīng)己知的出錯條件、非法輸入、非法動作
35、。如果每一項功能需求都能用一項,也只需要用一項測試用例就能進(jìn)行驗證, 那么就可以認(rèn)為功能需求已經(jīng)適當(dāng)?shù)剡M(jìn)行描述了。如果某項功能需求找不到合適 的測試用例,或者必須使用多項測試用例才能驗證,那么該項功能需求的描述必 然存在某些問題。功能需求是根據(jù)系統(tǒng)功能,即軟件產(chǎn)品所提供的主要服務(wù)來組織的??梢酝?過使用實例、運行模式、用戶類、對象類或者功能等級來組織這部分內(nèi)容,也可 以便用這些元素的組合??偠詚,必須選擇一種是讀者容易理解預(yù)期產(chǎn)品的組 織方案。用簡短的語句說明功能的名稱,例如:“4.1系統(tǒng)參數(shù)管理”。按照服務(wù)組織 的順序,逐條闡述系統(tǒng)功能。無論說明的是何種功能,都應(yīng)該針對該系統(tǒng)功能重復(fù) 敘述
36、4. 1 4. 3這三個部分??梢酝ㄟ^各種方式來組織這一部分內(nèi)容,例如采用:使用實例、運行模式、用 戶類、對象類、功能等級等,也可以采用它們的組合。其最終目的是,讓讀者容易 理解即將開發(fā)的軟件產(chǎn)品。-般來說,每個使用實例都對應(yīng)一個系統(tǒng)功能,因而按 照使用實例來組織內(nèi)容比較容易讓用戶理解。對應(yīng)一些被共享的獨立使用實例,可以定義一些公用系統(tǒng)功能。必須特別注意的是,在2. 2節(jié)“產(chǎn)品的功能”中描述的全部需求,以及它們的 規(guī)格說明;必須在某個系統(tǒng)功能描述中有所反映,而且不應(yīng)重復(fù)。說明和優(yōu)先級對該系統(tǒng)功能進(jìn)行簡短的說明,并且指出該系統(tǒng)功能的優(yōu)先級是:高、中、述 是低。需要的話,還可以包括對特定優(yōu)先級部分
37、的評價,例如:利益、損失、費用 和風(fēng)險,其相對優(yōu)先等級可以從1低到9高。激勵/響應(yīng)序列列岀輸入激勵用戶動作、來自外部設(shè)備的信號或者其它觸發(fā)并且定義針對 這?功能行為的系統(tǒng)響應(yīng)序列,這些序列將與使用實例中相關(guān)的對話元素相對 應(yīng)。描述激勵/響應(yīng)序列時,不僅需要描述基本過程,而且應(yīng)該描述可選擴充過程, 包括例外引起任務(wù)不能順序完成的情況稱為例外。疏忽了可選過程,有可能影響 軟件產(chǎn)品的功能;如果遺漏例外過程,則有可能會引發(fā)系統(tǒng)崩潰。如果采用流程圖來描述激勵/響應(yīng)序列,比較容易讓用戶理解。輸入/輸出數(shù)據(jù)列出輸入數(shù)據(jù)用戶輸入、來自外部接口的輸入或者其它輸入并且定義針對這 些輸入數(shù)據(jù)的處理計算方法,以及相應(yīng)
38、地輸出數(shù)據(jù),描述對應(yīng)區(qū)別:輸入數(shù)據(jù)和輸 出數(shù)據(jù)。當(dāng)有大量數(shù)據(jù)需要描述時,也可以分類描述數(shù)據(jù),并且注明各項數(shù)據(jù)的輸入、 輸出屬性。對于每一項數(shù)據(jù),均需要描述:數(shù)據(jù)名稱;實際含義;數(shù)據(jù)類型;數(shù)據(jù)格式;數(shù)據(jù)約束;對于復(fù)雜的處理方法,僅僅給出算法原理是不夠的,必須描述詳細(xì)的計算過 程,并且列出每一步具體使用的實際算式;如果計算過程屮涉及查表、判斷、迭代 等處理方法,應(yīng)該給出處理依據(jù)和相關(guān)數(shù)據(jù)。如果計算方法很簡單,也可以將其從 略,不加描述。其它非功能需求在這里列舉出所有非功能需求,主要包括可靠性、安全性、可維護(hù)性、可擴 展性、可測試性等。性能需求闡述不同應(yīng)用領(lǐng)域?qū)浖a(chǎn)品性能的需求,并且說明提出需求的
39、原理或者依 據(jù),以幫助開發(fā)人員做出合理的設(shè)計選擇。盡可能詳細(xì)地描述性能需求,如果需要, 可以針對每個功能需求或者特征分別陳述其性能需求。在這里確定:相互合作的用戶數(shù)量;系統(tǒng)支持的并發(fā)操作數(shù)量;響應(yīng)時間;與實時系統(tǒng)的時間關(guān)系:容量需求存儲器;磁盤空間;數(shù)據(jù)庫屮表的最大行數(shù)。安全措施需求詳盡陳述與軟件產(chǎn)品使用過程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。 定義必須采取的安全保護(hù)或動作,以及必須預(yù)防的潛在危險動作。明確軟件產(chǎn)品 必須遵從的安全標(biāo)準(zhǔn)、策略、或規(guī)則。安全性需求詳盡陳述與系統(tǒng)安全性、完整性問題相關(guān)的需求,或者與個人隱私問題相關(guān) 的需求。這些問題將會影響到軟件產(chǎn)品的使用,和軟件產(chǎn)品所創(chuàng)建或者使
40、用的數(shù) 據(jù)的保護(hù)。定義用戶身份認(rèn)證,或備授權(quán)需求。明確軟件產(chǎn)品必須滿足的安全性 或者保密性策略。也可以通過稱為完整性的質(zhì)量屬性來闡述這些需求。一個典型 的軟件系統(tǒng)安全需求范例如下:“每個用戶在第一次登錄后,必須更改他的系統(tǒng)預(yù) 置登錄密碼,系統(tǒng)預(yù)置的登錄密碼不能重用?!避浖|(zhì)量屬性詳盡陳述對客戶和開發(fā)人員至關(guān)重要的在軟件產(chǎn)品其它方面表現(xiàn)岀來的質(zhì) 量功能。這些功能必須是確定的、定量的、在需要時是可以驗證的。至少也應(yīng)該 指明不同屬性的相對側(cè)重點,例如:易用性優(yōu)于易學(xué)性,或者可移植性優(yōu)于有效 性。業(yè)務(wù)規(guī)則列舉岀有關(guān)軟件產(chǎn)品的所有操作規(guī)則,例如:那些人在特定環(huán)境下可以進(jìn)行 何種操作。這些本身不是功能需求
41、,但是他們可以暗示某些功能需求執(zhí)行這些規(guī) 則。一個業(yè)務(wù)規(guī)則的范例如下:“進(jìn)行達(dá)到或者超過10,000,00元人民幣的儲蓄 業(yè)務(wù)時,必須通過附加的管理員認(rèn)證?!绷信e業(yè)務(wù)規(guī)則時,可以根據(jù)規(guī)則的數(shù)量,選取合適的編口方式。用戶文檔列舉出將與軟件產(chǎn)品一同交付的用戶文檔,并且明確所有己知用戶文檔的交 付格式或標(biāo)準(zhǔn),例如:安裝指南紙質(zhì)文檔,16開本;用戶手冊紙質(zhì)文檔,16開本;在線幫助電子文檔,與軟件產(chǎn)品一同分發(fā)、配置;使用教程電子文檔,與軟件產(chǎn)品一同分發(fā)、配置。詞匯表列出本文件屮用到的專業(yè)術(shù)語的定義,以及有關(guān)縮寫的定義如有可能,列出 相關(guān)的外文原詞。為了便于非軟件專業(yè)或者非計算機專業(yè)人士閱讀軟件產(chǎn)品需求
42、分析報告,要求使用非軟件專業(yè)或者非計算機專業(yè)的術(shù)語描述軟件需求。所以這 里所指的專業(yè)術(shù)語,是指業(yè)務(wù)層而上的專業(yè)術(shù)語,而不是軟件專業(yè)或者計算機專 業(yè)的術(shù)語。但是,對于無法回避的軟件專業(yè)或者計算機專業(yè)術(shù)語,也應(yīng)該列入詞匯 表并且加以準(zhǔn)確定義。數(shù)據(jù)定義數(shù)據(jù)定義是一個定義了應(yīng)用程序中使用的所有數(shù)據(jù)元素和結(jié)構(gòu)的共享文檔, 其中對每個數(shù)據(jù)元素和結(jié)構(gòu)都準(zhǔn)確描述:含義、類型、數(shù)據(jù)大小、格式、計量單 位、精度以及取值范圍。數(shù)據(jù)定義的維護(hù)獨立于軟件需求規(guī)格說明,并且在軟件 產(chǎn)品開發(fā)和維護(hù)的任何階段,均向風(fēng)險承擔(dān)者開放。如果為軟件開發(fā)項目創(chuàng)建一個獨立的數(shù)據(jù)定義,而不是為每一項特性描述有 關(guān)的數(shù)據(jù)項,有利于避免冗余和
43、不一致性。但是卻不利于多人協(xié)同編寫需求分析 報告,容易遺漏數(shù)據(jù),也不方便閱讀。因此述是建議為每個特性描述有關(guān)的數(shù)據(jù)項, 匯總數(shù)據(jù)項創(chuàng)建數(shù)據(jù)定義,再根據(jù)數(shù)據(jù)定義復(fù)核全部數(shù)據(jù),使得它們的名稱和含 義完全一致。必須注意的是,為了避免二義性,在匯總數(shù)據(jù)項時應(yīng)該根據(jù)數(shù)據(jù)項所 代表的實際意義匯總,而不是根據(jù)數(shù)據(jù)項的名稱匯總。在數(shù)據(jù)定義中,每個數(shù)據(jù)項除了有一個中文名稱外,還應(yīng)該為它取一個簡短 的英文名稱,該英文名稱應(yīng)該符合命名規(guī)范,因為在軟件開發(fā)時將沿用該英文名 稱??梢允褂玫忍柋硎緮?shù)據(jù)項,名稱寫在左邊,定義寫在右邊。常見數(shù)據(jù)項的描述 方式如下:原數(shù)據(jù)元素一個原數(shù)據(jù)元素是不可分解的,可以將一個數(shù)量值賦給它。
44、定義原數(shù)據(jù)元素 必須確定其含義、類型、數(shù)據(jù)大小、格式、計量單位、精度以及取值范圍。采用以星號 為界的一行注釋文木,描述原數(shù)據(jù)元素的定義。選擇項選擇項是一種只可以取有限離散值的特殊原數(shù)據(jù)元素,描述時一一枚舉這些 值,并用方括號括起來寫在原數(shù)據(jù)元素的定義前。在兩項離散值之間,使用管道符分隔。 組合項組合項是一個數(shù)據(jù)結(jié)構(gòu)或者記錄,其屮包含了多個數(shù)據(jù)項。這些數(shù)據(jù)項可以 是原數(shù)據(jù)元素,也可以是組合數(shù)據(jù)項,各數(shù)據(jù)項之間用加號連接。其中每個數(shù)據(jù)項都必須 是數(shù)據(jù)定義中定義過的,結(jié)構(gòu)中也可以包括其它結(jié)構(gòu),但是絕對不允許遞歸。如果數(shù)據(jù) 結(jié)構(gòu)屮有可選項,使用圓括號把該項括起來。重復(fù)項重復(fù)項是組合項的一種特例,其中有
45、一項將有多個實例出現(xiàn)在數(shù)據(jù)結(jié)構(gòu)中, 使用花括號把該項括起來。如果知道該項可能允許的范圍,就按“最小值:最大值”的形 式寫在花括號前。分析模型這是一個可選部分,包括或涉及到相關(guān)的分析模型,例如:數(shù)據(jù)流程圖;類圖;狀態(tài)轉(zhuǎn)換圖;實體-關(guān)系圖。待定問題列表編輯一張在軟件產(chǎn)品需求分析報告中待確定問題時的列表,把每一個表項都 編上號,以便跟蹤調(diào)查。附錄b軟件概要設(shè)計報告文檔模板1. 引言231. 1編寫目的 231.2項目風(fēng)險 231.3預(yù)期讀者和閱讀建議 2314參考資料 232. 設(shè)計概述242. 1限制和約束242.2設(shè)計原則和設(shè)計要求243. 系統(tǒng)邏輯設(shè)計 253. 1系統(tǒng)組織設(shè)計253.2系統(tǒng)結(jié)
46、構(gòu)設(shè)計253. 2. 1系統(tǒng)特性表 263.2.2系統(tǒng)特性結(jié)構(gòu)圖273.3系統(tǒng)接口設(shè)計 273. 3. 1系統(tǒng)接口表273. 3.2系統(tǒng)接口傳輸協(xié)議說明 283. 4系統(tǒng)完整性設(shè)計284. 系統(tǒng)岀錯處理設(shè)計294. 1系統(tǒng)岀錯處理表294. 2維護(hù)處理過程表305. 技術(shù)設(shè)計315.1系統(tǒng)開發(fā)技術(shù)說明表 315.2開發(fā)技術(shù)應(yīng)用說明326. 數(shù)據(jù)庫設(shè)計327. 詞匯表 328. 進(jìn)度計劃32引言引言是對這份軟件系統(tǒng)概要設(shè)計報告的概覽,是為了幫助閱讀者了解這份文 檔是如何編寫的,并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫目的說明這份軟件系統(tǒng)概要設(shè)計報告是基于哪份軟件產(chǎn)品需求規(guī)格說明書編寫 的,開發(fā)
47、這個軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過這份軟件系統(tǒng) 概要設(shè)計報告詳盡說明了該軟件產(chǎn)品的軟件結(jié)構(gòu),包括數(shù)據(jù)庫結(jié)構(gòu)和出錯處理, 從而對該軟件產(chǎn)品的結(jié)構(gòu)的描述。如果這份軟件系統(tǒng)概要設(shè)計報告只與整個系統(tǒng)的某一部分有關(guān)系,那么只定 義軟件系統(tǒng)概要設(shè)計報告中說明的那個部分或子系統(tǒng)。項目風(fēng)險具體說明本軟件開發(fā)項目的全部風(fēng)險承擔(dān)者,以及各白在本階段所需要承擔(dān) 的主要風(fēng)險,首要風(fēng)險承擔(dān)者包括:任務(wù)提岀者;軟件開發(fā)者;產(chǎn)品使用者。預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)概要設(shè)計報告所針對的各種不同的預(yù)期讀者,例如,可能的 讀者包括:用戶;開發(fā)人員;項口經(jīng)理;營銷人員;測試人員;文檔編寫人員;等等。描述文檔中,
48、其余部分的內(nèi)容及其組織結(jié)構(gòu),并且針對每一類讀者提出最適 合的文檔閱讀建議。參考資料列舉編寫軟件產(chǎn)品概要設(shè)計報告時所用到的參考文獻(xiàn)及資料,可能包括:本項目的合同書;上級機關(guān)有關(guān)本項目的批文;木項目己經(jīng)批準(zhǔn)的計劃任務(wù)書;用戶界面風(fēng)格指導(dǎo);開發(fā)本項目時所要用到的標(biāo)準(zhǔn);系統(tǒng)規(guī)格需求說明;使用實例文檔;屬于木項目的其它己發(fā)表文件;本軟件系統(tǒng)概要設(shè)計報告屮所引用的文件、資料:相關(guān)軟件系統(tǒng)概要設(shè)計報告:等等。為了方便讀者查閱,所有參考資料應(yīng)該按一定順排列。如果可能,每份資料都 應(yīng)該給出:標(biāo)題名稱;作者或者合同簽約者;文件編號或者版本號;發(fā)表日期或者簽約日期;出版單位或者資料來源。設(shè)計概述木節(jié)描述現(xiàn)有開發(fā)條件
49、和需要實現(xiàn)的目標(biāo),說明進(jìn)行概要設(shè)計時應(yīng)該遵循的 設(shè)計原則和必須采用的設(shè)計方法。限制和約束簡要描述起到限制和約束作用的各種可能存在的條件,例如:技術(shù)條件;資金狀況;開發(fā)環(huán)境包括:工具和平臺;時間限制;等等。并且說明在上述條件下,應(yīng)該實現(xiàn)的系統(tǒng)目標(biāo),設(shè)計原則和設(shè)計要求描述對本軟件系統(tǒng)進(jìn)行概要設(shè)計的原則,通??梢钥紤]以下幾方面的內(nèi)容:命名規(guī)則;模塊獨立性原則:邊界設(shè)計原則;數(shù)據(jù)庫設(shè)計規(guī)則;必須的安全措施;安全性和保密原則;系統(tǒng)靈活性要求;系統(tǒng)易操作性要求;系統(tǒng)可維護(hù)性要求;等等。系統(tǒng)邏輯設(shè)計本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說明書和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng) 的邏輯模型。此種模型暫時與系統(tǒng)的物理因素例如
50、:計算機、數(shù)據(jù)庫管理系統(tǒng)無 關(guān)。它是系統(tǒng)需求與物理實現(xiàn)的中間結(jié)構(gòu),它的主要結(jié)果是建立:系統(tǒng)結(jié)構(gòu)圖、系 統(tǒng)界而結(jié)構(gòu)圖、系統(tǒng)出錯處理、以及系統(tǒng)開發(fā)技術(shù)說明。說明:如果進(jìn)行系統(tǒng)設(shè)計時尚未編寫軟件數(shù)據(jù)字典:應(yīng)首先參照附錄b說明, 編寫軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后,再進(jìn)行系統(tǒng)設(shè)計。系統(tǒng)組織設(shè)計系統(tǒng)組織設(shè)計通過系統(tǒng)組織表描述本系統(tǒng)由哪些子系統(tǒng)模塊組成,這些子系 統(tǒng)與業(yè)務(wù)職能之間的關(guān)系,以及各個子系統(tǒng)的安裝地點。系統(tǒng)組織表的格式如下:子系統(tǒng)編號 英文名稱 中文名稱 業(yè)務(wù)職能 安裝地點 備注其中:子系統(tǒng)編號給出本系統(tǒng)中指定子系統(tǒng)的順序編號。如果本系統(tǒng)末劃分為多個子系統(tǒng),僅 由一個運行模塊組成;則本項內(nèi)容
51、仍需要描述,但是本表內(nèi)容只有一行。說明:在一個系統(tǒng)中有可能安裝若干個相同的子系統(tǒng),在這種情況下,應(yīng)該視一個子系統(tǒng),并且對多個安裝地點分別進(jìn)行描述。如果相同的子系統(tǒng)通過系統(tǒng)設(shè)置,實現(xiàn)的業(yè)務(wù)職能具有明顯差異時,應(yīng)該釆用多行進(jìn)行分別描述,并且在備中說明其差異所在。子系統(tǒng)英文名稱給出本子系統(tǒng)的英文名稱,該名稱是在應(yīng)用軟件屮實際使用的可執(zhí)行文件名 稱,必須能夠說明該子系統(tǒng)的特點。若本系統(tǒng)中只有一個子系統(tǒng),則本項內(nèi)容仍需要描述,但是本表內(nèi)容只有一 行。子系統(tǒng)屮文名稱給岀本子系統(tǒng)的中文名稱,該名稱必須能夠說明該子系統(tǒng)的特點。若本系統(tǒng)中只有一個子系統(tǒng),則本項內(nèi)容仍需要描述,但是本表內(nèi)容只有一 行。業(yè)務(wù)職能描述該子系統(tǒng)完成的核心業(yè)務(wù)。安裝地點描述該子系統(tǒng)實際安裝的部門、或者某個具體地點。備注針對該子系統(tǒng)
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 小數(shù)除以整數(shù)質(zhì)量練習(xí)習(xí)題
- 2025年度會議場地綠化及環(huán)境衛(wèi)生合同
- 2025年度基站場地租賃合同模板(附租賃期滿續(xù)租條款)
- 2025年度新能源汽車推廣合同更改擔(dān)保協(xié)議書
- 2025年度智能農(nóng)業(yè)項目集資入股合同范本
- 2025年度綠色有機蔬菜基地租賃合作合同
- 2025年度國際貿(mào)易化妝品進(jìn)出口貿(mào)易合同范本
- 2025年度涵洞工程材料供應(yīng)勞務(wù)合作合同
- 2025年度離婚協(xié)議書無財產(chǎn)無子女版本修訂合同
- 2025年度信息技術(shù)服務(wù)簡易勞動合同(樣板范本)
- 教體局校車安全管理培訓(xùn)
- 導(dǎo)播理論知識培訓(xùn)班課件
- 行車起重作業(yè)風(fēng)險分析及管控措施
- 空氣能安裝合同
- 電廠檢修安全培訓(xùn)課件
- 初二上冊的數(shù)學(xué)試卷
- 四大名繡課件-高一上學(xué)期中華傳統(tǒng)文化主題班會
- 大模型關(guān)鍵技術(shù)與應(yīng)用
- 起重機械生產(chǎn)單位題庫質(zhì)量安全員
- 高中生物選擇性必修1試題
- 后顱窩腫瘤的護(hù)理
評論
0/150
提交評論