編寫規(guī)格說明書

編寫規(guī)格闡明書

項目視圖和范圍文檔包括了業(yè)務(wù)需求，而使用實例文檔則包括了顧客需求。你必須編寫從使用實例派生出的功能需求文檔，還要編寫產(chǎn)品的非功能需求文檔，包括質(zhì)量屬性和外部接口需求。軟件需求規(guī)格闡明論述一種軟件系統(tǒng)必須提供的功能和性能以及它所要考慮的限制條件,它不僅是系統(tǒng)測試和顧客文檔的基礎(chǔ)，也是所有子系列項目規(guī)劃、設(shè)計和編碼的基礎(chǔ)。它應(yīng)當盡量完整地描述系統(tǒng)預(yù)期的外部行為和顧客可視化行為。除了設(shè)計和實現(xiàn)上的限制，軟件需求規(guī)格闡明不應(yīng)當包括設(shè)計、構(gòu)造、測試或工程管理的細節(jié)。

1）采用軟件需求規(guī)格闡明模版:采用需求規(guī)格闡明書模板在你的組織中要為編寫軟件需求文檔定義一種原則模板。該模板為記錄功能需求和多種其他與需求有關(guān)的重要信息提供了統(tǒng)一的構(gòu)造。注意，其目的并非是創(chuàng)立一種全新的模板，而是采用一種已經(jīng)有的且可滿足項目需要并適合項目特點的模板。許多組織一開始都采用IEEE原則830-1998(IEEE1998)描述的需求規(guī)格闡明書模板。要相信模板是很有用的，但有時要根據(jù)項目特點進行合適的改動。

123456A引言目的文檔約定預(yù)期的讀者和閱讀提議產(chǎn)品的范圍參照文獻

B綜合描述產(chǎn)品的前景產(chǎn)品的功能顧客類和特性運行環(huán)境設(shè)計和實現(xiàn)上的限制假設(shè)和依賴附錄C外部接口需求附錄顧客界面附錄硬件接口軟件接口通信接口

D系統(tǒng)特性闡明和優(yōu)先級鼓勵/響應(yīng)序列功能需求

E其他非功能需求性能需求安全設(shè)施需求安全性需求軟件質(zhì)量屬性業(yè)務(wù)規(guī)則顧客文檔F其他需求

G附件詞匯表分析模型待確定問題的列表

a.引言

引言提出了對軟件需求規(guī)格闡明的縱覽，這有助于讀者理解文檔怎樣編寫并且怎樣閱讀和解釋。

a.1目的

對產(chǎn)品進行定義，在該文檔中詳盡闡明了這個產(chǎn)品的軟件需求，包括修正或發(fā)行版本號。假如這個軟件需求規(guī)格闡明只與整個系統(tǒng)的一部分有關(guān)系，那么就只定義文檔中闡明的部分或子系統(tǒng)。

a.2文檔約定

描述編寫文檔時所采用的原則或排版約定，包括正文風(fēng)格、提醒區(qū)或重要符號。

a.3預(yù)期的讀者和閱讀提議

列舉了軟件需求規(guī)格闡明所針對的不一樣讀者，例如開發(fā)人員、項目經(jīng)理、營銷人員、顧客、測試人員或文檔的編寫人員。描述了文檔中剩余部分的內(nèi)容及其組織構(gòu)造。提出了最適合于每一類型讀者閱讀文檔的提議。

a.4產(chǎn)品的范圍

提供了對指定的軟件及其目的的簡短描述，包括利益和目的。把軟件與企業(yè)目的或業(yè)務(wù)方略相聯(lián)絡(luò)?？梢詤⒄枕椖恳晥D和范圍文檔而不是將其內(nèi)容復(fù)制到這里。

a.5參照文獻

列舉了編寫軟件需求規(guī)格闡明時所參照的資料或其他資源。這也許包括顧客界面風(fēng)格指導(dǎo)、協(xié)議、原則、系統(tǒng)需求規(guī)格闡明、使用實例文檔，或有關(guān)產(chǎn)品的軟件需求規(guī)格闡明。

b.綜合描述

這一部分概述了正在定義的產(chǎn)品以及它所運行的環(huán)境、使用產(chǎn)品的顧客和已知的限制、假設(shè)和依賴。

b.1產(chǎn)品的前景

