軟件項(xiàng)目開(kāi)發(fā)和管理規(guī)范及軟件需求分析報(bào)告(模板)

PAGEPAGE23軟件項(xiàng)目開(kāi)發(fā)和管理規(guī)范V1軟件開(kāi)發(fā)標(biāo)準(zhǔn)化工作流程引言編寫(xiě)目的軟件項(xiàng)目管理是軟件工程和項(xiàng)目管理的交叉學(xué)科，軟件項(xiàng)目管理的概念涵蓋了管理軟件產(chǎn)品開(kāi)發(fā)所必須的知識(shí)、技術(shù)及工具。根據(jù)美國(guó)項(xiàng)目管理協(xié)會(huì)PMI對(duì)項(xiàng)目管理的定義可以將軟件項(xiàng)目管理定義為：在軟件項(xiàng)目活動(dòng)中運(yùn)用一系列知識(shí)、技能、工具和技術(shù)，以滿足軟件需求方的整體要求。軟件項(xiàng)目管理是為了使軟件項(xiàng)目能夠按照預(yù)定的成本、進(jìn)度、質(zhì)量順利完成，而對(duì)成本、人員、進(jìn)度、質(zhì)量、風(fēng)險(xiǎn)等進(jìn)行分析和管理的活動(dòng)。實(shí)際上，軟件項(xiàng)目管理的意義不僅僅如此，進(jìn)行軟件項(xiàng)目管理有利于將開(kāi)發(fā)人員的個(gè)人開(kāi)發(fā)能力轉(zhuǎn)化成企業(yè)的開(kāi)發(fā)能力，企業(yè)的軟件開(kāi)發(fā)能力越高，表明這個(gè)企業(yè)的軟件生產(chǎn)越趨向于成熟，企業(yè)越能夠穩(wěn)定發(fā)展。軟件生存周期包括可行性分析與項(xiàng)目開(kāi)發(fā)計(jì)劃、需求分析、設(shè)計(jì)（概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)）、編碼、測(cè)試、維護(hù)等活動(dòng)，所有這些活動(dòng)都必須進(jìn)行管理，在每個(gè)階段都存在著權(quán)限角色控制、文檔管理、版本控制、管理工具等，軟件項(xiàng)目管理貫穿于軟件生命的演化過(guò)程之中。適用范圍所有軟件項(xiàng)目管理。定義列出本文件中用到的專門(mén)術(shù)語(yǔ)的定義、外文首字母組詞的原詞組。軟件項(xiàng)目管理過(guò)程概述為保證軟件項(xiàng)目獲得成功，必須對(duì)軟件開(kāi)發(fā)項(xiàng)目的工作范圍、要完成的任務(wù)、需要的資源、需要的工作量、進(jìn)度的安排、可能遇到的風(fēng)險(xiǎn)等做到心中有數(shù)。軟件項(xiàng)目的管理工作開(kāi)始于技術(shù)工作開(kāi)始之前，在軟件從概念到實(shí)現(xiàn)的過(guò)程中持續(xù)進(jìn)行，最后終止于軟件開(kāi)發(fā)工作結(jié)束。流程圖注：帶書(shū)名號(hào)《》的為項(xiàng)目開(kāi)發(fā)過(guò)程中需提交的文檔。項(xiàng)目管理過(guò)程啟動(dòng)軟件項(xiàng)目啟動(dòng)軟件項(xiàng)目是指必須明確項(xiàng)目的目標(biāo)和范圍、考慮可能的解決方案以及技術(shù)和管理上的要求等，這些信息是軟件項(xiàng)目運(yùn)行和管理的基礎(chǔ)。制定項(xiàng)目計(jì)劃項(xiàng)目計(jì)劃在項(xiàng)目開(kāi)始的時(shí)候制定，并隨著項(xiàng)目的進(jìn)展不斷發(fā)展，項(xiàng)目計(jì)劃為管理者提供了根據(jù)計(jì)劃定期評(píng)審和跟蹤項(xiàng)目進(jìn)展的基礎(chǔ)。計(jì)劃的制定以下面的活動(dòng)為依據(jù)：估算項(xiàng)目所需要的工作量估算項(xiàng)目所需要的資源根據(jù)工作量制定進(jìn)度計(jì)劃，繼而進(jìn)行資源分配做出配置管理計(jì)劃跟蹤及控制項(xiàng)目計(jì)劃在軟件項(xiàng)目進(jìn)行過(guò)程中，嚴(yán)格遵守項(xiàng)目計(jì)劃，對(duì)于一些不可避免的變更，要進(jìn)行適當(dāng)?shù)目刂坪驼{(diào)整，但要確保計(jì)劃的完整性和一致性。評(píng)審項(xiàng)目計(jì)劃對(duì)項(xiàng)目計(jì)劃的完成程序進(jìn)行評(píng)審，并對(duì)項(xiàng)目的執(zhí)行情況進(jìn)行評(píng)價(jià)。編寫(xiě)管理文檔項(xiàng)目管理人員根據(jù)軟件合同確定軟件項(xiàng)目是否完成。項(xiàng)目一旦完成，則檢查項(xiàng)目完成的結(jié)果和中間記錄文檔，并把所有的結(jié)果記錄下來(lái)形成文檔而保存。軟件項(xiàng)目管理內(nèi)容需求階段管理需求分析是軟件生命周期中相當(dāng)重要的一個(gè)階段，是軟件設(shè)計(jì)的基礎(chǔ)，也是用戶和軟件工程人員之間的橋梁。簡(jiǎn)單地說(shuō)，軟件需求就是確定系統(tǒng)需要做什么，嚴(yán)格意義上，軟件需求是系統(tǒng)或軟件必須達(dá)到的目標(biāo)與能力。目標(biāo)需求管理是一種獲取、組織并記錄軟件需求的系統(tǒng)化方案，同時(shí)也是一個(gè)使客戶與項(xiàng)目開(kāi)發(fā)組對(duì)不斷變更的軟件需求達(dá)成并保持一致的過(guò)程。在需求管理中，軟件工程組的工作是采取適當(dāng)?shù)拇胧﹣?lái)保證分配的需求，即要將分配的需求文檔化，控制需求的變化，負(fù)責(zé)項(xiàng)目實(shí)施過(guò)程中需求的實(shí)現(xiàn)情況。需求管理的目的是在客戶和處理客戶需求的軟件項(xiàng)目組之間建立對(duì)客戶需求的共同理解。需求管理的目標(biāo)有兩個(gè)：使軟件需求受控，并建立供軟件工程和管理使用的需求基線。使軟件計(jì)劃、產(chǎn)品和活動(dòng)與軟件需求保持一致。在需求管理過(guò)程中，為實(shí)現(xiàn)第一個(gè)目標(biāo)，必須控制需求基線的變動(dòng)，按照變更控制的標(biāo)準(zhǔn)和規(guī)范的過(guò)程進(jìn)行需求變更控制和版本控制；為實(shí)現(xiàn)第二個(gè)目標(biāo)，必須就變更和軟件項(xiàng)目各小組達(dá)成共識(shí)，對(duì)軟件項(xiàng)目計(jì)劃做出調(diào)整，其中包括人員的安排、用戶的溝通、成本的調(diào)整、進(jìn)度的調(diào)整等。需求管理是一個(gè)對(duì)系統(tǒng)需求變更了解和控制的過(guò)程，它貫穿于整個(gè)軟件項(xiàng)目過(guò)程，在軟件項(xiàng)目進(jìn)行的過(guò)程中，無(wú)論正處于哪個(gè)階段，一旦有需求錯(cuò)誤出現(xiàn)或任何有關(guān)需求的變更出現(xiàn)，都需要需求管理活動(dòng)來(lái)解決，提交《需求變更控制報(bào)告》。原則為進(jìn)行有效的需求管理，一般要遵循如下五條原則：需求一定要分類管理需求必須分優(yōu)先級(jí)需求必須文檔化需求一旦變化，就必須對(duì)需求變更的影響進(jìn)行評(píng)估需求管理必須與需求工程的其他活動(dòng)緊密整合主要工作需求階段分為系統(tǒng)需求和系統(tǒng)分析兩個(gè)階段。系統(tǒng)需求階段的主要工作是：調(diào)研用戶需求及用戶環(huán)境論證項(xiàng)目可行性制定項(xiàng)目初步計(jì)劃系統(tǒng)分析階段的主要工作是：確定系統(tǒng)運(yùn)行環(huán)境建立系統(tǒng)邏輯模型確定系統(tǒng)功能及性能要求編寫(xiě)需求規(guī)格說(shuō)明、測(cè)試計(jì)劃確認(rèn)項(xiàng)目開(kāi)發(fā)計(jì)劃完成文檔需求規(guī)格說(shuō)明書(shū)、項(xiàng)目開(kāi)發(fā)計(jì)劃、測(cè)試計(jì)劃設(shè)計(jì)階段管理主要工作軟件的設(shè)計(jì)階段可分為概要設(shè)計(jì)和詳細(xì)設(shè)計(jì)兩個(gè)階段。概要設(shè)計(jì)的主要工作：建立系統(tǒng)總體結(jié)構(gòu)，劃分功能模塊定義各功能模塊接口數(shù)據(jù)庫(kù)設(shè)計(jì)（如果需要）詳細(xì)設(shè)計(jì)的主要工作：設(shè)計(jì)各模塊具體實(shí)現(xiàn)算法確定模塊間詳細(xì)接口完成文檔概要設(shè)計(jì)完成文檔概要設(shè)計(jì)說(shuō)明書(shū)數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)（如果有）詳細(xì)設(shè)計(jì)完成文檔：詳細(xì)設(shè)計(jì)說(shuō)明書(shū)開(kāi)發(fā)階段管理主要工作編寫(xiě)程序源代碼進(jìn)行模塊測(cè)試和調(diào)試編寫(xiě)測(cè)試方案編寫(xiě)測(cè)試用例編寫(xiě)用戶手冊(cè)完成文檔系統(tǒng)源程序清單測(cè)試用例測(cè)試方案測(cè)試階段管理主要工作執(zhí)行測(cè)試測(cè)試整個(gè)軟件系統(tǒng)（健壯性測(cè)試）完善用戶手冊(cè)編寫(xiě)開(kāi)發(fā)總結(jié)報(bào)告完成文檔測(cè)試報(bào)告用戶手冊(cè)開(kāi)發(fā)工作總結(jié)維護(hù)階段管理主要工作為糾正錯(cuò)誤，完善應(yīng)用而進(jìn)行修改對(duì)修改進(jìn)行配置管理編寫(xiě)故障報(bào)告和修改報(bào)告修訂用戶手冊(cè)完成文檔故障報(bào)告修改報(bào)告工具管理列出開(kāi)發(fā)的工具軟件項(xiàng)目估算與進(jìn)度管理軟件項(xiàng)目估算軟件項(xiàng)目估算包括工作量估算和成本估算兩個(gè)方面。軟件估算作為軟件項(xiàng)目管理的一項(xiàng)重要內(nèi)容，是確保軟件項(xiàng)目成功的關(guān)鍵因素。估算是指通過(guò)預(yù)測(cè)構(gòu)造軟件項(xiàng)目所需要的工作量的過(guò)程。初步的估算用于確定軟件項(xiàng)目的可行性，詳細(xì)的估算用于指導(dǎo)項(xiàng)目計(jì)劃的制定。軟件規(guī)模對(duì)軟件項(xiàng)目進(jìn)行估算遇到的第一個(gè)問(wèn)題就是軟件規(guī)模，即軟件的程序量。軟件規(guī)模是軟件工作量的主要影響因素。軟件項(xiàng)目的設(shè)計(jì)有一個(gè)分層結(jié)構(gòu)，這一分層結(jié)構(gòu)就對(duì)應(yīng)著工作分解結(jié)構(gòu)（WBS，WorkBreakdownStructure），它將軟件過(guò)程和軟件產(chǎn)品結(jié)構(gòu)聯(lián)系起來(lái)。下圖是一個(gè)典型的WBS結(jié)構(gòu)：系系統(tǒng)子系統(tǒng)子系統(tǒng)子系統(tǒng)模塊模塊模塊模塊模塊模塊模塊模塊模塊模塊有了工作分解結(jié)構(gòu)之后，必須定義度量標(biāo)準(zhǔn)用以對(duì)軟件規(guī)模進(jìn)行估計(jì)。常用的軟件規(guī)模度量標(biāo)準(zhǔn)有兩種：代碼行LOC（LinesOfCode）和功能點(diǎn)FP（FunctionPoints）。代碼行代碼行LOC是常用的源代碼程序長(zhǎng)度的度量標(biāo)準(zhǔn)，指源代碼的總行數(shù)。源代碼中除了可執(zhí)行語(yǔ)句外，還有幫助理解的注釋語(yǔ)句。功能點(diǎn)功能點(diǎn)度量是在需求分析階段基于系統(tǒng)功能的一種規(guī)模估計(jì)方法，該方法通過(guò)已經(jīng)初始應(yīng)用需求來(lái)確定各種輸入、輸出、查詢、外部文件和內(nèi)部文件的數(shù)目，從而確定功能點(diǎn)數(shù)量。成本估算成本估算是對(duì)完成軟件項(xiàng)目所需費(fèi)用的估計(jì)和計(jì)劃，是軟件項(xiàng)目計(jì)劃中的一個(gè)重要組成部分。進(jìn)度安排在確定了項(xiàng)目資源（總成本、人員、時(shí)間等），把其分配到各個(gè)項(xiàng)目開(kāi)發(fā)階段中，即確定項(xiàng)目的進(jìn)度。進(jìn)度的合理安排是如期完成軟件項(xiàng)目的重要保證，也是合理分配資源的重要依據(jù)，建議進(jìn)度安排使用Gantt圖（甘特圖）。項(xiàng)目整體進(jìn)度安排的過(guò)程如下：根據(jù)項(xiàng)目總體進(jìn)度目標(biāo)，編制人員計(jì)劃。將各階段所需要的資源和可以取得的資源進(jìn)行比較，確定各階段的初步進(jìn)度，然后確定整個(gè)項(xiàng)目的初步進(jìn)度。對(duì)初步進(jìn)度計(jì)劃進(jìn)行評(píng)審，確保該計(jì)劃滿足要求，否則就重復(fù)上面的步驟。進(jìn)度安排的詳細(xì)程度取決于相應(yīng)工作分解結(jié)構(gòu)的詳細(xì)程度，而工作分解結(jié)構(gòu)又取決于項(xiàng)目當(dāng)前所處階段與歷史經(jīng)驗(yàn)，進(jìn)度安排計(jì)劃隨著項(xiàng)目的進(jìn)展而動(dòng)態(tài)調(diào)整，逐漸趨于更加詳細(xì)準(zhǔn)確。在軟件項(xiàng)目進(jìn)行過(guò)程中，要及時(shí)更新項(xiàng)目進(jìn)度，以使管理者及時(shí)了解項(xiàng)目進(jìn)展情況。軟件需求分析報(bào)告-（模板）目錄1.范圍 12.總體要求 12.1總體功能要求 12.2軟件開(kāi)發(fā)平臺(tái)要求 12.3軟件項(xiàng)目的開(kāi)發(fā)實(shí)施過(guò)程管理要求 22.3.1軟件項(xiàng)目實(shí)施過(guò)程總體要求 22.3.2軟件項(xiàng)目實(shí)施變更要求 22.3.3軟件項(xiàng)目實(shí)施里程碑控制 23.軟件開(kāi)發(fā) 33.1軟件的需求分析 33.1.1需求分析 33.1.2需求分析報(bào)告的編制者 43.1.3需求報(bào)告評(píng)審 43.1.4需求報(bào)告格式 43.2軟件的概要設(shè)計(jì) 43.2.1概要設(shè)計(jì) 43.2.2編寫(xiě)概要設(shè)計(jì)的要求 43.2.3概要設(shè)計(jì)報(bào)告的編寫(xiě)者 43.2.4概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別 43.2.5概要設(shè)計(jì)的評(píng)審 43.2.6概要設(shè)計(jì)格式 43.3軟件的詳細(xì)設(shè)計(jì) 53.3.1詳細(xì)設(shè)計(jì) 53.3.2特例 53.3.3詳細(xì)設(shè)計(jì)的要求 53.3.4數(shù)據(jù)庫(kù)設(shè)計(jì) 53.3.5詳細(xì)設(shè)計(jì)的評(píng)審 53.3.6詳細(xì)設(shè)計(jì)格式 53.4軟件的編碼 53.4.1軟件編碼 53.4.2軟件編碼的要求 53.4.3編碼的評(píng)審 63.4.4編程規(guī)范及要求 63.5軟件的測(cè)試 63.5.1軟件測(cè)試 63.5.2測(cè)試計(jì)劃 63.6軟件的交付準(zhǔn)備 63.6.1交付清單 63.7軟件的鑒定驗(yàn)收 73.7.1軟件的鑒定驗(yàn)收 73.7.2驗(yàn)收人員 73.7.3驗(yàn)收具體內(nèi)容 73.7.4軟件驗(yàn)收測(cè)試大綱 73.8培訓(xùn) 73.8.1系統(tǒng)應(yīng)用培訓(xùn) 73.8.2系統(tǒng)管理的培訓(xùn)（可選） 8HYPERLINK附錄A軟件需求分析報(bào)告文檔模板 9HYPERLINK附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板 21HYPERLINK附錄C軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板 33HYPERLINK附錄D軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板 43HYPERLINK附錄E軟件測(cè)試(驗(yàn)收)大綱 55范圍本指南用于指導(dǎo)軟件開(kāi)發(fā)者為南京市交通局開(kāi)發(fā)軟件項(xiàng)目的過(guò)程，通過(guò)規(guī)范軟件項(xiàng)目承擔(dān)單位的開(kāi)發(fā)過(guò)程達(dá)到提高軟件質(zhì)量，降低維護(hù)成本的目的。開(kāi)發(fā)者應(yīng)根據(jù)本指南進(jìn)行軟件開(kāi)發(fā)和編制軟件開(kāi)發(fā)文檔。本指南是對(duì)軟件項(xiàng)目承擔(dān)單位的基本要求。在本指南的附錄A至E中提供了文檔的編寫(xiě)模板供開(kāi)發(fā)者參考，在進(jìn)行具體軟件開(kāi)發(fā)時(shí)，開(kāi)發(fā)者可根據(jù)實(shí)際情況采編寫(xiě)，但必須提供雙方約定的文檔，文檔中約定的內(nèi)容必須描述清楚?？傮w要求總體功能要求網(wǎng)絡(luò)應(yīng)用環(huán)境以Internet/Intranet技術(shù)為核心。開(kāi)發(fā)者應(yīng)在充分分析需求的基礎(chǔ)上，選擇采用B/S結(jié)構(gòu)或者C/S結(jié)構(gòu)。軟件系統(tǒng)的數(shù)據(jù)庫(kù)應(yīng)依照《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》進(jìn)行設(shè)計(jì)和建設(shè)。本指南中沒(méi)有規(guī)定開(kāi)發(fā)者采用何種具體的軟件工程開(kāi)發(fā)方法，開(kāi)發(fā)者可根據(jù)項(xiàng)目具體特點(diǎn)、自身擅長(zhǎng)來(lái)選擇采用面向過(guò)程的方法、面向?qū)ο蟮姆椒ɑ蛎嫦驍?shù)據(jù)的方法，但建議開(kāi)發(fā)商使用面向?qū)ο筌浖こ痰姆椒ǎ纾翰捎媚壳氨粡V泛使用的RUP(RationalUnifiedProcess)方法來(lái)進(jìn)行分析、設(shè)計(jì)和開(kāi)發(fā)。軟件開(kāi)發(fā)平臺(tái)要求開(kāi)發(fā)者開(kāi)發(fā)的軟件必須能夠在南京市交通局規(guī)定的軟件平臺(tái)上正常運(yùn)行。目前軟件平臺(tái)為：數(shù)據(jù)庫(kù)管理系統(tǒng)：Oracle9i以上版本中間件(應(yīng)用服務(wù)器)系統(tǒng)：IBMWebSphereOA系統(tǒng)：LotusDomino/Notes網(wǎng)絡(luò)架構(gòu)：完全支持TCP/IP協(xié)議開(kāi)發(fā)工具或技術(shù)體系：為保證軟件的上下兼容性，開(kāi)發(fā)者應(yīng)選擇比較通用的開(kāi)發(fā)工具的較新版本進(jìn)行開(kāi)發(fā)，如MicrosoftVisualStudio.Net，BorlandDelphi，C++Builder,或J2EE(Java2P1atformEnterpriseEdition)等。軟件項(xiàng)目的開(kāi)發(fā)實(shí)施過(guò)程管理要求軟件項(xiàng)目實(shí)施過(guò)程總體要求開(kāi)發(fā)者提交軟件開(kāi)發(fā)工作大綱，交通局組織專家組對(duì)工作大綱進(jìn)行評(píng)審，并提出整改意見(jiàn)。通過(guò)評(píng)審后，開(kāi)發(fā)者根據(jù)整改意見(jiàn)完善工作大綱，經(jīng)過(guò)交通局認(rèn)可后組織項(xiàng)目組進(jìn)行軟件開(kāi)發(fā)。軟件開(kāi)發(fā)工作按照需求分析、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、編碼、測(cè)試等幾個(gè)階段進(jìn)行，在開(kāi)發(fā)過(guò)程中，開(kāi)發(fā)者需分階段提交相關(guān)文檔。在軟件開(kāi)發(fā)工作完成后，開(kāi)發(fā)者應(yīng)向交通局提交完整的軟件文檔，交通局組織驗(yàn)收組對(duì)軟件進(jìn)行驗(yàn)收審查。軟件項(xiàng)目實(shí)施變更要求在開(kāi)發(fā)過(guò)程中，需求或設(shè)計(jì)不可避免地需要發(fā)生變更，相關(guān)變更必須經(jīng)過(guò)交通局書(shū)面同意方可進(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)的審批意見(jiàn)項(xiàng)目經(jīng)理簽字審批意見(jiàn)：簽字日期客戶簽字(合同項(xiàng)目)審批意見(jiàn)：簽字日期更改需求文檔變更后的需求文檔輸入名稱，版本，完成日期等信息更改人簽字重新評(píng)審需求文檔需求評(píng)審小組簽字評(píng)審意見(jiàn)：簽字日期變更結(jié)束項(xiàng)目經(jīng)理簽字簽字日期軟件項(xiàng)目實(shí)施里程碑控制交通局將分四個(gè)階段進(jìn)行把關(guān)，召開(kāi)專家審查會(huì)。需求分析（結(jié)合原型進(jìn)行審查）確認(rèn)；概要設(shè)計(jì)+數(shù)據(jù)庫(kù)設(shè)計(jì)；預(yù)驗(yàn)收（試運(yùn)行后）；正式驗(yàn)收（推廣使用后）。軟件開(kāi)發(fā)合同簽訂以后，項(xiàng)目承擔(dān)單位即可組織項(xiàng)目組進(jìn)行軟件開(kāi)發(fā)工作。軟件開(kāi)發(fā)必須嚴(yán)格按照軟件工程的要求進(jìn)行。開(kāi)發(fā)過(guò)程包括開(kāi)發(fā)者的活動(dòng)和任務(wù)。此過(guò)程由軟件需求分析、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、編碼、測(cè)試、驗(yàn)收、鑒定等活動(dòng)組成。軟件的需求分析需求分析首先，開(kāi)發(fā)者和交通局應(yīng)共同對(duì)交通局的應(yīng)用需求作充分的調(diào)研，提交完整的需求分析報(bào)告。在需求分析報(bào)告中必須描述的基本問(wèn)題是：功能、性能、強(qiáng)加于實(shí)現(xiàn)的設(shè)計(jì)限制、屬性、外部接口。應(yīng)當(dāng)避免把設(shè)計(jì)或項(xiàng)目需求寫(xiě)入需求分析報(bào)告中。它必須說(shuō)明由軟件獲得的結(jié)果，而不是獲得這些結(jié)果的手段。軟件需求可以用若干種方法來(lái)表達(dá)，如通過(guò)輸入、輸出說(shuō)明；使用代表性的例子；用規(guī)范化的模型。開(kāi)發(fā)者應(yīng)盡可能地使用模型的方式，因?yàn)檫@是表達(dá)復(fù)雜需求的精確和有效的方法。比如用統(tǒng)一建模語(yǔ)言（UML）來(lái)描述需求。編寫(xiě)需求分析報(bào)告的要求a．無(wú)歧義性對(duì)最終產(chǎn)品的每一個(gè)特性用某一術(shù)語(yǔ)描述；若某一術(shù)語(yǔ)在某一特殊的行文中使用時(shí)具有多種含義，那么應(yīng)對(duì)該術(shù)語(yǔ)的每種含義做出解釋并指出其適用場(chǎng)合。b．完整性需求分析報(bào)告應(yīng)該包括全部有意義的需求，無(wú)論是關(guān)系到功能的、性能的、設(shè)計(jì)約束的、還是關(guān)系到外部接口方面的需求；對(duì)所有可能出現(xiàn)的輸入數(shù)據(jù)的響應(yīng)予以定義，要對(duì)合法和非合法的輸入值的響應(yīng)做出規(guī)定；填寫(xiě)全部插圖、表、圖示標(biāo)記等；定義全部術(shù)語(yǔ)和度量單位。c．可驗(yàn)證性需求分析報(bào)告描述的每一個(gè)需求應(yīng)是可以驗(yàn)證的?？梢酝ㄟ^(guò)一個(gè)有限處理過(guò)程來(lái)檢查軟件產(chǎn)品是否滿足需求。d．一致性在需求分析報(bào)告中的各個(gè)需求的描述不能互相矛盾。e．可修改性需求分析報(bào)告應(yīng)具有一個(gè)有條不紊、易于使用的內(nèi)容組織；沒(méi)有冗余，即同一需求不能在需求分析報(bào)告中出現(xiàn)多次。f．可追蹤性每一個(gè)需求的源流必須清晰，在進(jìn)一步產(chǎn)生和改變文件編制時(shí)，可以方便地引證每一個(gè)需求。g．運(yùn)行和維護(hù)階段的可使用性需求分析報(bào)告必須滿足運(yùn)行和維護(hù)階段的需要。在需求分析報(bào)告要寫(xiě)明功能的來(lái)源和目的。需求分析報(bào)告的編制者需求分析報(bào)告應(yīng)由交通局和開(kāi)發(fā)者雙方共同完成。其中：交通局負(fù)責(zé)根據(jù)實(shí)際需要提出希望軟件實(shí)現(xiàn)的功能；軟件開(kāi)發(fā)者根據(jù)交通局提出的性能需求，結(jié)合軟件開(kāi)發(fā)編寫(xiě)需求分析。需求報(bào)告評(píng)審在軟件需求分析工作完成后，軟件開(kāi)發(fā)者應(yīng)向交通局提交《軟件需求分析報(bào)告》。交通局組織有關(guān)人員對(duì)需求進(jìn)行評(píng)審，以決定軟件需求是否完善和恰當(dāng)。評(píng)審?fù)瓿珊?，就可以進(jìn)入軟件的設(shè)計(jì)階段。需求報(bào)告格式《軟件需求分析報(bào)告》需按一定的格式進(jìn)行編寫(xiě)，具體的《軟件需求分析報(bào)告》文檔編寫(xiě)模板請(qǐng)見(jiàn)附錄A。軟件的概要設(shè)計(jì)概要設(shè)計(jì)在交通局和開(kāi)發(fā)者雙方認(rèn)可的《需求分析報(bào)告》基礎(chǔ)上，開(kāi)發(fā)者進(jìn)行下——步的工作。首先，開(kāi)發(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ǔ)。編寫(xiě)概要設(shè)計(jì)的要求a．一致性概要設(shè)計(jì)的要求應(yīng)該與需求分析報(bào)告所描述的需求一致。同時(shí)，概要設(shè)計(jì)的各項(xiàng)要求之間也應(yīng)該一致。b．合理性概要設(shè)計(jì)所提出的設(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)該是可行的。概要設(shè)計(jì)報(bào)告的編寫(xiě)者概要設(shè)計(jì)報(bào)告由開(kāi)發(fā)者根據(jù)需求分析報(bào)告的要求進(jìn)行編寫(xiě)。概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別需求分析不涉及具體的技術(shù)實(shí)現(xiàn)，而概要設(shè)計(jì)注重于從宏觀上和框架上來(lái)描述采用何種技術(shù)手段、方法來(lái)實(shí)現(xiàn)這些需求。詳細(xì)設(shè)計(jì)相對(duì)概要設(shè)計(jì)更注重于微觀上和框架內(nèi)的設(shè)計(jì)，是編碼的依據(jù)。概要設(shè)計(jì)是指導(dǎo)詳細(xì)設(shè)計(jì)的依據(jù)。概要設(shè)計(jì)的評(píng)審在軟件概要設(shè)計(jì)工作完成后，軟件開(kāi)發(fā)者應(yīng)向交通提交《軟件系統(tǒng)概要設(shè)計(jì)報(bào)告》。在交通局對(duì)《概要設(shè)計(jì)報(bào)告》評(píng)審?fù)ㄟ^(guò)后，即可進(jìn)入詳細(xì)設(shè)計(jì)階段。概要設(shè)計(jì)格式《軟件系統(tǒng)概要設(shè)計(jì)報(bào)告》需按一定的格式進(jìn)行編寫(xiě)，具體的《軟件系統(tǒng)概要設(shè)計(jì)報(bào)告》文檔編寫(xiě)模板請(qǐng)見(jiàn)附錄B。軟件的詳細(xì)設(shè)計(jì)詳細(xì)設(shè)計(jì)在概要設(shè)計(jì)的基礎(chǔ)上，開(kāi)發(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)系，需要說(shuō)明軟件系統(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)行編碼。特例如果軟件系統(tǒng)比較簡(jiǎn)單，層次較少，可以不必進(jìn)行專門(mén)的詳細(xì)設(shè)計(jì)，而和概要設(shè)計(jì)結(jié)合起來(lái)。詳細(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ù)?。c．可追蹤性對(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)該是可行的。數(shù)據(jù)庫(kù)設(shè)計(jì)如果軟件產(chǎn)品需要使用到數(shù)據(jù)庫(kù)，軟件的詳細(xì)設(shè)計(jì)應(yīng)包括對(duì)數(shù)據(jù)庫(kù)的設(shè)計(jì)。數(shù)據(jù)庫(kù)設(shè)計(jì)應(yīng)在軟件的需求分析、概要設(shè)計(jì)完成之后、詳細(xì)設(shè)計(jì)的其它工作之前進(jìn)行。在進(jìn)行數(shù)據(jù)庫(kù)設(shè)計(jì)時(shí)，應(yīng)當(dāng)按照交通局制定的《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》要求進(jìn)行。詳細(xì)設(shè)計(jì)的評(píng)審在軟件詳細(xì)設(shè)計(jì)完成后，軟件開(kāi)發(fā)者應(yīng)向交通局提交《軟件系統(tǒng)數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告》和《軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告》。在交通局對(duì)《軟件系統(tǒng)數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告》、《軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告》評(píng)審?fù)ㄟ^(guò)后，即可進(jìn)入軟件編碼階段。詳細(xì)設(shè)計(jì)格式《軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告》、《軟件系統(tǒng)數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告》需按一定的格式進(jìn)行編寫(xiě)，具體的《軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告》文檔編寫(xiě)模板和《軟件系統(tǒng)數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告》文檔編寫(xiě)模板請(qǐng)見(jiàn)附錄C、附錄D。軟件的編碼軟件編碼在軟件編碼階段，開(kāi)發(fā)者根據(jù)《軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告》中對(duì)數(shù)據(jù)結(jié)構(gòu)、算法分析和模塊實(shí)現(xiàn)等方面的設(shè)計(jì)要求，開(kāi)始具體的編寫(xiě)程序工作，分別實(shí)現(xiàn)各模塊的功能，從而實(shí)現(xiàn)對(duì)目標(biāo)系統(tǒng)的功能、性能、接口、界面等方面的要求。軟件編碼的要求a．模塊化編碼b．代碼可讀性c．可維護(hù)性d．模塊接口標(biāo)準(zhǔn)化e．界面風(fēng)格統(tǒng)一e．注釋的應(yīng)用編碼的評(píng)審為了盡早發(fā)現(xiàn)軟件中的障礙，提高軟件產(chǎn)品的質(zhì)量，開(kāi)發(fā)者在編碼的過(guò)程中應(yīng)該強(qiáng)調(diào)代碼評(píng)審工作。將代碼評(píng)審報(bào)告作為文檔的一部分，提交給交通局。編程規(guī)范及要求為了提高編程實(shí)現(xiàn)的質(zhì)量，軟件的程序設(shè)計(jì)必須遵照國(guó)家頒布的相關(guān)編程規(guī)范。主要內(nèi)容包括：規(guī)范化的程序內(nèi)部文檔、數(shù)據(jù)結(jié)構(gòu)的詳細(xì)說(shuō)明、清晰的語(yǔ)句結(jié)構(gòu)、編碼規(guī)范。編碼規(guī)范的內(nèi)容包括命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī)范、熱鍵定義等。其中數(shù)據(jù)庫(kù)部分應(yīng)遵守《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》的要求。在軟件編碼的同時(shí)應(yīng)進(jìn)行單元測(cè)試。軟件的測(cè)試軟件測(cè)試為了盡早發(fā)現(xiàn)軟件產(chǎn)品中的錯(cuò)誤，從而達(dá)到提高軟件質(zhì)量、降低軟件維護(hù)的費(fèi)用，開(kāi)發(fā)者應(yīng)在編碼過(guò)程中對(duì)各個(gè)模塊的程序代碼進(jìn)行單元測(cè)試，系統(tǒng)集成時(shí)進(jìn)行集成測(cè)試，系統(tǒng)集成完成后對(duì)整個(gè)軟件進(jìn)行系統(tǒng)測(cè)試。單元測(cè)試是在軟件開(kāi)發(fā)過(guò)程中針對(duì)程序模塊進(jìn)行正確性檢驗(yàn)。集成測(cè)試是在單元測(cè)試的基礎(chǔ)上，將所有模塊按照設(shè)計(jì)要求組裝成系統(tǒng)或子系統(tǒng)，對(duì)模塊組裝過(guò)程和模塊接口進(jìn)行正確性檢驗(yàn)。軟件系統(tǒng)測(cè)試不僅是檢測(cè)軟件的整體行為表現(xiàn)，從另一個(gè)側(cè)面看，也是對(duì)軟件開(kāi)發(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è)試等。開(kāi)發(fā)者針對(duì)單元測(cè)試，集成測(cè)試，系統(tǒng)測(cè)試分別制定《測(cè)試計(jì)劃》。集成測(cè)試需要根據(jù)需求分析報(bào)告和概要設(shè)計(jì)制作測(cè)試用例，并須經(jīng)過(guò)評(píng)審。軟件測(cè)試按照《測(cè)試計(jì)劃》、《需求分析報(bào)告》的要求進(jìn)行，最后形成《軟件測(cè)試報(bào)告》。測(cè)試計(jì)劃在軟件編碼開(kāi)始之前，開(kāi)發(fā)者應(yīng)向交通局提交《測(cè)試計(jì)劃》，在軟件交付時(shí)，開(kāi)發(fā)者應(yīng)向交通局提交《軟件測(cè)試報(bào)告》，以確保開(kāi)發(fā)者的軟件得到了充分的測(cè)試。開(kāi)發(fā)的軟件必須經(jīng)過(guò)充分的測(cè)試證明其符合設(shè)計(jì)要求、運(yùn)行穩(wěn)定、安全可用方可交付交通局。軟件的交付準(zhǔn)備交付清單在軟件測(cè)試證明軟件達(dá)到要求后，軟件開(kāi)發(fā)者應(yīng)向交通局提交開(kāi)發(fā)的目標(biāo)安裝程序、數(shù)據(jù)庫(kù)的數(shù)據(jù)字典、《用戶安裝手冊(cè)》、《用戶使用指南》、需求報(bào)告、設(shè)計(jì)報(bào)告、測(cè)試報(bào)告等雙方合同約定的產(chǎn)物?！队脩舭惭b手冊(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)舉例說(shuō)明。軟件的鑒定驗(yàn)收軟件的鑒定驗(yàn)收在軟件開(kāi)發(fā)完成后，為了確保軟件是按照需求分析的要求進(jìn)行開(kāi)發(fā)的，保證軟件產(chǎn)品的質(zhì)量，需要對(duì)軟件產(chǎn)品進(jìn)行鑒定驗(yàn)收。在開(kāi)發(fā)者如期交付軟件后，由交通局負(fù)責(zé)確定具體的鑒定驗(yàn)收日期。驗(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ì)劃、組織工作。驗(yàn)收具體內(nèi)容驗(yàn)收內(nèi)容應(yīng)該包括：合法性檢查、文檔檢查、軟件一致性檢查、軟件系統(tǒng)測(cè)試與測(cè)試結(jié)果評(píng)審等幾項(xiàng)工作。合法性檢查檢查軟件開(kāi)發(fā)工具是否合法、使用的函數(shù)庫(kù)、控件、組件是否有合法的發(fā)布許可。文檔檢查檢查開(kāi)發(fā)者提交的文檔必須齊全，質(zhì)量是否過(guò)關(guān)。需要開(kāi)發(fā)者提供的文檔包括：項(xiàng)目實(shí)施計(jì)劃；詳細(xì)技術(shù)方案；軟件需求規(guī)格說(shuō)明書(shū)(STP)(含數(shù)據(jù)字典)；概要設(shè)計(jì)說(shuō)明書(shū)(PDD)；詳細(xì)設(shè)計(jì)說(shuō)明書(shū)(DDD)(含數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū))；軟件測(cè)試計(jì)劃(STP)(含測(cè)試用例)；軟件測(cè)試報(bào)告(STR)；用戶手冊(cè)(SUM)(含操作、使用、維護(hù)、應(yīng)急處理手冊(cè))；源程序(SCL)(不可修改的電子文檔)；項(xiàng)目實(shí)施計(jì)劃(PIP)；項(xiàng)目開(kāi)發(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)明性、可追蹤性、自說(shuō)明性、規(guī)范件等方面進(jìn)行蹤合評(píng)定。驗(yàn)收需要對(duì)軟件代碼進(jìn)行檢查，以確保其符合規(guī)范，并檢查其一致性。軟件驗(yàn)收測(cè)試大綱在軟件進(jìn)行鑒定驗(yàn)收前，開(kāi)發(fā)者需按照一定的格式編寫(xiě)《軟件驗(yàn)收測(cè)試大綱》，具體的格式請(qǐng)見(jiàn)附錄E。培訓(xùn)系統(tǒng)應(yīng)用培訓(xùn)主要培訓(xùn)內(nèi)容包括：系統(tǒng)操作使用、業(yè)務(wù)管理流程。培訓(xùn)對(duì)象：應(yīng)用操作人員。系統(tǒng)管理的培訓(xùn)（可選）主要培訓(xùn)內(nèi)容包括：系統(tǒng)安裝、調(diào)試、維護(hù)；系統(tǒng)管理。培訓(xùn)對(duì)象：系統(tǒng)管理人員。開(kāi)發(fā)者應(yīng)詳細(xì)列出培訓(xùn)計(jì)劃，包括培訓(xùn)內(nèi)容、教材、時(shí)間和人員等。附錄A軟件需求分析報(bào)告文檔模板1.引言 111.1編寫(xiě)目的 111.2項(xiàng)目風(fēng)險(xiǎn) 111.3文檔約定 111.4預(yù)期讀者和閱讀建議 111.5產(chǎn)品范圍 121.6參考文獻(xiàn) 122.綜合描述 122.1產(chǎn)品的狀況 122.2產(chǎn)品的功能 132.3用戶類和特性 132.4運(yùn)行環(huán)境 132.5設(shè)計(jì)和實(shí)現(xiàn)上的限制 132.6假設(shè)和約束(依賴) 143.外部接口需求 143.1用戶界面 143.2硬件接口 153.3軟件接口 153.4通訊接口 164.系統(tǒng)功能需求 164.1說(shuō)明和優(yōu)先級(jí) 164.2激勵(lì)／響應(yīng)序列 174.3輸入／輸出數(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.待定問(wèn)題列表 20

引言引言是對(duì)這份軟件產(chǎn)品需求分析報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件產(chǎn)品需求分析報(bào)告是為哪個(gè)軟件產(chǎn)品編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件產(chǎn)品需求分析報(bào)告詳盡說(shuō)明了該軟件產(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)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。項(xiàng)目風(fēng)險(xiǎn)具體說(shuō)明本軟件開(kāi)發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括：任務(wù)提出者；軟件開(kāi)發(fā)者；產(chǎn)品使用者。文檔約定描述編寫(xiě)文檔時(shí)所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種排版約定。排版約定應(yīng)該包括：正文風(fēng)格；提示方式；重要符號(hào)；也應(yīng)該說(shuō)明高層次需求是否可以被其所有細(xì)化的需求所繼承，或者每個(gè)需求陳述是否都有其自己的優(yōu)先級(jí)。預(yù)期讀者和閱讀建議列舉本軟件產(chǎn)品需求分析報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能包括：用戶；開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；營(yíng)銷人員；測(cè)試人員；文檔編寫(xiě)入員。并且描述了文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。產(chǎn)品范圍說(shuō)明該軟件產(chǎn)品及其開(kāi)發(fā)目的的簡(jiǎn)短描述，包括利益和目標(biāo)。把軟件產(chǎn)品開(kāi)發(fā)與企業(yè)目標(biāo)，或者業(yè)務(wù)策略相聯(lián)系。描述產(chǎn)品范圍時(shí)需注意，可以參考項(xiàng)目視圖和范圍文檔，但是不能將其內(nèi)容復(fù)制到這里。參考文獻(xiàn)列舉編寫(xiě)軟件產(chǎn)品需求分析報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)淮；系統(tǒng)規(guī)格需求說(shuō)明；使用實(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ā)表日期或者簽約日期；出版單位或者資料來(lái)源。綜合描述這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運(yùn)行的環(huán)境、使用該軟件產(chǎn)品的用戶、對(duì)該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依賴。產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報(bào)告中所定義的軟件產(chǎn)品的背景和起源。說(shuō)明了該軟件產(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)系。那么必須說(shuō)明軟件產(chǎn)品需求分析報(bào)告定義的這部分軟件是怎樣與整個(gè)大系統(tǒng)相關(guān)聯(lián)的，或者（同時(shí)）說(shuō)明相互關(guān)系的存在形式，并且要定義出兩者之間的全部接口。產(chǎn)品的功能因?yàn)閷⒃谛枨蠓治鰣?bào)告的第4部分中詳細(xì)描述軟件產(chǎn)品的功能，所以在此只需要概略地總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能，在描述功能時(shí)應(yīng)該針對(duì)每一項(xiàng)需求準(zhǔn)確地描述其各項(xiàng)規(guī)格說(shuō)明。如果存在引起誤解的可能，在陳述本軟件產(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)品的主要功能。用戶類和特性確定有可能使用該軟件產(chǎn)品的不同用戶類，并且描述它們相關(guān)的特征。往往有一些軟件需求，只與特定的用戶類有關(guān)。描述時(shí)，應(yīng)該將該軟件產(chǎn)品的重要用戶類與非重要用戶類區(qū)分開(kāi)。用戶不一定是軟件產(chǎn)品的直接使用者，通過(guò)報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口得到軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機(jī)構(gòu)也有他們的需求。所以，應(yīng)該將這些外部需求視為通過(guò)報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附加用戶類。運(yùn)行環(huán)境描述了本軟件的運(yùn)行環(huán)境，一般包括：硬件平臺(tái)；操作系統(tǒng)和版本；支撐環(huán)境(例如：數(shù)據(jù)庫(kù)等)和版本；其它與該軟件有關(guān)的軟件組件；與該軟件共存的應(yīng)用程序。設(shè)計(jì)和實(shí)現(xiàn)上的限制確定影響開(kāi)發(fā)人員自由選擇的問(wèn)題，并且說(shuō)明這些問(wèn)題為什么成為一種限制?？赡艿南拗瓢ㄏ铝袃?nèi)容：必須使用的特定技術(shù)、工具、編程語(yǔ)言和數(shù)據(jù)庫(kù)；避免使用的特定技術(shù)、工具、編程語(yǔ)言和數(shù)據(jù)庫(kù)；要求遵循的開(kāi)發(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)淮的限制。假設(shè)和約束(依賴)列舉出對(duì)軟件產(chǎn)品需求分析報(bào)告中，影響需求陳述的假設(shè)因素(與己知因素相對(duì)立)。如果這些假設(shè)因素不正確、不一致或者被修改，就會(huì)使軟件產(chǎn)品開(kāi)發(fā)項(xiàng)目受到影響。這些假設(shè)的因素可能包括：計(jì)劃使用的商業(yè)組件，或者其它軟件中的某個(gè)部件；假定產(chǎn)品中某個(gè)用戶界面將符合一個(gè)特殊的設(shè)計(jì)約定；有關(guān)本軟件用戶的若干假定(例如：假定用戶會(huì)熟練使用SQL語(yǔ)言。)；有關(guān)本軟件開(kāi)發(fā)工作的若干假定(例如：用戶承諾的優(yōu)惠、方便、上級(jí)部門(mén)給予的特殊政策和支持等。)；有關(guān)本軟件運(yùn)行環(huán)境的一些問(wèn)題；此外，確定本軟件開(kāi)發(fā)項(xiàng)目對(duì)外部約束因素所存在的依賴。有關(guān)的約束可能包括：工期約束；經(jīng)費(fèi)約束；人員約束；設(shè)備約束；地理位置約束；其它有關(guān)項(xiàng)目約束；外部接口需求通過(guò)本節(jié)描述可以確定，保證軟件產(chǎn)品能和外部組件正確連接的需求。關(guān)聯(lián)圖僅能表示高層抽象的外部接口，必須對(duì)接口數(shù)據(jù)和外部組件進(jìn)行詳細(xì)描述，并且寫(xiě)入數(shù)據(jù)定義中。如果產(chǎn)品的不同部分有不同的外部接口，那么應(yīng)該把這些外部接口的全部詳細(xì)需求并入到這一部分實(shí)例中。注意：必須將附加用戶類的特征與外部接口需求加以區(qū)分，附加用戶類的特征描述的是通過(guò)接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求；而外部接口需求描述的是接口本身的需求。用戶界面陳述需要使用在用戶界面上的軟件組件，描述每一個(gè)用戶界面的邏輯特征。必須注意，這里需要描述的是用戶界面的邏輯特征，而不是用戶界面。以下是可能包括的一些特征：將要采用的圖形用戶界面(GUl)標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格；有關(guān)屏幕布局或者解決方案的限制；將要使用在每一個(gè)屏幕(圖形用戶界面)上的軟件組件，可能包括：選單；標(biāo)準(zhǔn)按鈕；導(dǎo)航鏈接；各種功能組件；消息欄；快捷鍵；各種顯示格式的規(guī)定，可能包括：不同情況下文字的對(duì)齊方式；不同情況下數(shù)字的表現(xiàn)格式與對(duì)齊方式日期的表現(xiàn)方法與格式；計(jì)時(shí)方法與時(shí)間格式；等等。錯(cuò)誤信息顯示標(biāo)準(zhǔn)；對(duì)于用戶界面的細(xì)節(jié)，例如：一個(gè)特定對(duì)話框的布局，應(yīng)該寫(xiě)入具體的用戶界面設(shè)計(jì)說(shuō)明中，而不能寫(xiě)入軟件需求規(guī)格說(shuō)明中。如果采用現(xiàn)成的、合適的用戶界面設(shè)計(jì)規(guī)范(標(biāo)準(zhǔn))，或者另文描述，可以在這里直接說(shuō)明，并且將其加入?yún)⒖嘉墨I(xiàn)。硬件接口描述待開(kāi)發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征，若有多個(gè)硬件接口，則必須全都描述。接口特征的描述內(nèi)容可能包括：支持的硬件類型；軟、硬件之間交流的數(shù)據(jù)；控制信息的性質(zhì)；使用的通訊協(xié)議；軟件接口描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號(hào)以資識(shí)別，可能的外部組件包括：操作系統(tǒng)；數(shù)據(jù)庫(kù)；工具；函數(shù)庫(kù)；集成的商業(yè)組件說(shuō)明：這里所說(shuō)的“集成的商業(yè)組件”，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn)品集成的商業(yè)組件。例如：中間件、消息服務(wù)，等等。描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需要的服務(wù)，以及與內(nèi)部組件通訊的性質(zhì)。確定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。如果必須使用一種特殊的方法來(lái)實(shí)現(xiàn)數(shù)據(jù)共享機(jī)制，例如：在多用戶系統(tǒng)中的一個(gè)全局?jǐn)?shù)據(jù)區(qū)，那么就必須把它定義為一種實(shí)現(xiàn)上的限制。通訊接口描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求，包括：電子郵件；WEB瀏覽器；網(wǎng)絡(luò)通訊標(biāo)準(zhǔn)或者協(xié)議；數(shù)據(jù)交互用電子表格；必須定義相關(guān)的：消息格式；通訊安全或加密問(wèn)題；數(shù)據(jù)傳輸速率；同步和異步通訊機(jī)制；系統(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)功能需求的描述必然存在某些問(wèn)題。功能需求是根據(jù)系統(tǒng)功能，即軟件產(chǎn)品所提供的主要服務(wù)來(lái)組織的。可以通過(guò)使用實(shí)例、運(yùn)行模式、用戶類、對(duì)象類或者功能等級(jí)來(lái)組織這部分內(nèi)容，也可以便用這些元素的組合?？偠灾?，必須選擇一種是讀者容易理解預(yù)期產(chǎn)品的組織方案。用簡(jiǎn)短的語(yǔ)句說(shuō)明功能的名稱，例如：“4.1系統(tǒng)參數(shù)管理”。按照服務(wù)組織的順序，逐條闡述系統(tǒng)功能。無(wú)論說(shuō)明的是何種功能，都應(yīng)該針對(duì)該系統(tǒng)功能重復(fù)敘述4.1~4.3這三個(gè)部分?？梢酝ㄟ^(guò)各種方式來(lái)組織這一部分內(nèi)容，例如采用：使用實(shí)例、運(yùn)行模式、用戶類、對(duì)象類、功能等級(jí)等，也可以采用它們的組合。其最終目的是，讓讀者容易理解即將開(kāi)發(fā)的軟件產(chǎn)品。一般來(lái)說(shuō)，每個(gè)使用實(shí)例都對(duì)應(yīng)一個(gè)系統(tǒng)功能，因而按照使用實(shí)例來(lái)組織內(nèi)容比較容易讓用戶理解。對(duì)應(yīng)一些被共享的獨(dú)立使用實(shí)例，可以定義一些公用系統(tǒng)功能。必須特別注意的是，在2.2節(jié)“產(chǎn)品的功能”中描述的全部需求，以及它們的規(guī)格說(shuō)明；必須在某個(gè)系統(tǒng)功能描述中有所反映，而且不應(yīng)重復(fù)。說(shuō)明和優(yōu)先級(jí)對(duì)該系統(tǒng)功能進(jìn)行簡(jiǎn)短的說(shuō)明，并且指出該系統(tǒng)功能的優(yōu)先級(jí)是：高、中、還是低。需要的話，還可以包括對(duì)特定優(yōu)先級(jí)部分的評(píng)價(jià)，例如：利益、損失、費(fèi)用和風(fēng)險(xiǎn)，其相對(duì)優(yōu)先等級(jí)可以從1(低)到9(高)。激勵(lì)／響應(yīng)序列列出輸入激勵(lì)(用戶動(dòng)作、來(lái)自外部設(shè)備的信號(hào)或者其它觸發(fā))并且定義針對(duì)這——功能行為的系統(tǒng)響應(yīng)序列，這些序列將與使用實(shí)例中相關(guān)的對(duì)話元素相對(duì)應(yīng)。描述激勵(lì)／響應(yīng)序列時(shí)，不僅需要描述基本過(guò)程，而且應(yīng)該描述可選(擴(kuò)充)過(guò)程，包括例外(引起任務(wù)不能順序完成的情況稱為例外)。疏忽了可選過(guò)程，有可能影響軟件產(chǎn)品的功能；如果遺漏例外過(guò)程，則有可能會(huì)引發(fā)系統(tǒng)崩潰。如果采用流程圖來(lái)描述激勵(lì)／響應(yīng)序列，比較容易讓用戶理解。輸入／輸出數(shù)據(jù)列出輸入數(shù)據(jù)(用戶輸入、來(lái)自外部接口的輸入或者其它輸入)并且定義針對(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ù)雜的處理方法，僅僅給出算法原理是不夠的，必須描述詳細(xì)的計(jì)算過(guò)程，并且列出每一步具體使用的實(shí)際算式；如果計(jì)算過(guò)程中涉及查表、判斷、迭代等處理方法，應(yīng)該給出處理依據(jù)和相關(guān)數(shù)據(jù)。如果計(jì)算方法很簡(jiǎn)單，也可以將其從略，不加描述。其它非功能需求在這里列舉出所有非功能需求，主要包括可靠性、安全性、可維護(hù)性、可擴(kuò)展性、可測(cè)試性等。性能需求闡述不同應(yīng)用領(lǐng)域?qū)浖a(chǎn)品性能的需求，并且說(shuō)明提出需求的原理或者依據(jù)，以幫助開(kāi)發(fā)人員做出合理的設(shè)計(jì)選擇。盡可能詳細(xì)地描述性能需求，如果需要，可以針對(duì)每個(gè)功能需求或者特征分別陳述其性能需求。在這里確定：相互合作的用戶數(shù)量；系統(tǒng)支持的并發(fā)操作數(shù)量；響應(yīng)時(shí)間；與實(shí)時(shí)系統(tǒng)的時(shí)間關(guān)系：容量需求存儲(chǔ)器；磁盤(pán)空間；數(shù)據(jù)庫(kù)中表的最大行數(shù)。安全措施需求詳盡陳述與軟件產(chǎn)品使用過(guò)程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。定義必須采取的安全保護(hù)或動(dòng)作，以及必須預(yù)防的潛在危險(xiǎn)動(dòng)作。明確軟件產(chǎn)品必須遵從的安全標(biāo)準(zhǔn)、策略、或規(guī)則。安全性需求詳盡陳述與系統(tǒng)安全性、完整性問(wèn)題相關(guān)的需求，或者與個(gè)人隱私問(wèn)題相關(guān)的需求。這些問(wèn)題將會(huì)影響到軟件產(chǎn)品的使用，和軟件產(chǎn)品所創(chuàng)建或者使用的數(shù)據(jù)的保護(hù)。定義用戶身份認(rèn)證，或備授權(quán)需求。明確軟件產(chǎn)品必須滿足的安全性或者保密性策略。也可以通過(guò)稱為完整性的質(zhì)量屬性來(lái)闡述這些需求。一個(gè)典型的軟件系統(tǒng)安全需求范例如下：“每個(gè)用戶在第一次登錄后，必須更改他的系統(tǒng)預(yù)置登錄密碼，系統(tǒng)預(yù)置的登錄密碼不能重用?！避浖|(zhì)量屬性詳盡陳述對(duì)客戶和開(kāi)發(fā)人員至關(guān)重要的在軟件產(chǎn)品其它方面表現(xiàn)出來(lái)的質(zhì)量功能。這些功能必須是確定的、定量的、在需要時(shí)是可以驗(yàn)證的。至少也應(yīng)該指明不同屬性的相對(duì)側(cè)重點(diǎn)，例如：易用性優(yōu)于易學(xué)性，或者可移植性優(yōu)于有效性。業(yè)務(wù)規(guī)則列舉出有關(guān)軟件產(chǎn)品的所有操作規(guī)則，例如：那些人在特定環(huán)境下可以進(jìn)行何種操作。這些本身不是功能需求，但是他們可以暗示某些功能需求執(zhí)行這些規(guī)則。一個(gè)業(yè)務(wù)規(guī)則的范例如下：“進(jìn)行達(dá)到或者超過(guò)10，000，00元人民幣的儲(chǔ)蓄業(yè)務(wù)時(shí)，必須通過(guò)附加的管理員認(rèn)證?！绷信e業(yè)務(wù)規(guī)則時(shí)，可以根據(jù)規(guī)則的數(shù)量，選取合適的編目方式。用戶文檔列舉出將與軟件產(chǎn)品一同交付的用戶文檔，并且明確所有己知用戶文檔的交付格式或標(biāo)準(zhǔn)，例如：安裝指南紙質(zhì)文檔，16開(kāi)本；用戶手冊(cè)紙質(zhì)文檔，16開(kāi)本；在線幫助電子文檔，與軟件產(chǎn)品一同分發(fā)、配置；使用教程電子文檔，與軟件產(chǎn)品一同分發(fā)、配置。詞匯表列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件產(chǎn)品需求分析報(bào)告，要求使用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)描述軟件需求。所以這里所指的專業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專業(yè)術(shù)語(yǔ)，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表并且加以準(zhǔn)確定義。數(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ī)格說(shuō)明，并且在軟件產(chǎn)品開(kāi)發(fā)和維護(hù)的任何階段，均向風(fēng)險(xiǎn)承擔(dān)者開(kāi)放。如果為軟件開(kāi)發(fā)項(xiàng)目創(chuàng)建一個(gè)獨(dú)立的數(shù)據(jù)定義，而不是為每一項(xiàng)特性描述有關(guān)的數(shù)據(jù)項(xiàng)，有利于避免冗余和不一致性。但是卻不利于多人協(xié)同編寫(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ù)，使得它們的名稱和含義完全一致。必須注意的是，為了避免二義性，在匯總數(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)樵谲浖_(kāi)發(fā)時(shí)將沿用該英文名稱。可以使用等號(hào)表示數(shù)據(jù)項(xiàng)，名稱寫(xiě)在左邊，定義寫(xiě)在右邊。常見(jiàn)數(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)括起來(lái)寫(xiě)在原數(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ù)定義中定義過(guò)的，結(jié)構(gòu)中也可以包括其它結(jié)構(gòu)，但是絕對(duì)不允許遞歸。如果數(shù)據(jù)結(jié)構(gòu)中有可選項(xiàng)，使用圓括號(hào)把該項(xiàng)括起來(lái)。重復(fù)項(xiàng)重復(fù)項(xiàng)是組合項(xiàng)的一種特例，其中有一項(xiàng)將有多個(gè)實(shí)例出現(xiàn)在數(shù)據(jù)結(jié)構(gòu)中，使用花括號(hào)把該項(xiàng)括起來(lái)。如果知道該項(xiàng)可能允許的范圍，就按“最小值：最大值”的形式寫(xiě)在花括號(hào)前。分析模型這是一個(gè)可選部分，包括或涉及到相關(guān)的分析模型，例如：數(shù)據(jù)流程圖；類圖；狀態(tài)轉(zhuǎn)換圖；實(shí)體-關(guān)系圖。待定問(wèn)題列表編輯一張?jiān)谲浖a(chǎn)品需求分析報(bào)告中待確定問(wèn)題時(shí)的列表，把每一個(gè)表項(xiàng)都編上號(hào)，以便跟蹤調(diào)查。附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板1.引言 231.1編寫(xiě)目的 231.2項(xiàng)目風(fēng)險(xiǎn) 231.3預(yù)期讀者和閱讀建議 231.4參考資料 232.設(shè)計(jì)概述 242.1限制和約束 242.2設(shè)計(jì)原則和設(shè)計(jì)要求 243.系統(tǒng)邏輯設(shè)計(jì) 253.1系統(tǒng)組織設(shè)計(jì) 253.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 253.2.1系統(tǒng)特性表 263.2.2系統(tǒng)特性結(jié)構(gòu)圖 273.3系統(tǒng)接口設(shè)計(jì) 273.3.1系統(tǒng)接口表 273.3.2系統(tǒng)接口傳輸協(xié)議說(shuō)明 283.4系統(tǒng)完整性設(shè)計(jì) 284.系統(tǒng)出錯(cuò)處理設(shè)計(jì) 294.1系統(tǒng)出錯(cuò)處理表 294.2維護(hù)處理過(guò)程表 305.技術(shù)設(shè)計(jì) 315.1系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表 315.2開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明 326.數(shù)據(jù)庫(kù)設(shè)計(jì) 327.詞匯表 328.進(jìn)度計(jì)劃 32

