軟件需求說明書編寫規(guī)范

文件號日期＜項目名稱＞軟件要求說明書作者：完成日期：簽收人員：驗收日期：修改情況記錄：版本號修改批準(zhǔn)人員修改人員安裝日期驗收人員

目錄TOC\o"1-4"1引言 11.1編寫目的 11.2范圍 11.3定義 11.4參考資料 12項目概述 22.1系統(tǒng)描述 22.2系統(tǒng)功能 22.3客戶特點 22.4一般約束 22.5假設(shè)和依據(jù) 33具體要求 33.1功能要求 33.1.1功能要求1 33.1.2功能要求2 43.1.n功能要求n 53.2外部接口要求 53.2.1客戶接口 53.2.2硬件接口 53.2.3軟件接口 53.2.4通信接口 63.3性能要求 63.4設(shè)計約束 63.4.1其他標(biāo)準(zhǔn)的約束 63.4.2硬件的限制 73.5屬性 73.5.1可用性 73.5.2安全性 73.5.3可維護性 73.5.4可轉(zhuǎn)移＼轉(zhuǎn)換性 83.5.5警告 83.6其他要求 83.6.1數(shù)據(jù)庫 83.6.2操作 83.6.3場合適應(yīng)性要求 94附錄 91引言1.1編寫目的說明編寫這份軟件要求說明書的目的，指出預(yù)期的讀者范圍。1.2范圍說明：待開發(fā)的軟件系統(tǒng)的名稱；說明軟件將干什么，如果需要的話，還要說明軟件系統(tǒng)不干什么；描述所說明的軟件的應(yīng)用。應(yīng)當(dāng)：盡可能精確地描述所有相關(guān)的利益、目的、以及最終目標(biāo)。如果有一個較高層次的說明存在，則應(yīng)該使其和高層次說明中的類似的陳述相一致（例如，系統(tǒng)的要求規(guī)格說明）。1.3定義列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組。1.4參考資料列出要用到的參考資料，如：本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同、上級機關(guān)的批文；屬于本項目的其他已發(fā)表的文件；本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2項目概述2.1系統(tǒng)描述敘述該項軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。解釋被開發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。如果本軟件系統(tǒng)是一項獨立的軟件，而且全部內(nèi)容自含，則說明這一點。如果所定義的系統(tǒng)是一個更大的系統(tǒng)的一個組成部分，則應(yīng)說明本系統(tǒng)與該系統(tǒng)中其他各組成部分之間的關(guān)系，為此可使用一張方框圖來說明該系統(tǒng)的組成和本系統(tǒng)同其他各部分的聯(lián)系和接口。2.2系統(tǒng)功能本條是為將要完成的軟件功能提供一個摘要。例如，對于一個記帳程序來說，要求說明可以用這部分來描述：客房帳目維護、客房財務(wù)報表和發(fā)票制作，而不必把功能所要求的大量的細節(jié)描寫出來。有時，如果存在較高層次的規(guī)格說明時，則功能摘要可從中取得，這個較高層次的規(guī)格說明為軟件系統(tǒng)分配了特殊的功能，為了清晰起見，請注意：編制功能的一種方法是制作功能表，以便客房或者第一次讀這個文件的人員都可以理解；用方框圖來表達不同的功能和它們的關(guān)系也是有幫助的。但應(yīng)牢記，這樣的圖不是系統(tǒng)設(shè)計時所要求的，而只是一種有效的解釋性的工具。2.3客戶特點列出本軟件的最終客戶的特點，充分說明操作人員員、維護人員員的教育水和技術(shù)專長，以及本軟件的預(yù)期使用頻度。這些是軟件設(shè)計工作的重要約束。2.4一般約束本條對設(shè)計系統(tǒng)時限制開發(fā)者選擇的其他一些項作一般性描述。而這些項將限定開發(fā)者在設(shè)計系統(tǒng)時的任選項。這些包括：管理方針；硬件的限制；與其他應(yīng)用間的接口；并行操作；審查功能；控制功能；所需的高級語言；通信協(xié)議；應(yīng)用的臨界點；安全和保密方面的考慮。2.5假設(shè)和依據(jù)本條列出影響要求說明中陳述的要求的每一個因素。這些因此不是軟件的設(shè)計約束，但是它們的改變可能影響到要求說明中的要求。例如：假定一個特定的操作系統(tǒng)是在被軟件系統(tǒng)指定的硬件上使用的，然而，事實上這個操作系統(tǒng)是不可能使用的，于是，要求說明就要進行相應(yīng)的改變。3具體要求3.1功能要求3.1.1功能要求1對于每一類功能或者有時對于每一個功能，需要具體描述其輸入、加工和輸出的要求。由四個部分組成：引言描述的是功能要達到的目標(biāo)、所彩的方法和技術(shù)，還應(yīng)清楚說明功能意圖的由來和背景。輸入詳細描述該功能的所有輸入數(shù)據(jù)，如：輸入源、數(shù)量、度量單位、時間設(shè)定、有效輸入范圍（包括精度和公差）；操作員控制細節(jié)的要求。其中有名字、操作員活動的描述、控制臺或操作員的位置。例如：當(dāng)打印檢查時，要求操作員進行格式調(diào)整；指明引用接口說明或接口控制文件的參考資料。加工定義輸入數(shù)據(jù)、中間參數(shù)，以獲得預(yù)期輸出結(jié)果的全部操作。它包括如下的說明：輸入數(shù)據(jù)的有效性檢查；操作的順序，包括事件的時間設(shè)定；響應(yīng)，例如，溢出、通信故障、錯誤處理等；受操作影響的參數(shù)；降級運行的要求；用于把系統(tǒng)輸入變換成相應(yīng)輸出的任何方法（方程式、數(shù)學(xué)算法、邏輯操作等）；輸出數(shù)據(jù)的有效性檢查。輸出詳細描述該功能所有輸出數(shù)據(jù)，例如：輸出目的地、數(shù)量、度量單位、時間關(guān)系、有效輸出的范圍（包括精度和公差）、非法值的處理、出錯信息；有關(guān)接口說明或接口控制文件的參考資料。此外，對著重于輸入輸出行為的系統(tǒng)來說，要求說明應(yīng)指定所有有意義的輸入、輸出對及其序列。當(dāng)一個系統(tǒng)要求記憶它的狀態(tài)時，需要這個序列，使得它可以根據(jù)本次輸入和以前的狀態(tài)作出響應(yīng)。也就是說，這種情況猶如有限狀態(tài)機。3.1.2功能要求2．．．．．．3.1.功能要求3.2外部接口要求3.2.1客戶接口提供客戶使用軟件系統(tǒng)時的接口要求。例如，如果系統(tǒng)的客戶通過顯示終端進行操作，就必須指定如下要求：對屏幕格式的要求；報表或菜單的頁面打印格式和內(nèi)容；輸入輸出的相對時間；程序功能鍵的可用性。3.2.2硬件接口要指出軟件系統(tǒng)和系統(tǒng)硬部件之間每一個接口的邏輯特點。還可能包括如下事宜：支撐什么樣的設(shè)備，如何支撐這些設(shè)備，有何約定。3.2.3軟件接口在此要指定需使用的其他軟件系統(tǒng)（例如，數(shù)據(jù)管理系統(tǒng)、操作系統(tǒng)或數(shù)學(xué)軟件包），以及同其他應(yīng)用系統(tǒng)之間的接口。對每一個所需的軟件系統(tǒng)，要提供如下內(nèi)容：名字；助記符；規(guī)格說明號；版本號；來源。對于每一個接口，這部分應(yīng)說明與軟件系統(tǒng)相關(guān)的接口軟件的目的，并根據(jù)信息的內(nèi)容和格式定義接口，但不必詳細描述任何已有完整文件的接口，只要引用定義該接口的文件即可。3.2.4通信接口指定各種通信接口。例如，部網(wǎng)絡(luò)的協(xié)議等等。3.3性能要求從整體來說，本條應(yīng)具體說明軟件、或人員與軟件交互的靜態(tài)或動態(tài)數(shù)值要求。靜態(tài)數(shù)值要求可能包括：支持的終端數(shù)；支持并行操作的客戶數(shù)；處理的文卷和記錄數(shù)；表和文卷的大小。動態(tài)數(shù)值要求可能包括：欲處理的事務(wù)和任務(wù)的數(shù)量，以及在正常情況下和峰值工作要求下一定時間周期中處理的數(shù)據(jù)總量。所有這些要求都必須用可以度量的術(shù)語來敘述。例如，95％的事務(wù)必須在小于1s時間內(nèi)處理完，不然，操作員將不等待處理的完成。3.4設(shè)計約束設(shè)計約束受其他標(biāo)準(zhǔn)、硬件限制等方面的影響。3.4.1其他標(biāo)準(zhǔn)的約束本項將指定由現(xiàn)有的標(biāo)準(zhǔn)或規(guī)則派生的要求。例如：報表格式；數(shù)據(jù)命名；財務(wù)處理；審計追蹤，等等。3.4.2硬件的限制本項包括在各種硬件約束下運行的軟件要求，例如，應(yīng)該包括：硬件配置的特點（接口數(shù)，指令系統(tǒng)等）；內(nèi)存儲器和輔助存儲器的容量。3.5屬性在軟件的要求之中有若干個屬性，以下指出其中的幾個（注意：對這些決不應(yīng)理解為是一個完整的清單）。3.5.1可用性可以指定一些因素，如檢查點、恢復(fù)和再啟動等，以保證整個系統(tǒng)有一個確定的可用性級別。3.5.2安全性指的是保護軟件的要素，以防止各種非法的訪問、使用、修改、破壞或者泄密。這個領(lǐng)域的具體要求必須包括：利用可靠的密碼技術(shù)；掌握特定的記錄或歷史數(shù)據(jù)集；給不同的模塊分配不同的功能；限定一個程序中某些區(qū)域的通信；計算臨界值的檢查和。3.5.3可維護性規(guī)定若干要求以確保軟件是可維護的。例如：軟件模塊所需要的特殊的耦合矩陣；為微型裝置指定特殊的數(shù)據(jù)＼程序分割要求。3.5.4可轉(zhuǎn)移＼轉(zhuǎn)換性規(guī)定把軟件從一種環(huán)境移植到另一種環(huán)境所要求的客戶程序，客戶接口兼容方面的約束等等。3.5.5警告指定所需屬性十分重要，它使得人員們能用規(guī)定的方法去進行客觀的驗證。3.6其他要求根據(jù)軟件和客戶組織的特性等，某些要求放在下面各項中描述。3.6.1數(shù)據(jù)庫本項對作為系統(tǒng)的一部分進行開發(fā)的數(shù)據(jù)庫規(guī)定一些要求，它們可能包括：在功能要求中標(biāo)識的信息類別；使用的頻率；存取能力；數(shù)據(jù)元素和文卷描述符；數(shù)據(jù)元素、記錄和文卷的關(guān)系；靜態(tài)和動態(tài)的組織；數(shù)據(jù)保存要求。注：如果使用一個現(xiàn)有的數(shù)據(jù)庫包，這個包應(yīng)在“軟件接口”中命名，并在那里詳細說明其用法。3.6.2操作這里說明客戶要求的常規(guī)的和特殊的操作。在客戶組織之中各種方式的操作。例如，客戶初始化操作；交互作用操作的周期和無人員操作的周期；數(shù)據(jù)處理運行功能；后援和恢復(fù)操作。注：這里的內(nèi)容有時是客戶接口的一部分。3.6.3場合適應(yīng)性要求這里包括：對給定場合或相關(guān)任務(wù)或操作方式的任何數(shù)據(jù)或初始化順序的要求進行定義。例如，柵值，安全界限等等。指出場合或相關(guān)任務(wù)為特點，這里可以被修改以使軟件適合特殊配制的要求