描述了軟件需求規(guī)格闡明中所定義的產(chǎn)品的背景和來源。闡明了該產(chǎn)品與否是產(chǎn)品系列中的下一組員，與否是成熟產(chǎn)品所改善的下一代產(chǎn)品、與否是既有應(yīng)用程序的替代品，或者與否是一種新型的、自含型產(chǎn)品。

b.2產(chǎn)品的功能

概述了產(chǎn)品所具有的重要功能。其詳細內(nèi)容將在d中描述，因此在此只需要概略地總結(jié)。很好地組織產(chǎn)品的功能，使每個讀者都易于理解。

b.3顧客類和特性

確定你覺得也許使用該產(chǎn)品的不一樣顧客類并描述它們有關(guān)的特性。有某些需求也許只與特定的顧客類有關(guān)。

b.4運行環(huán)境

描述了軟件的運行環(huán)境，包括硬件平臺、操作系統(tǒng)和版本，尚有其他的軟件組件或與其共存的應(yīng)用程序。

b.5設(shè)計和實現(xiàn)上的限制

確定影響開發(fā)人員自由選擇的問題，并闡明這些問題為何成為一種限制。

b.6假設(shè)和依賴

列舉出在對軟件需求規(guī)格闡明中影響需求陳說的假設(shè)原因（與已知原因相對立）。這也許包括你打算要用的商業(yè)組件或有關(guān)開發(fā)或運行環(huán)境的問題。你也許認為產(chǎn)品將符合一種特殊的顧客界面設(shè)計約定，不過另一種SRS讀者卻也許不這樣認為。假如這些假設(shè)不對的、不一致或被更改，就會使項目受到影響。

此外，確定項目對外部原因存在的依賴。例如，假如你打算把其他項目開發(fā)的組件集成到系統(tǒng)中，那么你就要依賴那個項目準時提供對的的操作組件。假如這些依賴已經(jīng)記錄到其他文檔(例如項目計劃)中了，那么在此就可以參照其他文檔。

c.外部接口需求

運用本節(jié)來確定可以保證新產(chǎn)品與外部組件對的連接的需求。關(guān)聯(lián)圖表達了高層抽象的外部接。需要把對接口數(shù)據(jù)和控制組件的詳細描述寫入數(shù)據(jù)字典中。假如產(chǎn)品的不一樣部分有不一樣的外部接口，那么應(yīng)把這些外部接口的詳細需求并入到這一部分的實例中。

c.1顧客界面

陳說所需要的顧客界面的軟件組件。描述每個顧客界面的邏輯特性。而對于顧客界面的細節(jié)，例如特定對話框的布局，應(yīng)當寫入一種獨立的顧客界面規(guī)格闡明中，而不能寫入軟件需求規(guī)格闡明中。

c.2硬件接口

描述系統(tǒng)中軟件和硬件每一接口的特性。這種描述也許包括支持的硬件類型、軟硬件之間交流的數(shù)據(jù)和控制信息的性質(zhì)以及所使用的通信協(xié)議。

c.3軟件接口

描述該產(chǎn)品與其他外部組件（由名字和版本識別）的連接，包括數(shù)據(jù)庫、操作系統(tǒng)、工具、庫和集成的商業(yè)組件。明確并描述在軟件組件之間互換數(shù)據(jù)或消息的目的。描述所需要的服務(wù)以及內(nèi)部組件通信的性質(zhì)。確定將在組件之間共享的數(shù)據(jù)。

c.4通信接口

描述與產(chǎn)品所使用的通信功能有關(guān)的需求，包括電子郵件、Web瀏覽器、網(wǎng)絡(luò)通信原則或協(xié)議及電子表格等等。定義了有關(guān)的消息格式。規(guī)定通信安全或加密問題、數(shù)據(jù)傳播速率和同步通信機制。

d.系統(tǒng)特性

d.1闡明和優(yōu)先級

提出了對該系統(tǒng)特性的簡短闡明并指出該特性的優(yōu)先級是高、中，還是低?；蛘吣氵€可以包括對特定優(yōu)先級部分的評價，例如利益、損失、費用和風(fēng)險，其相對優(yōu)先等級可以從1（低）到9（高）。

d.2鼓勵/響應(yīng)序列

列出輸入鼓勵（顧客動作、來自外部設(shè)備的信號或其他觸發(fā)器）和定義這一特性行為的系統(tǒng)響應(yīng)序列。這些序列將與使用實例有關(guān)的對話元素相對應(yīng)。

d.3功能需求