引言引言是對(duì)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求規(guī)格說(shuō)明書(shū)編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告詳盡說(shuō)明了該軟件產(chǎn)品的軟件結(jié)構(gòu)，包括數(shù)據(jù)庫(kù)結(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)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。項(xiàng)目風(fēng)險(xiǎn)具體說(shuō)明本軟件開(kāi)發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括：任務(wù)提出者；軟件開(kāi)發(fā)者；產(chǎn)品使用者。預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能的讀者包括：用戶；開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；營(yíng)銷人員；測(cè)試人員；文檔編寫(xiě)人員；等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)軟件產(chǎn)品概要設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)準(zhǔn)；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文檔；屬于本項(xiàng)目的其它已發(fā)表文件；本軟件系統(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ā)表日期或者簽約日期；出版單位或者資料來(lái)源。設(shè)計(jì)概述本節(jié)描述現(xiàn)有開(kāi)發(fā)條件和需要實(shí)現(xiàn)的目標(biāo)，說(shuō)明進(jìn)行概要設(shè)計(jì)時(shí)應(yīng)該遵循的設(shè)計(jì)原則和必須采用的設(shè)計(jì)方法。限制和約束簡(jiǎn)要描述起到限制和約束作用的各種可能存在的條件，例如：技術(shù)條件；資金狀況；開(kāi)發(fā)環(huán)境(包括：工具和平臺(tái))；時(shí)間限制；等等。并且說(shuō)明在上述條件下，應(yīng)該實(shí)現(xiàn)的系統(tǒng)目標(biāo)，設(shè)計(jì)原則和設(shè)計(jì)要求描述對(duì)本軟件系統(tǒng)進(jìn)行概要設(shè)計(jì)的原則，通?？梢钥紤]以下幾方面的內(nèi)容：命名規(guī)則；模塊獨(dú)立性原則：邊界設(shè)計(jì)原則；數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)則；必須的安全措施；安全性和保密原則；系統(tǒng)靈活性要求；系統(tǒng)易操作性要求；系統(tǒng)可維護(hù)性要求；等等。系統(tǒng)邏輯設(shè)計(jì)本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說(shuō)明書(shū)和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng)的邏輯模型。此種模型暫時(shí)與系統(tǒng)的物理因素(例如：計(jì)算機(jī)、數(shù)據(jù)庫(kù)管理系統(tǒng))無(wú)關(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)開(kāi)發(fā)技術(shù)說(shuō)明。說(shuō)明：如果進(jìn)行系統(tǒng)設(shè)計(jì)時(shí)尚未編寫(xiě)軟件數(shù)據(jù)字典：應(yīng)首先參照附錄B說(shuō)明，編寫(xiě)軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后，再進(jìn)行系統(tǒng)設(shè)計(jì)。系統(tǒng)組織設(shè)計(jì)系統(tǒng)組織設(shè)計(jì)通過(guò)系統(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)容只有一行。說(shuō)明：在一個(gè)系統(tǒng)中有可能安裝若干個(gè)相同的子系統(tǒng)，在這種情況下，應(yīng)該視為一個(gè)子系統(tǒng)，并且對(duì)多個(gè)安裝地點(diǎn)分別進(jìn)行描述。如果相同的子系統(tǒng)通過(guò)系統(tǒng)設(shè)置，實(shí)現(xiàn)的業(yè)務(wù)職能具有明顯差異時(shí)，應(yīng)該采用多行進(jìn)行分別描述，并且在備注中說(shuō)明其差異所在。子系統(tǒng)英文名稱給出本子系統(tǒng)的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的可執(zhí)行文件名稱，必須能夠說(shuō)明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng)，則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。子系統(tǒng)中文名稱給出本子系統(tǒng)的中文名稱，該名稱必須能夠說(shuō)明該子系統(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í)際安裝的部門(mén)、或者某個(gè)具體地點(diǎn)。備注針對(duì)該子系統(tǒng)，需要說(shuō)明的其它有關(guān)問(wèn)題。系統(tǒng)結(jié)構(gòu)設(shè)計(jì)本節(jié)將對(duì)系統(tǒng)特性作較為詳細(xì)的描述，并給出系統(tǒng)特性結(jié)構(gòu)圖。系統(tǒng)特性表系統(tǒng)特性是系統(tǒng)中完成某項(xiàng)具體操作的基本單元，它由入口參數(shù)，出口參數(shù)以及處理過(guò)程三部分組成。系統(tǒng)特性可以具有操作界面，也可以沒(méi)有操作界面；可以被其它操作界面、或者系統(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ì)象備注說(shuō)明：其中子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。特性編號(hào)整個(gè)系統(tǒng)所有特性的統(tǒng)一編號(hào)。系統(tǒng)特性英文名稱系統(tǒng)特性的英文正式名稱，將來(lái)用于軟件開(kāi)發(fā)中，必須符合命名規(guī)范。系統(tǒng)特性中文名稱系統(tǒng)特性的中文正式名稱，來(lái)源于需求規(guī)格說(shuō)明書(shū)中，系統(tǒng)特性一節(jié)中的有關(guān)描述。操作功能是指該特性實(shí)際完成的操作說(shuō)明。調(diào)用對(duì)象是指調(diào)用該系統(tǒng)特性的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象可以是系統(tǒng)特性、也可以是操作界面。被調(diào)用對(duì)象是指被該系統(tǒng)特性調(diào)用的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象可以是系統(tǒng)特性、也可以是操作界面。說(shuō)明：某些較低層的系統(tǒng)特性，可能不存在被調(diào)用對(duì)象。備注描述與該系統(tǒng)特性有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)特性表有關(guān)的其它注意事項(xiàng)。系統(tǒng)特性結(jié)構(gòu)圖系統(tǒng)特性結(jié)構(gòu)圖給出系統(tǒng)特性在邏輯層面上相互之間的關(guān)系，其主要依據(jù)來(lái)源于需求規(guī)格說(shuō)明書(shū)中，系統(tǒng)特性一節(jié)中的有關(guān)描述。如果系統(tǒng)劃分為多個(gè)子系統(tǒng)，應(yīng)分別給出系統(tǒng)與子系統(tǒng)、以及各個(gè)子系統(tǒng)與系統(tǒng)特性的結(jié)構(gòu)圖。繪制系統(tǒng)與子系統(tǒng)結(jié)構(gòu)圖時(shí)，一般不需要描繪出系統(tǒng)特性，如果確有必要，盡可能只畫(huà)出第一層系統(tǒng)特性。繪制子系統(tǒng)與系統(tǒng)特性結(jié)構(gòu)圖時(shí)，通常也不需要描繪出第二層系統(tǒng)特性，如果確有必要可以畫(huà)出，但是盡可能不要畫(huà)出第三層系統(tǒng)特性。系統(tǒng)接口設(shè)計(jì)系統(tǒng)接口是一種非可視的系統(tǒng)界面，在多數(shù)情況下，它對(duì)用戶是透明的。本節(jié)將對(duì)系統(tǒng)接口作較為詳細(xì)的描述，并給出接口說(shuō)明清單。系統(tǒng)接口表接口作為系統(tǒng)的一種輸入／輸出形式，分為網(wǎng)絡(luò)接口、數(shù)據(jù)庫(kù)接口、RS-232串行通訊接口、IEEE—485串行總線接口、并行I/O接口等等多種類型。對(duì)于一些為可視界面服務(wù)的接口，例如：打印機(jī)接口、顯示器接口等，因?yàn)檫@類接口對(duì)應(yīng)用軟件是透明的，所以不在本節(jié)描述范圍內(nèi)。當(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)接口名稱接口類型接口性質(zhì)接口速率接口協(xié)議備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。接口編號(hào)整個(gè)系統(tǒng)所有接口的統(tǒng)一編號(hào)。接口名稱系統(tǒng)接口的正式名稱，必須符合通常習(xí)慣。接口類型指出該接口所傳輸?shù)臄?shù)據(jù)在該模塊中起到的作用。接口性質(zhì)指出該接口在通訊中起到的作用，這里的作用可以是：輸入；輸出；雙向。接口速率指出該接口的傳輸速率。如果該接口依賴于其它通訊方式，那么傳輸速率將不高于它所依賴的其它通訊方式的速率。接口協(xié)議給出該接口實(shí)際使用的通訊協(xié)議。相關(guān)對(duì)象給出直接使用本接口的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象，可以是操作界面，也可以是系統(tǒng)特性。備注描述與該系統(tǒng)接口有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)接口表有關(guān)的其它注意事項(xiàng)。系統(tǒng)接口傳輸協(xié)議說(shuō)明逐項(xiàng)詳細(xì)描述系統(tǒng)接口表中所列出各個(gè)系統(tǒng)接口使用的傳輸協(xié)議，以及其它相關(guān)內(nèi)容，例如：驅(qū)動(dòng)程序、動(dòng)態(tài)連接庫(kù)、等等。系統(tǒng)完整性設(shè)計(jì)描述系統(tǒng)對(duì)象(數(shù)據(jù)元、數(shù)據(jù)類)，所受到的邏輯約束關(guān)系。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)應(yīng)分別使用一張系統(tǒng)完整性約束表進(jìn)行描述。系統(tǒng)完整性約束表的格式如下：子系統(tǒng)編號(hào)子系統(tǒng)英文名稱子系統(tǒng)中文名稱約束編號(hào)完整性名稱相對(duì)對(duì)象名約束表達(dá)式備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。約束編號(hào)整個(gè)系統(tǒng)所有約束的統(tǒng)一編號(hào)。完整性名稱系統(tǒng)完整性約束的正式名稱，必須符合通常習(xí)慣。相對(duì)對(duì)象名完整性約束中的相關(guān)對(duì)象(數(shù)據(jù)元和數(shù)據(jù)類)。約束表達(dá)式用一階邏輯表達(dá)式表達(dá)的約束方程式。備注描述與該系統(tǒng)完整性約束有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)完整性約束表有關(guān)的其它注意事項(xiàng)。系統(tǒng)出錯(cuò)處理設(shè)計(jì)本節(jié)描述系統(tǒng)發(fā)生外界及內(nèi)在錯(cuò)誤時(shí)，所提供的錯(cuò)誤信息及處理方法，它包括系統(tǒng)出錯(cuò)處理表及維護(hù)處理過(guò)程表。系統(tǒng)出錯(cuò)處理表本表給出有關(guān)出錯(cuò)處理的產(chǎn)生原因、提示信息、以及建議處理方法。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)出錯(cuò)處理表進(jìn)行描述。系統(tǒng)出錯(cuò)處理表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號(hào)錯(cuò)誤名稱錯(cuò)誤原因錯(cuò)誤信息處理方式備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。錯(cuò)誤編號(hào)整個(gè)系統(tǒng)所有錯(cuò)誤的統(tǒng)一編號(hào)。錯(cuò)誤名稱錯(cuò)誤的正式名稱，該名稱應(yīng)該是常用的，并且為人們所普遍接受的。錯(cuò)誤原因?qū)υ撳e(cuò)誤產(chǎn)生原因的解釋與說(shuō)明。錯(cuò)誤信息產(chǎn)生該錯(cuò)誤時(shí)，向用戶發(fā)出的提示信息。處理方式對(duì)該錯(cuò)誤處理的一種建議，此項(xiàng)允許缺省。備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。維護(hù)處理過(guò)程表系統(tǒng)出錯(cuò)時(shí)，將調(diào)用維護(hù)處理過(guò)程對(duì)錯(cuò)誤進(jìn)行處理，有關(guān)維護(hù)處理過(guò)程的各項(xiàng)內(nèi)容由維護(hù)處理過(guò)程表進(jìn)行描述。當(dāng)系統(tǒng)有多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張維護(hù)處理過(guò)程表進(jìn)行描述。維護(hù)處理過(guò)程表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號(hào)處理過(guò)程處理過(guò)程處理功能入口參數(shù)出口參數(shù)備注英文名稱中文名稱說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。錯(cuò)誤編號(hào)含義同上。處理過(guò)程英文名稱系統(tǒng)維護(hù)處理過(guò)程的英文正式名稱，將來(lái)用于軟件開(kāi)發(fā)中，必須符合命名規(guī)范。處理過(guò)程中文名稱系統(tǒng)維護(hù)處理過(guò)程的中文正式名稱，是系統(tǒng)維護(hù)處理過(guò)程英文名稱的中文說(shuō)明。處理功能描述本維護(hù)處理過(guò)程對(duì)錯(cuò)誤的處理方式。由于一個(gè)維護(hù)處理過(guò)程有可能具有對(duì)多個(gè)錯(cuò)誤進(jìn)行處理的能力，因此該處理功能必須是針對(duì)本項(xiàng)錯(cuò)誤編號(hào)的。入口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，賦給維護(hù)處理過(guò)程的入口參數(shù)。出口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，維護(hù)處理過(guò)程返回的出口參數(shù)。備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。技術(shù)設(shè)計(jì)系統(tǒng)技術(shù)設(shè)計(jì)描述系統(tǒng)各個(gè)特性實(shí)際使用的開(kāi)發(fā)技術(shù)，以及具體開(kāi)發(fā)技術(shù)使用時(shí)應(yīng)該注意的事項(xiàng)。系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表本表描述系統(tǒng)各個(gè)特性開(kāi)發(fā)時(shí)實(shí)際使用的具體技術(shù)，只有一些不太常用的技術(shù)需要在這里描述。一些常用技術(shù)，例如：通過(guò)數(shù)據(jù)庫(kù)接口調(diào)用存儲(chǔ)過(guò)程，則不必冗述。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表進(jìn)行描述。系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：技術(shù)編號(hào)開(kāi)發(fā)技術(shù)開(kāi)發(fā)技術(shù)處理功能系統(tǒng)特性編號(hào)備注英文名稱中文名稱說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。技術(shù)編號(hào)這個(gè)系統(tǒng)所使用各種技術(shù)的統(tǒng)一編號(hào)。開(kāi)發(fā)技術(shù)英文名稱該開(kāi)發(fā)技術(shù)的英文正式名稱，可以便用縮寫(xiě)。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。開(kāi)發(fā)技術(shù)中文名稱該開(kāi)發(fā)技術(shù)的中文正式名稱，是該開(kāi)發(fā)技術(shù)英文名稱的中文說(shuō)明。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。處理功能描述本開(kāi)發(fā)技術(shù)的處理目的。系統(tǒng)特性編號(hào)含義同上。由于一項(xiàng)開(kāi)發(fā)技術(shù)可能在多處使用，因此針對(duì)一項(xiàng)開(kāi)發(fā)技術(shù)，有可能存在多個(gè)系統(tǒng)特性編號(hào)，在此必須一一列出。備注描述與該系統(tǒng)開(kāi)發(fā)技術(shù)相關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表有關(guān)的其它注意事項(xiàng)。開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明逐項(xiàng)詳細(xì)描述系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表中所列出各項(xiàng)系統(tǒng)開(kāi)發(fā)技術(shù)使用的技術(shù)要點(diǎn)，以及其它相關(guān)內(nèi)容，例如：所需的服務(wù)、使用的動(dòng)態(tài)連接庫(kù)、調(diào)用的組件、等等。數(shù)據(jù)庫(kù)設(shè)計(jì)如果該軟件產(chǎn)品需要使用數(shù)據(jù)庫(kù)，不論是使用數(shù)據(jù)庫(kù)平臺(tái)支撐的，還是采用由軟件產(chǎn)品開(kāi)發(fā)者自行定義的；都應(yīng)該在完成軟件產(chǎn)品需求分析報(bào)告后，開(kāi)始進(jìn)行軟件產(chǎn)品詳細(xì)設(shè)計(jì)之前，按照軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明文檔模板完成數(shù)據(jù)庫(kù)設(shè)計(jì)工作。詞匯表列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原向)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件系統(tǒng)概要設(shè)計(jì)報(bào)告，要求使用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)進(jìn)行描述。所以這里所指的專業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專業(yè)術(shù)語(yǔ)，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。進(jìn)度計(jì)劃列出進(jìn)度計(jì)劃，包括各子系統(tǒng)、各子模塊完成進(jìn)度計(jì)劃，人員配備計(jì)劃等。附錄C軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板1.引言 351.1編寫(xiě)目的 351.2項(xiàng)目風(fēng)險(xiǎn) 351.3文檔約定 351.4預(yù)期讀者和閱讀建議 351.5參考資料 362.支撐環(huán)境 362.1數(shù)據(jù)庫(kù)管理系統(tǒng) 362.2開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 372.3硬件環(huán)境 372.4網(wǎng)絡(luò)環(huán)境 382.5多種支撐環(huán)境開(kāi)發(fā)要點(diǎn) 383.部件詳細(xì)設(shè)計(jì) 384.詞匯表 395.部件表格式 406.界面表格式 40

