如何編寫高質(zhì)量軟件需求文檔

1、如何編寫高質(zhì)量“軟件需求說明書”你的工程應(yīng)該有個好的起點。一個小組要帶領(lǐng)客戶進(jìn)入需求啟發(fā)階段而且你要寫軟件需求說明書。這份說明有些大，但客戶會很重視，所以說明必須得到贊同?，F(xiàn)在你正在設(shè)計其中的一個特性，已經(jīng)發(fā)現(xiàn)了需求的一些問題。你可以用多種不同的方式解釋需求15；需求9的說明正好與需求21相反，你因該相信哪一個？需求24非常含糊，你根本不明白它的意思；你不得不花上一個小時與2位開發(fā)人員討論需求30，只因為你們對其各有各的理解；并且，唯一

2、能夠澄清這些問題的客戶沒有給你們答復(fù)。你被迫破解眾多需求的含義，并且你能預(yù)料到，如果你錯了，你要做大量的重復(fù)工作。許多軟件需求說明書（SRS）寫得非常糟糕。任何產(chǎn)品的質(zhì)量需要其原始材料的質(zhì)量保證，糟糕的軟件需求說明書不可能產(chǎn)出優(yōu)秀的軟件。不幸的是，幾乎沒有開發(fā)人員受過與需求的抽象、分析、文檔、質(zhì)檢有關(guān)的教育。而且，沒有非常多的好需求可以借鑒學(xué)習(xí)，部分原因是很少有工程可以找到一個好的借鑒，其他原因是公司不愿意將其產(chǎn)品說明書放在公共區(qū)域。這

3、篇文章描述了高質(zhì)量需求敘述和說明的幾個特性（特點）。我們將用這些觀點檢查一些有缺陷的需求，帶著痛楚重新編寫。而且我會談一些如何編寫好的需求的提示。你也許想通過這些質(zhì)量標(biāo)準(zhǔn)評估你的工程需求。對于修訂，也許遲了，但你會學(xué)到一些有用的東西，并幫助你的小組在下次編寫出更好的需求。不要期望能夠編寫出一份能體現(xiàn)需求應(yīng)具備的所有特性的SRS。無論你怎么細(xì)化、分析、評論和優(yōu)化需求，都不可能達(dá)到完美。但是，如果你牢記這些特性，你就會編寫出更好的需求，生產(chǎn)

4、出更好的產(chǎn)品。高質(zhì)量需求敘述的特性我們?nèi)绾螐囊恍┯袉栴}的需求中分辨出好的軟件需求？這一節(jié)將分別介紹需求敘述應(yīng)體現(xiàn)的6個特性，下一節(jié)將從整體上介紹SRS文檔應(yīng)具備的特性。判斷每個需求是否具備應(yīng)有的特性的一種方式是由持有不同觀點的工程資金管理人所作的正規(guī)檢查。另一種有力的方法是在編寫代碼前依據(jù)需求編寫測試?yán)?。測試?yán)幽軌蛎鞔_顯現(xiàn)在需求中描述的產(chǎn)品行為（特性），能夠顯現(xiàn)缺陷、冗余和含糊之處。正確：每個需求必須精確描述要交付的功能。正確性依據(jù)

5、于需求的來源，如真實的客戶或高級別的系統(tǒng)需求說明書。一個軟件需求與其對應(yīng)的系統(tǒng)需求說明書相抵觸是不正確判斷的事。需求之間不一致，不可行，不明確也能導(dǎo)致不可證實。任何需求如果說產(chǎn)品將要支持什么也是不可證實的。高質(zhì)量需求說明的特征一個完整的SRS不僅是包括長長的功能性需求列表，還包括外部接口描述和一些諸如質(zhì)量屬性，期望性能的非功能性需求。下面描述了高質(zhì)量的SRS的一些特性。完整：不應(yīng)該遺漏要求和必需的信息。完整性也是一個需求應(yīng)具備的。發(fā)現(xiàn)缺

6、少的信息很難，因為根本不存在。在SRS中將需求以分層目錄方式組織，將幫助評審人員理解功能性描述的結(jié)構(gòu)，使他們很容易指出遺失的東西。在需求抽象時，相對于系統(tǒng)功能，你過多的注意用戶的業(yè)務(wù)，將導(dǎo)致在需求的全局觀和引進(jìn)不是真正必需的需求上顯得不足。在需求抽象上，應(yīng)用用例方法會發(fā)揮很好的作用。能夠從不同角度察看需求的圖形分析模型也可以檢查出不完整性。如果你知道已缺少一些信息，使用TBD（tobedetermined）標(biāo)準(zhǔn)標(biāo)志可以突出這些缺陷，當(dāng)你

7、在構(gòu)建產(chǎn)品的相關(guān)部分時，就可以從一個給定的需求集中解決所有的缺陷。一致性：一致性需求就是不要于其他的軟件需求或高級別的系統(tǒng)（商業(yè)）需求發(fā)生沖突。需求中的不一致必須在開發(fā)開始前得到解決。只有經(jīng)過調(diào)研才能確定哪些是正確的。修改需求時一定要謹(jǐn)慎，如果只審定修改的部分，沒有審定于修改相關(guān)的部分，就可能導(dǎo)致不一致性?？尚薷男裕寒?dāng)每個需求的要求修改了或維護(hù)其歷史更改時，你必須能夠?qū)彾⊿RS。也就是說每個需求必須相對于其他需求有其單獨的標(biāo)示和分開的說

8、明，便于清晰的查閱。通過良好的組織可以使需求易于修改，如：將相關(guān)的需求分組，建立目錄表，索引，以及前后參考（照）?？勺粉櫍耗銘?yīng)能將一個軟件與其原始材料相對應(yīng)，如高級系統(tǒng)需求，用例，用戶的提議等。也能夠?qū)④浖枨笈c設(shè)計元素，源代碼，用于構(gòu)造實現(xiàn)和驗證需求的測試相對應(yīng)?？勺粉櫟男枨髴?yīng)該具有獨立標(biāo)示，細(xì)密和結(jié)構(gòu)化的編寫，不應(yīng)過大，不應(yīng)是敘述性的文字和公告式的列表。需求質(zhì)量的評審這些有關(guān)需求質(zhì)量的特性的描述在理論上都是非常好的，但一個好的需求到