詳列出與該特性有關(guān)的詳細功能需求。這些是必須提交給顧客的軟件功能，使顧客可以使用所提供的特性執(zhí)行服務(wù)或者使用所指定的使用實例執(zhí)行任務(wù)。描述產(chǎn)品怎樣響應(yīng)可預(yù)知的出錯條件或者非法輸入或動作。就像本章開頭所描述的那樣，你必須唯一地標識每個需求。

e.其他非功能需求

這部分列舉出了所有非功能需求，如產(chǎn)品的易用程度怎樣，執(zhí)行速度怎樣，可靠性怎樣，當發(fā)生異常狀況時，系統(tǒng)怎樣處理，而不是外部接口需求和限制。

e.1性能需求

論述了不一樣的應(yīng)用領(lǐng)域?qū)Ξa(chǎn)品性能的需求，并解釋它們的原理以協(xié)助開發(fā)人員作出合理的設(shè)計選擇。確定互相合作的顧客數(shù)或者所支持的操作、響應(yīng)時間以及與實時系統(tǒng)的時間關(guān)系。你還可以在這里定義容量需求，例如存儲器和磁盤空間的需求或者存儲在數(shù)據(jù)庫中表的最大行數(shù)。盡量詳細地確定性能需求。也許需要針對每個功能需求或特性分別陳說其性能需求，而不是把它們都集中在一起陳說。

e.2安全設(shè)施需求

詳盡陳說與產(chǎn)品使用過程中也許發(fā)生的損失、破壞或危害有關(guān)的需求。定義必須采用的安全保護或動作，尚有那些防止的潛在的危險動作。明確產(chǎn)品必須遵從的安全原則、方略或規(guī)則。

e.3安全性需求

詳盡陳說與系統(tǒng)安全性、完整性或與私人問題有關(guān)的需求，這些問題將會影響到產(chǎn)品的使用和產(chǎn)品所創(chuàng)立或使用的數(shù)據(jù)的保護。定義顧客身份確認或授權(quán)需求。明確產(chǎn)品必須滿足的安全性或保密性方略。

e.4軟件質(zhì)量屬性

詳盡陳說與客戶或開發(fā)人員至關(guān)重要的其他產(chǎn)品質(zhì)量特性。這些特性必須是確定、定量的并在也許時是可驗證的。至少應(yīng)指明不一樣屬性的相對側(cè)重點，例如易用程度優(yōu)于易學(xué)程度，或者可移植性優(yōu)于有效性。

e.5業(yè)務(wù)規(guī)則

列舉出有關(guān)產(chǎn)品的所有操作規(guī)則，例如什么人在特定環(huán)境下可以進行何種操作。這些自身不是功能需求，但它們可以暗示某些功能需求執(zhí)行這些規(guī)則。

e.6顧客文檔

列舉出將與軟件一同發(fā)行的顧客文檔部分，例如，顧客手冊、在線協(xié)助和教程。明確所有已知的顧客文檔的交付格式或原則。

f.其他需求

定義在軟件需求規(guī)格闡明的其他部分未出現(xiàn)的需求，例如國際化需求或法律上的需求。你還可以增長有關(guān)操作、管理和維護部分來完善產(chǎn)品安裝、配置、啟動和關(guān)閉、修復(fù)和容錯，以及登錄和監(jiān)控操作等方面的需求。

附錄A：詞匯表

定義所有必要的術(shù)語，以便讀者可以對的地解釋軟件需求規(guī)格闡明，包括詞頭和縮寫。你也許但愿為整個企業(yè)創(chuàng)立一張跨越多項項目的詞匯表，并且只包括特定于單一項目的軟件需求規(guī)格闡明中的術(shù)語。

附錄B：分析模型

這個可選部分包括或波及到有關(guān)的分析模型的位置，例如數(shù)據(jù)流程圖、類圖、狀態(tài)轉(zhuǎn)換圖或?qū)嶓w-關(guān)系圖。

附錄C：待確定問題的列表

編輯一張在軟件需求規(guī)格闡明中待確定問題的列表，其中每一表項都是編上號的，以便于跟蹤調(diào)查。

2）指明需求來源：指明需求的來源為了讓所有項目風(fēng)險承擔(dān)者明白需求規(guī)格闡明書中為何提供這些功能需求，要都能追溯每項需求的來源，這也許是一種使用實例或其他客戶規(guī)定，也也許是某項更高層系統(tǒng)需求、業(yè)務(wù)規(guī)范、政府法規(guī)、原則或別的外部來源。