引言引言是對(duì)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求分析報(bào)告、哪份軟件產(chǎn)品概要設(shè)計(jì)報(bào)告和哪份軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)(如果該軟件產(chǎn)品需要數(shù)據(jù)庫(kù)支持)編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告詳盡說(shuō)明了該軟件產(chǎn)品的編碼結(jié)構(gòu)，從而對(duì)該軟件產(chǎn)品的物理組成進(jìn)行準(zhǔn)確的描述。如果這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。項(xiàng)目風(fēng)險(xiǎn)具體說(shuō)明本軟件開(kāi)發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括：任務(wù)提出者；軟件開(kāi)發(fā)者；產(chǎn)品使用者。文檔約定描述編寫(xiě)文檔時(shí)所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種編寫(xiě)約定。編寫(xiě)約定應(yīng)該包括：部件編號(hào)方式；界面編號(hào)方式；命名規(guī)范：等等。預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能的讀者包括：開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；測(cè)試人員；文檔編寫(xiě)人員；等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)難；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文檔；屬于本項(xiàng)目的其它己發(fā)表文件；本軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中所引用的文件、資料；相關(guān)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告；等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都應(yīng)該給出：標(biāo)題名稱；作者或者合同簽約者；文件編號(hào)或者版本號(hào)；發(fā)表日期或者簽約日期；出版單位或者資料來(lái)源。支撐環(huán)境數(shù)據(jù)庫(kù)管理系統(tǒng)描述數(shù)據(jù)庫(kù)管理系統(tǒng)、以及安裝配置情況，需要描述的內(nèi)容可能包括：產(chǎn)品名稱以及發(fā)行廠商這里的產(chǎn)品名稱指的是數(shù)據(jù)庫(kù)發(fā)行廠商發(fā)布產(chǎn)品時(shí)公布的正式商品名稱，不應(yīng)該使用別名、簡(jiǎn)稱、研發(fā)代號(hào)等非正式名稱，以免混淆；同樣的道理，發(fā)行廠商的名稱也應(yīng)該使用正式名稱。版本號(hào)數(shù)據(jù)庫(kù)管理系統(tǒng)的準(zhǔn)確版本號(hào)，必須按產(chǎn)品的實(shí)際情況描述到最細(xì)節(jié)的版本號(hào)。補(bǔ)丁包版本號(hào)描述實(shí)際上將要使用的數(shù)據(jù)庫(kù)管理系統(tǒng)補(bǔ)丁包的版本號(hào)，必須注意，在某些情況下該版本號(hào)不一定是最新的版本號(hào)。語(yǔ)言或代碼集對(duì)于只支持一種語(yǔ)言或者一個(gè)代碼集的數(shù)據(jù)庫(kù)管理系統(tǒng)來(lái)說(shuō)，該項(xiàng)描述不具意義。對(duì)于支持多種語(yǔ)言或者多個(gè)代碼集的數(shù)據(jù)庫(kù)管理系統(tǒng)來(lái)說(shuō)，該項(xiàng)描述指的是實(shí)際使用的語(yǔ)言或者代碼集。安裝位置描述數(shù)據(jù)庫(kù)管理系統(tǒng)的實(shí)際安裝位置，應(yīng)該分別對(duì)管理系統(tǒng)安缺位置和數(shù)據(jù)存放位置進(jìn)行描述，應(yīng)該指明服務(wù)器名和安裝卷號(hào)(盤(pán)號(hào))。對(duì)于分布式數(shù)據(jù)庫(kù)，必須分別描述每一個(gè)數(shù)據(jù)庫(kù)管理系統(tǒng)。配置參數(shù)描述數(shù)據(jù)庫(kù)管理系統(tǒng)在實(shí)際安裝時(shí)應(yīng)該配置的各個(gè)參數(shù)，對(duì)于分布式數(shù)據(jù)庫(kù)，必須分別描述每一個(gè)數(shù)據(jù)庫(kù)管理系統(tǒng)的配置參數(shù)。等等同時(shí)參照《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》。開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口描述所選用的工具軟件和中間件的名稱、版本號(hào)，以及開(kāi)發(fā)工具與數(shù)據(jù)庫(kù)或者中間件接口的情況。如果使用了多種開(kāi)發(fā)工具、輔助開(kāi)發(fā)工具、第三方軟件部件、多種中間件、多種接口、等答應(yīng)該逐項(xiàng)分別描述，并且說(shuō)明每一項(xiàng)的適用范圍。需要描述的內(nèi)容可能包括：產(chǎn)品名稱以及發(fā)行廠商同2.1中產(chǎn)品名稱以及發(fā)行廠商。版本號(hào)同2.1中版本號(hào)。補(bǔ)丁包版本號(hào)同2.1中補(bǔ)丁包版本號(hào)。語(yǔ)言或代碼集同2.1中語(yǔ)言或代碼集。數(shù)據(jù)庫(kù)接口名稱描述數(shù)據(jù)庫(kù)接口的名稱，如果使用別名時(shí)，應(yīng)同時(shí)描述使用的別名。數(shù)據(jù)庫(kù)接口方式描述與數(shù)據(jù)庫(kù)接口的方式，并說(shuō)明該接口方式的特點(diǎn)；如果需要，還應(yīng)該說(shuō)明使用時(shí)的注意事項(xiàng)。數(shù)據(jù)庫(kù)接口設(shè)置描述各種接口設(shè)置，包括：協(xié)議、端口號(hào)等等。同時(shí)參照《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》。硬件環(huán)境描述所選用的硬件環(huán)境，各種機(jī)型，例如：服務(wù)器、工作站，應(yīng)該分別描述。需要描述的內(nèi)容可能包括：機(jī)型；主頻；內(nèi)存容量；磁盤(pán)容量；特殊部件；操作系統(tǒng)；使用位置；等等。網(wǎng)絡(luò)環(huán)境描述可能影響應(yīng)用軟件訪問(wèn)數(shù)據(jù)庫(kù)的各種網(wǎng)絡(luò)環(huán)境，如果存在加密傳輸、VPN鏈路等情況，也必須描述。對(duì)于結(jié)構(gòu)復(fù)雜的網(wǎng)絡(luò)，還應(yīng)該提供網(wǎng)絡(luò)拓?fù)鋱D和數(shù)據(jù)流向示意圖。需要描述的內(nèi)容可能包括：網(wǎng)絡(luò)結(jié)構(gòu)；網(wǎng)絡(luò)操作系統(tǒng)；網(wǎng)絡(luò)帶寬；路由組織；加密傳輸方式；VPN鏈路連接方式；等等。多種支撐環(huán)境開(kāi)發(fā)要點(diǎn)當(dāng)軟件產(chǎn)品將來(lái)可能遇到的多種運(yùn)行環(huán)境時(shí)，應(yīng)該分別按照3.1節(jié)至3.4節(jié)的內(nèi)容列表描述。如果軟件產(chǎn)品各個(gè)子系統(tǒng)的運(yùn)行環(huán)境不完全一樣時(shí)，應(yīng)該分子系統(tǒng)按照3.1節(jié)至3.4節(jié)的內(nèi)容列表描述。遇到上述情況時(shí)，不僅需要詳細(xì)描述各種軟件開(kāi)發(fā)、調(diào)試、測(cè)試的環(huán)境，為了確實(shí)保證軟件產(chǎn)品將來(lái)能夠在各種可能的運(yùn)行環(huán)境中正常運(yùn)行，還需要對(duì)軟件產(chǎn)品進(jìn)行嚴(yán)格的配置管理。部件詳細(xì)設(shè)計(jì)這里所提及的軟件部件，系指能夠完成特定功能、相對(duì)獨(dú)立的一些代碼集合，它們可以是插件、組件、控件、函數(shù)、過(guò)程、子程序、動(dòng)態(tài)連接庫(kù)、等等。具體呈何種形態(tài)，取決于實(shí)際采用的開(kāi)發(fā)工具和將要實(shí)現(xiàn)的軟件結(jié)構(gòu)。按照合適的順序，逐個(gè)描述軟件部件的詳細(xì)情況。描述的順序可以是按層次橫向進(jìn)行描述，也可以是按模塊縱向進(jìn)行描述，總之描述的方式必須有利于讀者理解軟件結(jié)構(gòu)。每個(gè)部件采用一張軟件部件表進(jìn)行描述，軟件部件表的格式見(jiàn)附表一，其中；部件編號(hào)軟件部件的統(tǒng)一順序編號(hào)；對(duì)于實(shí)行配置管理的軟件開(kāi)發(fā)項(xiàng)目來(lái)說(shuō)，該編號(hào)必須與該部件在配置管理中的編號(hào)相同。部件名稱軟件部件的正式英文名稱，該名稱是程序中使用的實(shí)際名稱，必須符合國(guó)家相關(guān)軟件命名標(biāo)準(zhǔn)。所屬子系統(tǒng)指該部件所屬的子系統(tǒng)；對(duì)于不分為多個(gè)子系統(tǒng)的軟件來(lái)說(shuō)，不必填寫(xiě)該欄。部件調(diào)用者指調(diào)用該部件的部件(或界面參數(shù))的編號(hào)和名稱。部件被調(diào)用者指被該部件所調(diào)用的部件的編號(hào)和名稱。部件入口參數(shù)指該部件入口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對(duì)這些數(shù)據(jù)的描述；如果部件沒(méi)有入口參數(shù)，該欄為空。部件出口參數(shù)指該部件出口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對(duì)這些數(shù)據(jù)的描述；如果部件沒(méi)有出口參數(shù)，該欄為空。算法指該部件的算法形式表示，如果很簡(jiǎn)單、或者不存在，也可以為空。流程描述指該部件的處理流程的詳細(xì)表示或描述。部件表示形式指該部件完成開(kāi)發(fā)后的最終表示形式，具體形式取決于開(kāi)發(fā)工具和軟件結(jié)構(gòu)，表示形式可能是：插件、組件、控件，函數(shù)、過(guò)程、子程序，存儲(chǔ)過(guò)程，動(dòng)態(tài)連接庫(kù)，等等。運(yùn)行環(huán)境描述該部件所適合的運(yùn)行環(huán)境，即說(shuō)明該部件是針對(duì)何種運(yùn)行環(huán)境所開(kāi)發(fā)的；可以直接描述運(yùn)行環(huán)境，也可以描述運(yùn)行環(huán)境的編號(hào)；對(duì)于實(shí)行配置管理的軟件開(kāi)發(fā)項(xiàng)目來(lái)說(shuō)，該描述必須與該部件在配置管理中的描相同。性能要求指開(kāi)發(fā)該部件時(shí)必須滿足的專門(mén)要求，這些要求可以是：精度靈活性響應(yīng)時(shí)間可重用性等等。提出的要求一般不宜超過(guò)3項(xiàng)，以排列的先后順序表示優(yōu)先級(jí)。詞匯表列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士也能夠在一定的范圍內(nèi)，讀懂軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告，要求盡可能使用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)進(jìn)行描述。所以這里所指的專業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專業(yè)術(shù)語(yǔ)，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。部件表格式部件編號(hào)部件名稱所屬子系統(tǒng)部件調(diào)用者部件被調(diào)用者部件入口參數(shù)部件入口參數(shù)算法：流程描述：表示性能運(yùn)行環(huán)境性能要求說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。界面表格式界面編號(hào)部件名稱界面性質(zhì)界面介質(zhì)表示形式：界面參數(shù)參數(shù)名內(nèi)容說(shuō)明說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。附錄D軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板1.引言 451.1編寫(xiě)目的 451.2項(xiàng)目來(lái)源 451.3文檔約定 451.4預(yù)期讀者和閱讀建議 451.5參考資料 452.數(shù)據(jù)庫(kù)命名規(guī)則 463.數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明 463.1數(shù)據(jù)庫(kù)邏輯設(shè)計(jì) 463.2數(shù)據(jù)庫(kù)物理設(shè)計(jì) 463.3數(shù)據(jù)庫(kù)分布 473.4基表設(shè)計(jì) 473.5視圖設(shè)計(jì) 483.6索引設(shè)計(jì) 493.7完整性約束 503.8授權(quán)設(shè)計(jì) 503.9觸發(fā)器設(shè)計(jì) 513.10存儲(chǔ)過(guò)程設(shè)計(jì) 513.11數(shù)據(jù)復(fù)制設(shè)計(jì) 524.詞匯表 535.歷史數(shù)據(jù)處理 53

引言引言是對(duì)這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)的概覽，是為了幫助閱讀者了解這份文檔是如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解