詳細(xì)設(shè)計(jì)說(shuō)明書模板

1、文檔編號(hào)：記 錄 號(hào)：文檔版本：文檔密級(jí)：詳細(xì)設(shè)計(jì)說(shuō)明書詳細(xì)設(shè)計(jì)說(shuō)明書北京有限公司（年 1 月 1 日）詳細(xì)設(shè)計(jì)說(shuō)明書記錄號(hào)：記錄號(hào)：作者：作者：校對(duì)：校對(duì)：審核：審核：批準(zhǔn)：批準(zhǔn)：PPQA：起始日期：起始日期：年 月 日結(jié)束日期：結(jié)束日期：年 月 日修修訂訂歷歷史史記記錄錄日期日期版本版本狀態(tài)狀態(tài)說(shuō)明說(shuō)明作者作者年月日V1.0創(chuàng)建關(guān)于本文檔關(guān)于本文檔僅供內(nèi)部參考I目目錄錄1簡(jiǎn)介簡(jiǎn)介11.1目的 11.2背景 11.3定義、首字母縮寫詞和縮略語(yǔ) 11.4參考資料 12設(shè)計(jì)原則和約束設(shè)計(jì)原則和約束12.1假設(shè)、依賴和外部風(fēng)險(xiǎn) 12.2約束 12.3設(shè)計(jì)策略 22.4設(shè)計(jì)原則 22.5開發(fā)環(huán)境 2

2、2.5.1硬件環(huán)境22.5.2軟件環(huán)境23軟件結(jié)構(gòu)軟件結(jié)構(gòu)24模塊模塊 1（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明24.1模塊描述 24.2功能/方法24.3非功能性/性能24.4輸人項(xiàng) 24.5輸出項(xiàng) 34.6算法 34.7流程邏輯 34.8接口 34.9存儲(chǔ)分配 34.10注釋設(shè)計(jì) 34.11限制條件 34.12測(cè)試計(jì)劃 3僅供內(nèi)部參考II4.13尚未解決的問(wèn)題 35模塊模塊 2（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明3僅供內(nèi)部參考1詳細(xì)設(shè)計(jì)說(shuō)明書詳細(xì)設(shè)計(jì)說(shuō)明書1 簡(jiǎn)介簡(jiǎn)介軟件需求說(shuō)明書的編制是為了使用戶和軟件開發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解， 使之成為整個(gè)開發(fā)工作的基礎(chǔ)。編制軟件需求

3、說(shuō)明書的內(nèi)容要求如下：1.1 目的目的說(shuō)明編寫這份軟件需求說(shuō)明書的目的，指出預(yù)期的讀者。本節(jié)確定此軟件構(gòu)架文檔在整個(gè)項(xiàng)目文檔中的作用或目的，并對(duì)此文檔的結(jié)構(gòu)進(jìn)行簡(jiǎn)要說(shuō)明。應(yīng)確定此文檔的特定讀者，并指出他們應(yīng)該如何使用此文檔。1.2 背景背景 說(shuō)明： a 待開發(fā)的軟件系統(tǒng)的名稱；b本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)；C該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來(lái)往關(guān)系。1.3 定義、首字母縮寫詞和縮略語(yǔ)定義、首字母縮寫詞和縮略語(yǔ)本小節(jié)應(yīng)提供正確理解此軟件構(gòu)架文檔所需的全部術(shù)語(yǔ)的定義、首字母縮寫詞和縮略語(yǔ)。 這些信息可以通過(guò)引用項(xiàng)目詞匯表來(lái)提供。1.4 參考資料參考

4、資料列出用得著的參考資料，如：a本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他已發(fā)表的文件；c本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。 列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。2 設(shè)計(jì)原則和約束設(shè)計(jì)原則和約束2.1 假設(shè)、依賴和外部風(fēng)險(xiǎn)假設(shè)、依賴和外部風(fēng)險(xiǎn)提示：設(shè)計(jì)是否基于某種假設(shè)的前提條件。2.2 約束約束提示：（1）需求約束。體系結(jié)構(gòu)設(shè)計(jì)人員從需求文檔（如概要設(shè)計(jì)說(shuō)明書 ）中提取需求約束，例如：a.本系統(tǒng)應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)或規(guī)范b.軟件、硬件環(huán)境（包括運(yùn)行環(huán)境和開發(fā)環(huán)境）的約束c.接口/協(xié)議的約束d.用戶界面