3）為每項需求注上標號：為了滿足軟件需求規(guī)格闡明的可跟蹤性和可修改性的質(zhì)量原則，必須唯一確定每個軟件需求。為每項需求注上標號制定一種通例來為需求規(guī)格闡明書中的每項需求提供一種獨立的可識別的標號或記號。這種通例應(yīng)當很健全，容許增長、刪除和修改。作了標號的需求使得需求能被跟蹤，記錄需求變更并為需求狀態(tài)和變更活動建立度量。需求標識措施有序列號;層次化編碼;使用"待確定"（tobedetermined,TBD）符號等。

4）記錄業(yè)務(wù)規(guī)范：是指有關(guān)產(chǎn)品的操作原則，例如誰能在什么狀況下采用什么動作。將這些編寫成需求規(guī)格闡明書中的一種獨立部分，或一獨立的業(yè)務(wù)規(guī)范文檔。某些業(yè)務(wù)規(guī)范將引出對應(yīng)的功能需求；當然這些需求也應(yīng)能追溯對應(yīng)業(yè)務(wù)規(guī)范。

5）創(chuàng)立需求跟蹤能力矩陣：建立一種矩陣把每項需求與實現(xiàn)、測試它的設(shè)計和代碼部分聯(lián)絡(luò)起來。這樣的需求跟蹤能力矩陣同步也把功能需求和高層的需求及其他有關(guān)需求聯(lián)絡(luò)起來了。在開發(fā)過程中建立這個矩陣，而不要等到最終才去補建。

這里還要簡介需求規(guī)格闡明書中設(shè)計階段，用到的圖形模型--數(shù)據(jù)字典、數(shù)據(jù)流圖、實體聯(lián)絡(luò)圖、狀態(tài)轉(zhuǎn)換圖、對話圖和類圖。

數(shù)據(jù)字典：一種定義應(yīng)用程序中使用的所有數(shù)據(jù)元素和構(gòu)造的含義、類型、數(shù)據(jù)大小、格式、度量單位、精度以及容許取值范圍的共享倉庫。數(shù)據(jù)字典的維護獨立于軟件需求規(guī)格闡明，并且在產(chǎn)品的開發(fā)和維護的任何階段，各個風(fēng)險承擔(dān)者都可以訪問數(shù)據(jù)字典。它定義了原數(shù)據(jù)元素、構(gòu)成構(gòu)造體的復(fù)雜數(shù)據(jù)元素、反復(fù)的數(shù)據(jù)項、一種數(shù)據(jù)項的枚舉值以及可選的數(shù)據(jù)項。

數(shù)據(jù)流圖：是構(gòu)造化系統(tǒng)分析的基本工具。一種數(shù)據(jù)流圖確定了系統(tǒng)的轉(zhuǎn)化過程、系統(tǒng)所操縱的數(shù)據(jù)或物質(zhì)的搜集（存儲），尚有過程、存儲、外部世界之間的數(shù)據(jù)流或物質(zhì)流。數(shù)據(jù)流模型把層次分解措施運用到系統(tǒng)分析上，這種措施很合用于事務(wù)處理系統(tǒng)和其他功能密集型應(yīng)用程序。

實體聯(lián)絡(luò)圖：描繪了系統(tǒng)的數(shù)據(jù)關(guān)系。分析實體聯(lián)絡(luò)圖有助于對業(yè)務(wù)或系統(tǒng)數(shù)據(jù)構(gòu)成的理解和交互，并暗示產(chǎn)品將有必要包括一種數(shù)據(jù)庫。相反，當你在系統(tǒng)設(shè)計階段建立實體聯(lián)絡(luò)圖時，一般要定義系統(tǒng)數(shù)據(jù)庫的物理構(gòu)造。

狀態(tài)轉(zhuǎn)換圖：實時系統(tǒng)和過程控制應(yīng)用程序可以在任何給定的時間內(nèi)以有限的狀態(tài)存在。當滿足所定義的原則時，狀態(tài)就會發(fā)生變化，例如在特定條件下，接受到一種特定的輸入鼓勵。這樣的系統(tǒng)是有限狀態(tài)機的例子。大多數(shù)軟件系統(tǒng)需要某些狀態(tài)建?；蚍治觯拖翊蠖鄶?shù)系統(tǒng)波及到轉(zhuǎn)換過程、數(shù)據(jù)實體和業(yè)務(wù)對象。

對話圖：在許多應(yīng)用