功能說明書模板.docx

功能說明書模板1.引言：引言提出了對軟件需求規(guī)格說明的縱覽，這有助于讀者理解文檔如何編寫并且如何閱讀和解釋。1.1 目的：對產(chǎn)品進行定義，在該文檔中詳盡說明了這個產(chǎn)品的軟件需求，包括修正或發(fā)行版本號。如果這個軟件需求規(guī)格說明只與整個系統(tǒng)的一部分有關系，那么就只定義文檔中說明的部分或子系統(tǒng)。1.2 文檔約定：描述編寫文檔時所采用的標準或排版約定，包括正文風格、提示區(qū)或重要符號。1.3 預期的讀者和閱讀建議：列舉了軟件需求規(guī)格說明所針對的不同讀者，例如開發(fā)人員、項目經(jīng)理、營銷人員、用戶、測試人員或文檔的編寫人員。描述了文檔中剩余部分的內容及其組織結構。提出了最適合于每一類型讀者閱讀文檔的建議。1.4 產(chǎn)品的范圍：提供了對指定的軟件及其目的的簡短描述，包括利益和目標。把軟件與企業(yè)目標或業(yè)務策略相聯(lián)系?？梢詤⒖柬椖恳晥D和范圍文檔而不是將其內容復制到這里。1.5 參考文獻：列舉了編寫軟件需求規(guī)格說明時所參考的資料或其它資源。這可能包括用戶界面風格指導、合同、標準、系統(tǒng)需求規(guī)格說明、使用實例文檔，或相關產(chǎn)品的軟件需求規(guī)格說明。2.綜合描述：這一部分概述了正在定義的產(chǎn)品以及它所運行的環(huán)境、使用產(chǎn)品的用戶和已知的限制、假設和依賴。2.1 產(chǎn)品的前景：描述了軟件需求規(guī)格說明中所定義的產(chǎn)品的背景和起源。說明了該產(chǎn)品是否是產(chǎn)品系列中的下一成員，是否是成熟產(chǎn)品所改進的下一代產(chǎn)品、是否是現(xiàn)有應用程序的替代品，或者是否是一個新型的、自含型產(chǎn)品。2.2 產(chǎn)品的功能：概述了產(chǎn)品所具有的主要功能。其詳細內容將在d 中描述，所以在此只需要概略地總結。很好地組織產(chǎn)品的功能，使每個讀者都易于理解。2.3 用戶類和特征：確定你覺得可能使用該產(chǎn)品的不同用戶類并描述它們相關的特征。有一些需求可能只與特定的用戶類相關。2.4 運行環(huán)境：描述了軟件的運行環(huán)境，包括硬件平臺、操作系統(tǒng)和版本，還有其它的軟件組件或與其共存的應用程序。2.5 設計和實現(xiàn)上的限制：確定影響開發(fā)人員自由選擇的問題，并說明這些問題為什么成為一種限制。2.6 假設和依賴：列舉出在對軟件需求規(guī)格說明中影響需求陳述的假設因素（與已知因素相對立）。這可能包括你打算要用的商業(yè)組件或有關開發(fā)或運行環(huán)境的問題。你可能認為產(chǎn)品將符合一個特殊的用戶界面設計約定，但是另一個S R S 讀者卻可能不這樣認為。如果這些假設不正確、不一致或被更改，就會使項目受到影響。3.外部接口需求：利用本節(jié)來確定可以保證新產(chǎn)品與外部組件正確連接的需求。關聯(lián)圖表示了高層抽象的外部接。需要把對接口數(shù)據(jù)和控制組件的詳細描述寫入數(shù)據(jù)字典中。如果產(chǎn)品的不同部分有不同的外部接口，那么應把這些外部接口的詳細需求并入到這一部分的實例中。3.1 用戶界面：陳述所需要的用戶界面的軟件組件。描述每個用戶界面的邏輯特征。而對于用戶界面的細節(jié)，例如特定對話框的布局，應該寫入一個獨立的用戶界面規(guī)格說明中，而不能寫入軟件需求規(guī)格說明中。3.2硬件接口：描述系統(tǒng)中軟件和硬件每一接口的特征。這種描述可能包括支持的硬件類型、軟硬件之間交流的數(shù)據(jù)和控制信息的性質以及所使用的通信協(xié)議。3.3 軟件接口：描述該產(chǎn)品與其它外部組件（由名字和版本識別）的連接，包括數(shù)據(jù)庫、操作系統(tǒng)、工具、庫和集成的商業(yè)組件。明確并描述在軟件組件之間交換數(shù)據(jù)或消息的目的。描述所需要的服務以及內部組件通信的性質。確定將在組件之間共享的數(shù)據(jù)。3.4 通信接口：描述與產(chǎn)品所使用的通信功能相關的需求包括電子郵件、Web 瀏覽器、網(wǎng)絡通信標準或協(xié)議及電子表格等等。定義了相關的消息格式。規(guī)定通信安全或加密問題、數(shù)據(jù)傳輸速率和同步通信機制。4.系統(tǒng)特性：4.1 說明和優(yōu)先級：提出了對該系統(tǒng)特性的簡短說明并指出該特性的優(yōu)先級是高、中，還是低?；蛘吣氵€可以包括對特定優(yōu)先級部分的評價，例如利益、損失、費用和風險，其相對優(yōu)先等級可以從1（低）到9 （高）。4.2 激勵/響應序列：列出輸入激勵（用戶動作、來自外部設備的信號或其它觸發(fā)器）和定義這一特性行為的系統(tǒng)響應序列。這些序列將與使用實例相關的對話元素相對應。4.3 功能需求：詳列出與該特性相關的詳細功能需求。這些是必須提交給用戶的軟件功能，使用戶可以使用所提供的特性執(zhí)行服務或者使用所指定的使用實例執(zhí)行任務。描述產(chǎn)品如何響應可預知的出錯條件或者非法輸入或動作。就像本章開頭所描述的那樣，你必須唯一地標識每個需求。5.其他非功能需求：這部分列舉出了所有非功能需求，如產(chǎn)品的易用程度如何，執(zhí)行速度如何，可靠性如何，當發(fā)生異常情況時，系統(tǒng)如何處理，而不是外部接口需求和限制。5.1 性能需求：闡述了不同的應用領域對產(chǎn)品性能的需求，并解釋它們的原理以幫助開發(fā)人員作出合理的設計選擇。確定相互合作的用戶數(shù)或者所支持的操作、響應時間以及與實時系統(tǒng)的時間關系。你還可以在這里定義容量需求，例如存儲器和磁盤空間的需求或者存儲在數(shù)據(jù)庫中表的最大行數(shù)。盡可能詳細地確定性能需求。可能需要針對每個功能需求或特性分別陳述其性能需求，而不是把它們都集中在一起陳述。5.2 安全設施需求：詳盡陳述與產(chǎn)品使用過程中可能發(fā)生的損失、破壞或危害相關的需求。定義必須采取的安全保護或動作，還有那些預防的潛在的危險動作。明確產(chǎn)品必須遵從的安全標準、策略或規(guī)則。5.3 安全性需求：詳盡陳述與系統(tǒng)安全性、完整性或與私人問題相關的需求，這些問題將會影響到產(chǎn)品的使用和產(chǎn)品所創(chuàng)建或使用的數(shù)據(jù)的保護。定義用戶身份確認或授權需求。明確產(chǎn)品必須滿足的安全性或保密性策略。5.4 軟件質量需求：詳盡陳述與客戶或開發(fā)人員至關重要的其它產(chǎn)品質量特性。這些特性必須是確定、定量的并在可能時是可驗證的。至少應指明不同屬性的相對側重點，例如易用程度優(yōu)于易學程度，或者可移植性優(yōu)于有效性。5.5 業(yè)務規(guī)則：列舉出有關產(chǎn)品的所有操作規(guī)則，例如什么人在特定環(huán)境下可以進行何種操作。這些本身不是功能需求，但它們可以暗示某些功能需求執(zhí)行這些規(guī)則。5.6 用戶文檔：列舉出將與軟件一同發(fā)行的用戶文檔部分，例如，用戶手冊、在線幫助和教程。明確所有已知的用戶文檔的交付格式或標準。6.其他需求：定義在軟件需求規(guī)格說明的其它部分未出現(xiàn)的需求，例如國際化需求或法律上的需求。你還可以增加有關操作、管理和維護部分來完善產(chǎn)品安裝、配置、啟動和關閉、修復和容錯，以及登錄和監(jiān)控操作等方面的需求。附錄A ：詞匯表定義所有必要的術語，以便讀者可以正確地解釋軟件需求規(guī)格說明，包括詞頭和縮寫。你可能希望為整個公司創(chuàng)建一張跨越多項項目的詞匯表，并且只包括特定于單一項目的軟件需求規(guī)格說明中的術語。附錄B ：分析模型這個可選部分包括或涉及到相關的分析模型的位置，例如數(shù)據(jù)流程圖、類圖、狀態(tài)轉換圖或實體-關系圖。附錄C ：待確定問題的列表編輯一張在軟件需求規(guī)格說明中待確定問題的列表，其中每一表項都是編上號的，以便于跟蹤調查。指明需求來源：指明需求的來源為了讓所有項目風險承擔者明白需求規(guī)格說明書中為何提供這些功能需求，要都能追溯每項需求的來源，這可能是一種使用實例或其它客戶要求，也可能是某項更高層系統(tǒng)需求、業(yè)務規(guī)范、政府法規(guī)、標準或別的外部來源。為每項需求注上標號：為了滿足軟件需求規(guī)格說明的可跟蹤性和可修改性的質量標準，必須唯一確定每個軟件需求。為每項需求注上標號制定一種慣例來為需求規(guī)格說明書中的每項需求提供一個獨立的可識別的標號或記號。這種慣例應當很健全，允許增加、刪除和修改。作了標號的需求使得需求能被跟蹤，記錄需求變更并為需求狀態(tài)和變更活動建立度量。需求標識方法有序列號;層次化編碼;使用待確定（to be determined, TBD ）符號等。記錄業(yè)務規(guī)范：是指關于產(chǎn)品的操作原則，比如誰能在什么情況下采取什么動作。將這些編寫成需