5、的約束e.軟件質(zhì)量的約束，如正確性、健壯性、可靠性、效率（性能） 、易用性、清晰性、安全性、可僅供內(nèi)部參考2擴(kuò)展性、兼容性、可移植性等等。（2）隱含約束。有一些假設(shè)或依賴并沒(méi)有在需求文檔中明確指出，但可能會(huì)對(duì)系統(tǒng)設(shè)計(jì)產(chǎn)生影響，設(shè)計(jì)人員應(yīng)當(dāng)盡可能地在此處說(shuō)明。例如對(duì)用戶教育程度、計(jì)算機(jī)技能的一些假設(shè)或依賴，對(duì)支撐本系統(tǒng)的軟件硬件的假設(shè)或依賴等。2.3 設(shè)計(jì)原則設(shè)計(jì)原則要平衡地考慮功能需求、技術(shù)需求、風(fēng)險(xiǎn)與運(yùn)行環(huán)境、人員現(xiàn)狀等多種因素，選擇性價(jià)比最好的解決方案。2.4 設(shè)計(jì)策略設(shè)計(jì)策略提示：自底向上還是自頂向下，一步走還是分步到達(dá)2.5 開發(fā)環(huán)境開發(fā)環(huán)境簡(jiǎn)要地說(shuō)明對(duì)本系統(tǒng)的運(yùn)行環(huán)境（包括硬件環(huán)境和

6、支持環(huán)境）的規(guī)定，詳細(xì)說(shuō)明參見(jiàn)附錄C。2.5.1 硬件環(huán)境硬件環(huán)境說(shuō)明軟件運(yùn)行時(shí)的硬件環(huán)境，諸如：網(wǎng)絡(luò)、通信設(shè)備、服務(wù)器、終端、打印機(jī)等環(huán)境2.5.2 軟件環(huán)境軟件環(huán)境說(shuō)明軟件運(yùn)行時(shí)的軟件環(huán)境，諸如：操作系統(tǒng)、數(shù)據(jù)庫(kù)、服務(wù)、支持軟件等環(huán)境3 軟件結(jié)構(gòu)軟件結(jié)構(gòu)用一系列圖表列出本單元內(nèi)的每個(gè)模塊的名稱、標(biāo)識(shí)符和它們之間的層次結(jié)構(gòu)關(guān)系。4 模塊模塊 1（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明從本章開始，逐個(gè)地給出各個(gè)層次中的每個(gè)程序的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情況的。對(duì)于一個(gè)具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的內(nèi)容相同，在這種情況下，

7、只要簡(jiǎn)單地說(shuō)明這一點(diǎn)即可。注：如果是采用用例的描述方式，標(biāo)題可以改成“XX用例（標(biāo)識(shí)符） ” ，下面的章節(jié)可以按照：4.1 模塊描述模塊描述給出對(duì)該程序的簡(jiǎn)要描述，主要說(shuō)明安排設(shè)計(jì)本程序的目的意義，并且，還要說(shuō)明本程序的特點(diǎn)（如 是常駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無(wú)覆蓋要求？是順序處理還是并發(fā)處理等） 。4.2 功能功能/方法方法說(shuō)明該程序應(yīng)具有的功能/方法，可采用IPO圖（即輸入一處理一輸出圖）的形式。4.3 非功能性非功能性/性能性能說(shuō)明對(duì)該程序的全部性能要求，包括對(duì)有效性、效率、靈活性、完整性、安全性、互操作性、可靠性、鍵壯性、可用性、精度等方面的。4.4 輸

8、人項(xiàng)輸人項(xiàng)給出對(duì)每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等等。僅供內(nèi)部參考34.5 輸出項(xiàng)輸出項(xiàng)給出對(duì)每一個(gè)輸出項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)的說(shuō)明、安全保密條件等等。4.6 算法算法詳細(xì)說(shuō)明本程序所選用的算法，具體的計(jì)算公式和計(jì)算步驟。4.7 流程邏輯流程邏輯用圖表（例如流程圖、活動(dòng)圖、狀態(tài)圖等）輔以必要的說(shuō)明來(lái)表示本程序的邏輯流程。4.8 接口接口用圖的形式說(shuō)明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序，說(shuō)明參數(shù)賦值和調(diào)用方式，說(shuō)明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫(kù)、數(shù)據(jù)文卷） 。4.9 存儲(chǔ)分配存儲(chǔ)分配根據(jù)需要，說(shuō)明本程序的存儲(chǔ)分配。4.10 注釋設(shè)計(jì)注釋設(shè)計(jì)說(shuō)明準(zhǔn)備在本程序中安排的注釋，如：a. 加在模塊首部的注釋；b .加在各分枝點(diǎn)處的注釋；c. 對(duì)各變量的功能、范圍、缺省條件等所加的注釋；d. 對(duì)使用的邏輯所加的注釋等等。4.11 限制條件限制條件說(shuō)明本程序運(yùn)行中所受到的限制條件。4.12 測(cè)試測(cè)試設(shè)計(jì)設(shè)計(jì)說(shuō)明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃，包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)定。4.