軟件需求分析報告

附錄A軟件需求分析報告文檔模板附錄A軟件需求分析報告文檔模板 11.引言 41.1編寫目的 51.2項目風險 51.3文檔商定 51.4預期讀者和閱讀建議 61.5產(chǎn)品范疇 71.6參考文獻 72.綜合描述 82.1產(chǎn)品的狀況 82.2產(chǎn)品的功效 92.3顧客類和特性 102.4運行環(huán)境 102.5設計和實現(xiàn)上的限制 112.6假設和約束(依賴) 123.外部接口需求 133.1顧客界面 133.2硬件接口 153.3軟件接口 153.4通訊接口 164.系統(tǒng)功效需求 174.1闡明和優(yōu)先級 184.2激勵／響應序列 184.3輸入／輸出數(shù)據(jù) 195.其它非功效需求 195.1性能需求 205.2安全方法需求 205.3安全性需求 215.4軟件質(zhì)量屬性 215.5業(yè)務規(guī)則 215.6顧客文檔 216.詞匯表 227.數(shù)據(jù)定義 228.分析模型 249.待定問題列表 251.1編寫目的 21.2項目風險 21.3文檔商定 21.4預期讀者和閱讀建議 21.5產(chǎn)品范疇 31.6參考文獻 32.綜合描述 32.1產(chǎn)品的狀況 32.2產(chǎn)品的功效 42.3顧客類和特性 42.4運行環(huán)境 42.5設計和實現(xiàn)上的限制 42.6假設和約束(依賴) 53.外部接口需求 53.1顧客界面 53.2硬件接口 63.3軟件接口 63.4通訊接口 74.系統(tǒng)功效需求 74.1闡明和優(yōu)先級 74.2激勵／響應序列 84.3輸入／輸出數(shù)據(jù) 85.其它非功效需求 85.1性能需求 85.2安全方法需求 95.3安全性需求 95.4軟件質(zhì)量屬性 95.5業(yè)務規(guī)則 95.6顧客文檔 96.詞匯表 107.數(shù)據(jù)定義 108.分析模型 119.待定問題列表 11引言引言是對這份軟件產(chǎn)品需求分析報告的概覽，是為了協(xié)助閱讀者理解這份文檔是如何編寫的，并且應當如何閱讀、理解和解釋這份文檔。編寫目的闡明這份軟件產(chǎn)品需求分析報告是為哪個軟件產(chǎn)品編寫的，開發(fā)這個軟件產(chǎn)品意義、作用、以及最后要達成的意圖。通過這份軟件產(chǎn)品需求分析報告詳盡闡明了該軟件產(chǎn)品的需求規(guī)格，涉及修正和(或)發(fā)行版本號，從而對該軟件產(chǎn)品進行精確的定義。如果這份軟件產(chǎn)品需求分析報告只與整個系統(tǒng)的某一部分有關系，那么只定義軟件產(chǎn)品需求分析報告中闡明的那個部分或子系統(tǒng)。項目風險具體闡明本軟件開發(fā)項目的全部風險承當者，以及各自在本階段所需要承當?shù)闹匾L險，首要風險承當者涉及：任務提出者；軟件開發(fā)者；產(chǎn)品使用者。文檔商定描述編寫文檔時所采用的原則(如果有原則的話)，或者多個排版商定。排版商定應當涉及：正文風格；提示方式；重要符號；也應當闡明高層次需求與否能夠被其全部細化的需求所繼承，或者每個需求陳說與否都有其自己的優(yōu)先級。預期讀者和閱讀建議列舉本軟件產(chǎn)品需求分析報告所針對的多個不同的預期讀者，例如，可能涉及：顧客；開發(fā)人員；項目經(jīng)理；營銷人員；測試人員；文檔編寫入員。并且描述了文檔中，其它部分的內(nèi)容及其組織構造，并且針對每一類讀者提出最適合的文檔閱讀建議。產(chǎn)品范疇闡明該軟件產(chǎn)品及其開發(fā)目的的簡短描述，涉及利益和目的。把軟件產(chǎn)品開發(fā)與公司目的，或者業(yè)務方略相聯(lián)系。描述產(chǎn)品范疇時需注意，能夠參考項目視圖和范疇文檔，但是不能將其內(nèi)容復制到這里。參考文獻列舉編寫軟件產(chǎn)品需求分析報告時所用到的參考文獻及資料，可能涉及：本項目的合同書；上級機關有關本項目的批文；本項目已經(jīng)同意的計劃任務書；顧客界面風格指導；開發(fā)本項目時所要用到的標淮；系統(tǒng)規(guī)格需求闡明；使用實例文檔；屬于本項目的其它己發(fā)表文獻；本軟件產(chǎn)品需求分析報告中所引用的文獻、資料；有關軟件產(chǎn)品需求分析報告；為了方便讀者查閱，全部參考資料應當按一定次序排列。如果可能，每份資料都應當給出：標題名稱；作者或者合同簽約者；文獻編號或者版本號；發(fā)表日期或者簽約日期；出版單位或者資料來源。綜合描述這一部分概述了正在定義的軟件產(chǎn)品的作用范疇以及該軟件產(chǎn)品所運行的環(huán)境、使用該軟件產(chǎn)品的顧客、對該軟件產(chǎn)品己知的限制、有關該軟件產(chǎn)品的假設和依賴。產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報告中所定義的軟件產(chǎn)品的背景和來源。闡明了該軟件產(chǎn)品與否屬于下列狀況：與否是產(chǎn)品系列中的下一組員；與否是成熟產(chǎn)品所改善的下一代產(chǎn)品；與否是現(xiàn)有應用軟件的替代品(升級產(chǎn)品)；與否是一種新型的、自主型的產(chǎn)品。如果該軟件產(chǎn)品需求分析報告定義的軟件系統(tǒng)是：大系統(tǒng)的一種構成部分；與其它系統(tǒng)和其它機構之間存在基本的互有關系。那么必須闡明軟件產(chǎn)品需求分析報告定義的這部分軟件是如何與整個大系統(tǒng)有關聯(lián)的，或者（同時）闡明互有關系的存在形式，并且要定義出兩者之間的全部接口。產(chǎn)品的功效由于將在需求分析報告的第4部分中具體描述軟件產(chǎn)品的功效，因此在此只需要概略地總結。僅從業(yè)務層面陳說本軟件產(chǎn)品所應含有的重要功效，在描述功效時應當針對每一項需求精確地描述其各項規(guī)格闡明。如果存在引發(fā)誤解的可能，在陳說本軟件產(chǎn)品重要功效的作用領域時，也需要對應陳說本軟件產(chǎn)品的非作用領域，以利讀者理解本軟件產(chǎn)品。為了較好地組織產(chǎn)品功效，使每個讀者都容易理解，能夠采用列表的辦法給出。也能夠采用圖形方式，將重要的需求分組以及它們之間的聯(lián)系使用數(shù)據(jù)流程圖的頂層圖或類圖進行表達，這種表達辦法是很有用的。參考顧客現(xiàn)在管理組織構架，理解各個機構的重要職能，將有助于陳說軟件產(chǎn)品的重要功效。顧客類和特性擬定有可能使用該軟件產(chǎn)品的不同顧客類，并且描述它們有關的特性。往往有某些軟件需求，只與特定的顧客類有關。描述時，應當將該軟件產(chǎn)品的重要顧客類與非重要顧客類分辨開。顧客不一定是軟件產(chǎn)品的直接使用者，通過報表、應用程序接口、系統(tǒng)硬件接口得到軟件產(chǎn)品的數(shù)據(jù)和服務的人、或者機構也有他們的需求。因此，應當將這些外部需求視為通過報表、應用程序接口、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附加顧客類。運行環(huán)境描述了本軟件的運行環(huán)境，普通涉及：硬件平臺；操作系統(tǒng)和版本；支撐環(huán)境(例如：數(shù)據(jù)庫等)和版本；其它與該軟件有關的軟件組件；與該軟件共存的應用程序。設計和實現(xiàn)上的限制擬定影響開發(fā)人員自由選擇的問題，并且闡明這些問題為什么成為一種限制?？赡艿南拗粕婕跋铝袃?nèi)容：必須使用的特定技術、工具、編程語言和數(shù)據(jù)庫；避免使用的特定技術、工具、編程語言和數(shù)據(jù)庫；規(guī)定遵照的開發(fā)規(guī)范和原則例如，如果由客戶的公司或者第三方公司負責軟件維護，就必須定義轉包者所使用的設計符號表達和編碼原則；公司方略的限制；政府法規(guī)的限制；工業(yè)原則的限制；硬件的限制例如，定時需求或存儲器限制；數(shù)據(jù)轉換格式標淮的限制。假設和約束(依賴)列舉出對軟件產(chǎn)品需求分析報告中，影響需求陳說的假設因素(與己知因素相對立)。如果這些假設因素不對的、不一致或者被修改，就會使軟件產(chǎn)品開發(fā)項目受到影響。這些假設的因素可能涉及：計劃使用的商業(yè)組件，或者其它軟件中的某個部件；假定產(chǎn)品中某個顧客界面將符合一種特殊的設計商定；有關本軟件顧客的若干假定(例如：假定顧客會純熟使用SQL語言。)；有關本軟件開發(fā)工作的若干假定(例如：顧客承諾的優(yōu)惠、方便、上級部門予以的特殊政策和支持等。)；有關本軟件運行環(huán)境的某些問題；另外，擬定本軟件開發(fā)項目對外部約束因素所存在的依賴。有關的約束可能涉及：工期約束；經(jīng)費約束；人員約束；設備約束；地理位置約束；其它有關項目約束；外部接口需求通過本節(jié)描述能夠擬定，確保軟件產(chǎn)品能和外部組件對的連接的需求。關聯(lián)圖僅能表達高層抽象的外部接口，必須對接口數(shù)據(jù)和外部組件進行具體描述，并且寫入數(shù)據(jù)定義中。如果產(chǎn)品的不同部分有不同的外部接口，那么應當把這些外部接口的全部具體需求并入到這一部分實例中。注意：必須將附加顧客類的特性與外部接口需求加以分辨，附加顧客類的特性描述的是通過接口獲得軟件產(chǎn)品的數(shù)據(jù)和服務的人的需求；而外部接口需求描述的是接口本身的需求。顧客界面陳說需要使用在顧客界面上的軟件組件，描述每一種顧客界面的邏輯特性。必須注意，這里需要描述的是顧客界面的邏輯特性，而不是顧客界面。下列是可能涉及的某些特性：將要采用的圖形顧客界面(GUl)原則或者產(chǎn)品系列的風格；有關屏幕布局或者解決方案的限制；將要使用在每一種屏幕(圖形顧客界面)上的軟件組件，可能涉及：選單；原則按鈕；導航鏈接；多個功效組件；消息欄；快捷鍵；多個顯示格式的規(guī)定，可能涉及：不同狀況下文字的對齊方式；不同狀況下數(shù)字的體現(xiàn)格式與對齊方式日期的體現(xiàn)辦法與格式；計時辦法與時間格式；等等。錯誤信息顯示原則；對于顧客界面的細節(jié)，例如：一種特定對話框的布局，應當寫入具體的顧客界面設計闡明中，而不能寫入軟件需求規(guī)格闡明中。如果采用現(xiàn)成的、適宜的顧客界面設計規(guī)范(原則)，或者另文描述，能夠在這里直接闡明，并且將其加入?yún)⒖嘉墨I。硬件接口描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特性，若有多個硬件接口，則必須全都描述。接口特性的描述內(nèi)容可能涉及：支持的硬件類型；軟、硬件之間交流的數(shù)據(jù)；控制信息的性質(zhì)；使用的通訊合同；軟件接口描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號以資識別，可能的外部組件涉及：操作系統(tǒng)；數(shù)據(jù)庫；工具；函數(shù)庫；集成的商業(yè)組件闡明：這里所說的“集成的商業(yè)組件”，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn)品集成的商業(yè)組件。例如：中間件、消息服務，等等。描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需要的服務，以及與內(nèi)部組件通訊的性質(zhì)。擬定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。如果必須使用一種特殊的辦法來實現(xiàn)數(shù)據(jù)共享機制，例如：在多顧客系統(tǒng)中的一種全局數(shù)據(jù)區(qū)，那么就必須把它定義為一種實現(xiàn)上的限制。通訊接口描述與軟件產(chǎn)品所使用的通訊功效有關的需求，涉及：電子郵件；WEB瀏覽器；網(wǎng)絡通訊原則或者合同；數(shù)據(jù)交互用電子表格；必須定義有關的：消息格式；通訊安全或加密問題；數(shù)據(jù)傳輸速率；同時和異步通訊機制；系統(tǒng)功效需求需要進行具體的需求統(tǒng)計，具體列出與該系統(tǒng)功效有關的具體功效需求，并且，唯一地標記每一項需求。這是必須提交給顧客的軟件功效，使得顧客能夠使用所提供的功效執(zhí)行服務或者使用所指定的使用實例執(zhí)行任務。描述軟件產(chǎn)品如何響應己知的出錯條件、非法輸入、非法動作。如果每一項功效需求都能用一項，也只需要用一項測試用例就能進行驗證，那么就能夠認為功效需求已經(jīng)適宜地進行描述了。如果某項功效需求找不到適宜的測試用例，或者必須使用多項測試用例才干驗證，那么該項功效需求的描述必然存在某些問題。功效需求是根據(jù)系統(tǒng)功效，即軟件產(chǎn)品所提供的重要服務來組織的。能夠通過使用實例、運行模式、顧客類、對象類或者功效等級來組織這部分內(nèi)容，也能夠便用這些元素的組合?？偠灾仨氝x擇一種是讀者容易理解預期產(chǎn)品的組織方案。用簡短的語句闡明功效的名稱，例如：“4.1系統(tǒng)參數(shù)管理”。按照服務組織的次序，逐條敘述系統(tǒng)功效。無論闡明的是何種功效，都應當針對該系統(tǒng)功效重復敘述4.1~4.3這三個部分。能夠通過多個方式來組織這一部分內(nèi)容，例如采用：使用實例、運行模式、顧客類、對象類、功效等級等，也能夠采用它們的組合。其最后目的是，讓讀者容易理解即將開發(fā)的軟件產(chǎn)品。普通來說，每個使用實例都對應一種系統(tǒng)功效，因而按照使用實例來組織內(nèi)容比較容易讓顧客理解。對應某些被共享的獨立使用實例，能夠定義某些公用系統(tǒng)功效。必須特別注意的是，在2.2節(jié)“產(chǎn)品的功效”中描述的全部需求，以及它們的規(guī)格闡明；必須在某個系統(tǒng)功效描述中有所反映，并且不應重復。闡明和優(yōu)先級對該系統(tǒng)功效進行簡短的闡明，并且指出該系統(tǒng)功效的優(yōu)先級是：高、中、還是低。需要的話，還能夠涉及對特定優(yōu)先級部分的評價，例如：利益、損失、費用和風險，其相對優(yōu)先等級能夠從1(低)到9(高)。激勵／響應序列列出輸入激勵(顧客動作、來自外部設備的信號或者其它觸發(fā))并且定義針對這——功效行為的系統(tǒng)響應序列，這些序列將與使用實例中有關的對話元素相對應。描述激勵／響應序列時，不僅需要描述基本過程，并且應當描述可選(擴充)過程，涉及例外(引發(fā)任務不能次序完畢的狀況稱為例外)。疏忽了可選過程，有可能影響軟件產(chǎn)品的功效；如果遺漏例外過程，則有可能會引發(fā)系統(tǒng)崩潰。如果采用流程圖來描述激勵／響應序列，比較容易讓顧客理解。輸入／輸出數(shù)據(jù)列出輸入數(shù)據(jù)(顧客輸入、來自外部接口的輸入或者其它輸入)并且定義針對這些輸入數(shù)據(jù)的解決(計算)辦法，以及對應地輸出數(shù)據(jù)，描述對應區(qū)別：輸入數(shù)據(jù)和輸出數(shù)據(jù)。當有大量數(shù)據(jù)需要描述時，也能夠分類描述數(shù)據(jù)，并且注明各項數(shù)據(jù)的輸入、輸出屬性。對于每一項數(shù)據(jù)，均需要描述：數(shù)據(jù)名稱；實際含義；數(shù)據(jù)類型；數(shù)據(jù)格式；數(shù)據(jù)約束；對于復雜的解決辦法，僅僅給出算法原理是不夠的，必須描述具體的計算過程，并且列出每一步具體使用的實際算式；如果計算過程中涉及查表、判斷、迭代等解決辦法，應當給出解決根據(jù)和有關數(shù)據(jù)。如果計算辦法很簡樸，也能夠將其從略，不加描述。其它非功效需求在這里列舉出全部非功效需求，重要涉及可靠性、安全性、可維護性、可擴展性、可測試性等。性能需求敘述不同應用領域對軟件產(chǎn)品性能的需求，并且闡明提出需求的原理或者根據(jù)，以協(xié)助開發(fā)人員做出合理的設計選擇。盡量具體地描述性能需求，如果需要，能夠針對每個功效需求或者特性分別陳說其性能需求。在這里擬定：互相合作的顧客數(shù)量；系統(tǒng)支持的并發(fā)操作數(shù)量；響應時間；與實時系統(tǒng)的時間關系：容量需求存儲器；磁盤空間；數(shù)據(jù)庫中表的最大行數(shù)。安全方法需求詳盡陳說與軟件產(chǎn)品使用過程中可能發(fā)生的損失、破壞、危害有關的需求。定義必須采用的安全保護或動作，以及必須防止的潛在危險動作。明確軟件產(chǎn)品必須遵從的安全原則、方略、或規(guī)則。安全性需求詳盡陳說與系統(tǒng)安全性、完整性問題有關的需求，或者與個人隱私問題有關的需求。這些問題將會影響到軟件產(chǎn)品的使用，和軟件產(chǎn)品所創(chuàng)立或者使用的數(shù)據(jù)的保護。定義顧客身份認證，或備授權需求。明確軟件產(chǎn)品必須滿足的安全性或者保密性方略。也能夠通過稱為完整性的質(zhì)量屬性來敘述這些需求。一種典型的軟件系統(tǒng)安全需求范例以下：“每個顧客在第一次登錄后，必須更改他的系統(tǒng)預置登錄密碼，系統(tǒng)預置的登錄密碼不能重用?！避浖|(zhì)量屬性詳盡陳說對客戶和開發(fā)人員至關重要的在軟件產(chǎn)品其它方面體現(xiàn)出來的質(zhì)量功效。這些功效必須是擬定的、定量的、在需要時是能夠驗證的。最少也應當指明不同屬性的相對側重點，例如：易用性優(yōu)于易學性，或者可移植性優(yōu)于有效性。業(yè)務規(guī)則列舉出有關軟件產(chǎn)品的全部操作規(guī)則，例如：那些人在特定環(huán)境下能夠進行何種操作。這些本身不是功效需求，但是他們能夠暗示某些功效需求執(zhí)行這些規(guī)則。一種業(yè)務規(guī)則的范例以下：“進行達成或者超出10，000，00元人民幣的儲蓄業(yè)務時，必須通過附加的管理員認證?！绷信e業(yè)務規(guī)則時，能夠根據(jù)規(guī)則的數(shù)量，選用適宜的編目方式。顧客文檔列舉出將與軟件產(chǎn)品一同交付的顧客文檔，并且明確全部己知顧客文檔的交付格式或原則，例如：安裝指南紙質(zhì)文檔，16開本；顧客手冊紙質(zhì)文檔，16開本；在線協(xié)助電子文檔，與軟件產(chǎn)品一同分發(fā)、配備；使用教程電子文檔，與軟件產(chǎn)品一同分發(fā)、配備。詞匯表列出本文獻中用到的專業(yè)術語的定義，以及有關縮寫的定義(如有可能，列出有關的外文原詞)。為了便于非軟件專業(yè)或者非計算機專業(yè)人士閱讀軟件產(chǎn)品需求分析報告，規(guī)定使用非軟件專業(yè)或者非計算機專業(yè)的術語描述軟件需求。因此這里所指的專業(yè)術語，是指業(yè)務層面上的專業(yè)術語，而不是軟件專業(yè)或者計算機專業(yè)的術語。但是，對于無法回避的軟件專業(yè)或者計算機專業(yè)術語，也應當列入詞匯表并且加以精擬定義。數(shù)據(jù)定義數(shù)據(jù)定義是一種定義了應用程序中使用的全部數(shù)據(jù)元素和構造的共享文檔，其中對每個數(shù)據(jù)元素和構造都精確描述：含義、類型、數(shù)據(jù)大小、格式、計量單位、精度以及取值范疇。數(shù)據(jù)定義的維護獨立于軟件需求規(guī)格闡明，并且在軟件產(chǎn)品開發(fā)和維護的任何階段，均向風險承當者開放。如果為軟件開發(fā)項目創(chuàng)立一種獨立的數(shù)據(jù)定義，而不是為每一項特性描述有關的數(shù)據(jù)項，有助于