需求分析報告格式

軟件需求分析報告〔格式〕引言解釋這份文檔。編寫目的這份軟件產(chǎn)品需求分析報告詳盡說明白該軟件產(chǎn)品的需求規(guī)格，包括修正和(或)發(fā)行版本號，從而對該軟件產(chǎn)品進展準(zhǔn)確的定義。子系統(tǒng)。工程風(fēng)險具體說明本軟件開發(fā)工程的全部風(fēng)險擔(dān)當(dāng)者，以及各拘束本階段所需要擔(dān)當(dāng)?shù)闹饕L(fēng)險，首要風(fēng)險擔(dān)當(dāng)者包括：任務(wù)提出者；軟件開發(fā)者；產(chǎn)品使用者。文檔商定描述編寫文檔時所承受的標(biāo)準(zhǔn)(假設(shè)有標(biāo)準(zhǔn)的話)，或者各種排版商定。排版商定應(yīng)當(dāng)包括：正文風(fēng)格；提示方式；重要符號；也應(yīng)當(dāng)說明高層次需求是否可以被其全部細(xì)化的需求所繼承，或者每個需求陳述是否都有其自己的優(yōu)先級。預(yù)期讀者和閱讀建議列舉本軟件產(chǎn)品需求分析報告所針對的各種不同的預(yù)期讀者，例如，可能包括：用戶；開發(fā)人員；工程經(jīng)理；營銷人員；測試人員；文檔編寫入員。并且描述了文檔中，其余局部的內(nèi)容及其組織構(gòu)造，并且針對每一類讀者提出最適合的文檔閱讀建議。產(chǎn)品范圍描述產(chǎn)品范圍時需留意，可以參考工程視圖和范圍文檔，但是不能將其內(nèi)容復(fù)制到這里。參考文獻列舉編寫軟件產(chǎ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)軟件產(chǎn)品需求分析報告；為了便利讀者查閱，全部參考資料應(yīng)當(dāng)按肯定挨次排列。假設(shè)可能，每份資料都應(yīng)當(dāng)給出：標(biāo)題名稱；作者或者合同簽約者；文件編號或者版本號；發(fā)表日期或者簽約日期；出版單位或者資料來源。綜合描述知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依靠。產(chǎn)品的狀況描述了在軟件產(chǎn)品需求分析報告中所定義的軟件產(chǎn)品的背景和起源。說明白該軟件產(chǎn)品是否屬于以下狀況：是否是產(chǎn)品系列中的下一成員；是否是成熟產(chǎn)品所改進的下一代產(chǎn)品；是否是現(xiàn)有應(yīng)用軟件的替代品(升級產(chǎn)品)；是否是一個型的、自主型的產(chǎn)品。假設(shè)該軟件產(chǎn)品需求分析報告定義的軟件系統(tǒng)是：大系統(tǒng)的一個組成局部；與其它系統(tǒng)和其它機構(gòu)之間存在根本的相互關(guān)系。那么必需說明軟件產(chǎn)品需求分析報告定義的這局部軟件是怎樣與整個大系統(tǒng)相關(guān)聯(lián)的，或者〔同時〕說明相互關(guān)系的存在形式，并且要定義出兩者之間的全部接口。產(chǎn)品的功能4局部中具體描述軟件產(chǎn)品的功能，所以在此只需要概略地總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能，在描述功能時應(yīng)當(dāng)針對每一項需求準(zhǔn)確地描述其各項規(guī)格說明。假設(shè)存在引起誤會的可能，在陳述本軟件產(chǎn)品主要功能的作用領(lǐng)域時，也需要對應(yīng)陳述本軟件產(chǎn)品的非作用領(lǐng)域，以利讀者理解本軟件產(chǎn)品。以及它們之間的聯(lián)系使用數(shù)據(jù)流程圖的頂層圖或類圖進展表示，這種表示方法是很有用的。參考用戶當(dāng)前治理組織構(gòu)架，了解各個機構(gòu)的主要職能，將有助于陳述軟件產(chǎn)品的主要功能。用戶類和特性述時，應(yīng)當(dāng)將該軟件產(chǎn)品的重要用戶類與非重要用戶類區(qū)分開。用戶不肯定是軟件產(chǎn)品的直接使用者，通過報表、應(yīng)用程序接口、系統(tǒng)硬件接口得到軟件產(chǎn)品的數(shù)據(jù)和效勞的人、或者機構(gòu)也有他們的需求。所以，應(yīng)當(dāng)將這些外部需求視為通過報表、應(yīng)用程序接口、系統(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ā)標(biāo)準(zhǔn)和標(biāo)準(zhǔn)例如，假設(shè)由客戶的公司或者第三方公司負(fù)責(zé)軟件維護，就必需定義轉(zhuǎn)包者所使用的設(shè)計符號表示和編碼標(biāo)準(zhǔn)；企業(yè)策略的限制；政府法規(guī)的限制；工業(yè)標(biāo)準(zhǔn)的限制；硬件的限制例如，定時需求或存儲器限制；數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。假設(shè)和約束(依靠)列舉出對軟件產(chǎn)品需求分析報告中，影響需求陳述的假設(shè)因素(與己知因素相對立)。假設(shè)這些假設(shè)因素不正確、不全都或者被修改，就會使軟件產(chǎn)品開發(fā)工程受到影響。這些假設(shè)的因素可能包括：打算使用的商業(yè)組件，或者其它軟件中的某個部件；假定產(chǎn)品中某個用戶界面將符合一個特別的設(shè)計商定；有關(guān)本軟件用戶的假設(shè)干假定(SQL語言。)；有關(guān)本軟件開發(fā)工作的假設(shè)干假定(例如：用戶承諾的優(yōu)待、便利、上級部門賜予的特別政策和支持等。)；有關(guān)本軟件運行環(huán)境的一些問題；此外，確定本軟件開發(fā)工程對外部約束因素所存在的依靠。有關(guān)的約束可能包括：工期約束；經(jīng)費約束；人員約束；設(shè)備約束；地理位置約束；其它有關(guān)工程約束；外部接口需求數(shù)據(jù)和外部組件進展具體描述，并且寫入數(shù)據(jù)定義中。假設(shè)產(chǎn)品的不同局部有不同的外部接口，那么應(yīng)當(dāng)把這些外部接口的全部具體需求并入到這一局部實例中。留意：必需將附加用戶類的特征與外部接口需求加以區(qū)分，附加用戶類的特征描述的是通過接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求；而外部接口需求描述的是接口本身的需求。用戶界面特征，而不是用戶界面。以下是可能包括的一些特征：將要承受的圖形用戶界面(GUl)標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格；有關(guān)屏幕布局或者解決方案的限制； 將要使用在每一個屏幕(圖形用戶界面)上的軟件組件，可能包括：選單；消息欄；快捷鍵； 不同狀況下文字的對齊方式；日期的表現(xiàn)方法與格式；等等。錯誤信息顯示標(biāo)準(zhǔn)；對于用戶界面的細(xì)節(jié)，例如：一個特定對話框的布局，應(yīng)當(dāng)寫入具體的用戶界面設(shè)計說明中，而不能寫入軟件需求規(guī)格說明中。假設(shè)承受現(xiàn)成的、適宜的用戶界面設(shè)計標(biāo)準(zhǔn)(標(biāo)準(zhǔn))，或者另文描述，可以在這里直接說明，并且將其參加參考文獻。硬件接口描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征，假設(shè)有多個硬件接口，則必需全都描述。接口特征的描述內(nèi)容可能包括：支持的硬件類型；軟、硬件之間溝通的數(shù)據(jù)；掌握信息的性質(zhì)；使用的通訊協(xié)議；軟件接口描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必需明確它們的名稱和版本號以資識別，可能的外部組件包括：操作系統(tǒng)；數(shù)據(jù)庫；工具；函數(shù)庫；集成的商業(yè)組件“集成的商業(yè)組件”，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn)品集成的商業(yè)組件。例如：中間件、消息效勞，等等。軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。假設(shè)必需使用一種特別的方法來實現(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é)議；必需定義相關(guān)的：消息格式；通訊安全或加密問題；數(shù)據(jù)傳輸速率；同步和異步通訊機制；系統(tǒng)功能需求用戶的軟件功能，使得用戶可以使用所供給的功能執(zhí)行效勞或者使用所指定的使用實例執(zhí)行任務(wù)。描述軟件產(chǎn)品如何響應(yīng)己知的出錯條件、非法輸入、非法動作。假設(shè)每一項功能需求都能用一項，也只需要用一項測試用例就能進展驗證，那么就可以認(rèn)為功能需求已經(jīng)適當(dāng)?shù)剡M展描述問題。功能等級來組織這局部內(nèi)容，也可以便用這些元素的組合?？偠灾?，必需選擇一種是讀者簡潔理解預(yù)期產(chǎn)品的組織方案。4.1~4.3這三個局部。們的組合。其最終目的是，讓讀者簡潔理解馬上開發(fā)的軟件產(chǎn)品。一般來說，每個使用實例都對應(yīng)一個系統(tǒng)功能，因而依據(jù)使用實例來組織內(nèi)容比較簡潔讓用戶理解。對應(yīng)一些被共享的獨立使用實例，可以定義一些公用系統(tǒng)功能。2.2節(jié)“產(chǎn)品的功能”中描述的全部需求，以及它們的規(guī)格說明；必需在某個系統(tǒng)功能描述中有所反映，而且不應(yīng)重復(fù)。說明和優(yōu)先級1(低)9(高)。鼓勵／響應(yīng)序列列出輸入鼓勵(用戶動作、來自外部設(shè)備的信號或者其它觸發(fā))并且定義針對這——功能行為的系統(tǒng)響應(yīng)序列，這些序列將與使用實例中相關(guān)的對話元素相對應(yīng)。(擴大)過程，包括例外(引起任務(wù)不能挨次完成的狀況稱為例外)。疏忽了可選過程，有可能影響軟件產(chǎn)品的功能；假設(shè)遺漏例外過程，則有可能會引發(fā)系統(tǒng)崩潰。假設(shè)承受流程圖來描述鼓勵／響應(yīng)序列，比較簡潔讓用戶理解。輸入／輸出數(shù)據(jù)列出輸入數(shù)據(jù)()并且定義針對這些輸入數(shù)據(jù)的處理(計算)出數(shù)據(jù)，描述對應(yīng)區(qū)分：輸入數(shù)據(jù)和輸出數(shù)據(jù)。對于每一項數(shù)據(jù)，均需要描述：數(shù)據(jù)名稱；實際含義；數(shù)據(jù)類型；數(shù)據(jù)格式；數(shù)據(jù)約束；計算過程中涉及查表、推斷、迭代等處理方法，應(yīng)當(dāng)給出處理依據(jù)和相關(guān)數(shù)據(jù)。假設(shè)計算方法很簡潔，也可以將其從略，不加描述。其它非功能需求在這里列舉出全部非功能需求，主要包括牢靠性、安全性、可維護性、可擴展性、可測試性等。性能需求可能具體地描述性能需求，假設(shè)需要，可以針對每個功能需求或者特征分別陳述其性能需求。在這里確定：相互合作的用戶數(shù)量；系統(tǒng)支持的并發(fā)操作數(shù)量；響應(yīng)時間；與實時系統(tǒng)的時間關(guān)系： 容量需求存儲器；數(shù)據(jù)庫中表的最大行數(shù)。安全措施需求防的潛在危急動作。明確軟件產(chǎn)品必需遵從的安全標(biāo)準(zhǔn)、策略、或規(guī)章。安全性需求和軟件產(chǎn)品所創(chuàng)立或者使用的數(shù)據(jù)的保護。定義用戶身份認(rèn)證，或備授權(quán)需求。明確軟件產(chǎn)品必需滿足的安全性或者保密性策略。也可以通過稱為完整性的質(zhì)量屬性來闡述這些需求。一個典型的軟件系統(tǒng)安全需求范例如下：“每個用戶在第一次登錄后，必需更改他的系統(tǒng)預(yù)置登錄密碼，系統(tǒng)預(yù)置的登錄密碼不能重用。”軟件質(zhì)量屬性要時是可以驗證的。至少也應(yīng)當(dāng)指明不同屬性的相對側(cè)重點，例如：易用性優(yōu)于易學(xué)性，或者可移植性優(yōu)于有效性。業(yè)務(wù)規(guī)章可以示意某些功能需求執(zhí)行這些規(guī)章。一個業(yè)務(wù)規(guī)章的范例如下：“10，000，00元人民幣的儲蓄業(yè)務(wù)時，必需通過附加的治理員認(rèn)證。”列舉業(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è)術(shù)語，也應(yīng)當(dāng)列入詞匯表并且加以準(zhǔn)確定義。數(shù)據(jù)定義類型、數(shù)據(jù)大小、格式、計量單位、精度以及取值范圍。數(shù)據(jù)定義的維護獨立于軟件需求規(guī)格說明，并且在軟件產(chǎn)品開發(fā)和維護的任何階段，均向風(fēng)險擔(dān)當(dāng)者開放。是卻不利于多人協(xié)同編寫需求分析報告，簡潔遺漏數(shù)據(jù)，也不便利閱讀。因此還是建議為每個特性描述有關(guān)的數(shù)據(jù)項，匯總數(shù)據(jù)項創(chuàng)立數(shù)據(jù)定義，再依據(jù)數(shù)據(jù)定義復(fù)核全部數(shù)據(jù)，使得它們的名稱和含義完全全都。必需留意的是，為了避開二義性，在匯總數(shù)據(jù)項時應(yīng)當(dāng)依據(jù)數(shù)據(jù)項所代表的實際意義匯總，而不是依據(jù)數(shù)據(jù)項的名稱匯總。在數(shù)據(jù)定義中，每個數(shù)據(jù)項除了有一個中文名稱外，還應(yīng)當(dāng)為它取一個簡短的英文名稱，該英文名稱應(yīng)當(dāng)符合命名標(biāo)準(zhǔn)，原數(shù)據(jù)元素注釋文本，描述原數(shù)據(jù)元素的定義。選