軟件概要設(shè)計說明書精品

1、xxx項目概要設(shè)計說明書yyyy-mm-dd（xxx模塊）擬制評審人批準簽發(fā)日期日期日期日期文檔修訂記錄版本完成人修改內(nèi)容審核批準時間v0.00創(chuàng)建文檔-可編輯修改-1. 簡介 61.1. 編寫目的 61.2. 適用范圍 61.2.1. 軟件名稱 61.2.2. 軟件功能 61.2.3. 軟件應(yīng)用 61.3. 定義及關(guān)鍵詞 61.4. 參考資料 72. 第 0 層設(shè)計描述 82.1. 軟件系統(tǒng)上下文定義 82.2. 設(shè)計思路（可選） 82.2.1. 設(shè)計可選方案 82.2.2. 設(shè)計約束 82.2.3. 其他 82.3. 系統(tǒng)結(jié)構(gòu) 92.3.1. 系統(tǒng)結(jié)構(gòu)描述 92.3.2. xxx 模塊 9

2、3. 第一層設(shè)計描述 103.1. 模塊的系統(tǒng)結(jié)構(gòu) 103.1.1. 模塊內(nèi)部結(jié)構(gòu) 103.1.2. 業(yè)務(wù)流程說明 103.2. 分解描述 103.2.1. xxx 子模塊 103.2.2. 數(shù)據(jù)設(shè)計 113.3. 依賴性描述 113.4. 接口描述 113.4.1. 子模塊 1 的接口描述 114. 第二層設(shè)計描述 124.1. xxx 子模塊 124.1.1. 子模塊設(shè)計描述 124.1.2. 功能實現(xiàn)說明 135. 數(shù)據(jù)庫設(shè)計 145.1. 實體定義 145.1.1. 分解描述 145.1.2. 內(nèi)部依賴性描述 145.2. 行為定義 145.2.1. 分解描述 145.2.2. 外部依

3、賴性描述 145.2.3. 內(nèi)部依賴性描述 156. 組件視圖 166.1. 系統(tǒng)運行組件 166.2. 文件組織形式 167. 進程視圖 16表目錄表 1. 關(guān)鍵詞 6目錄1 軟件架構(gòu) 82 軟件體系結(jié)構(gòu) 83 基本包依賴關(guān)系 94 與其它模塊關(guān)系 95 模塊內(nèi)部結(jié)構(gòu) 106 模塊結(jié)構(gòu) 127 類 xxx 138 時序 13-可編輯修改-1 .簡介1.1. 編寫目的這部分要描述文檔的目的，并指明文檔的讀者。1.2. 適用范圍1.2.1. 軟件名稱1.2.2. 軟件功能解釋軟件產(chǎn)品將完成或不完成的功能1.2.3. 軟件應(yīng)用描述軟件的應(yīng)用領(lǐng)域1.3. 定義及關(guān)鍵詞表1.關(guān)鍵詞關(guān)鍵詞英文全名中文解

4、釋-可編輯修改-1.4. 參考資料-可編輯修改-12. 第 0 層設(shè)計描述1.1. 軟件系統(tǒng)上下文定義本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實體的關(guān)系，可以使用系統(tǒng)結(jié)構(gòu)圖來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。外部實體屬性描述只限于描述與本系統(tǒng)軟件設(shè)計相關(guān)的屬性。圖 1 軟件架構(gòu)圖1.2. 設(shè)計思路（可選）1.2.1. 設(shè)計可選方案對本軟件系統(tǒng)的幾種設(shè)計方案進行分析、比較，并確定所采用的方案。圖 2 軟件體系結(jié)構(gòu)圖1.2.2. 設(shè)計約束1. 遵循標準2. 硬件限制3. 技術(shù)限制1.2.3. 其他-可編輯修改-2.3. 系統(tǒng)結(jié)構(gòu)-可編輯修改-2.3.1. 系統(tǒng)結(jié)構(gòu)描述這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分

5、解圖或包圖來描述，并應(yīng)說明系統(tǒng)結(jié)構(gòu)劃分的原則（例如，基于標準、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基于原有體系結(jié)構(gòu)的限制）。圖 3 基本包依賴關(guān)系圖2.3.2. xxx 模塊1. 簡介這里要描述本文檔所設(shè)計的模塊，其功能簡介，與其它模塊的關(guān)系。圖 4 與其它模塊關(guān)系圖2. 接口描述本文檔設(shè)計的模塊與其它模塊之間的接口。3. 第一層設(shè)計描述3.1. 模塊的系統(tǒng)結(jié)構(gòu)3.1.1. 模塊內(nèi)部結(jié)構(gòu)這里要描述本文檔所設(shè)計的模塊的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分解圖或包圖來描述，并應(yīng)說明結(jié)構(gòu)劃分的原則（例如，基于標準、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基于原有體系結(jié)構(gòu)的限制）。圖

6、5 模塊內(nèi)部結(jié)構(gòu)圖3.1.2. 業(yè)務(wù)流程說明描述該模塊用例模型中的典型用例場景， 以體現(xiàn)其功能是如何實現(xiàn)的。 建議采用 sequence 圖、 collaboration 圖等來描述。3.2. 分解描述3.2.1. xxx 子模塊1. 簡介2. 功能列表-可編輯修改-3.2.2. 數(shù)據(jù)設(shè)計本節(jié)描述本文檔所設(shè)計的模塊中的數(shù)據(jù)結(jié)構(gòu)，外部數(shù)據(jù)實體不必描述。1. 數(shù)據(jù)實體 1 描述1) 標識：2) 類型：3) 目的：3.3. 依賴性描述本節(jié)描述本文檔所設(shè)計的模塊的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進程等設(shè)計實體間的關(guān)系。依賴關(guān)系描述可以使用文字，結(jié)構(gòu)圖，(交互)事務(wù)圖。3.4. 接口描述3.4.1. 子模塊 1

7、 的接口描述該子模塊與其它子模塊之間的接口描述。名稱：接口名稱說明：對接口的簡短說明定義：接口原型定義，說明接口類型及相關(guān)參數(shù)-可編輯修改-4. 第二層設(shè)計描述4.1. xxx 子模塊4.1.1. 子模塊設(shè)計描述描述子模塊的功能定義。定義出具體的設(shè)計類，用類圖來描述其相互關(guān)系，并說明所采用的設(shè)計模式。圖 6 模塊結(jié)構(gòu)圖1. 類名 xxx1) 標識說明該類的配置項標識(用于需求跟蹤，配置項的命名方式在cmp 中已定義 )2) 簡介簡單介紹該類的功能3) 類定義如果該類在前面沒有定義，使用類圖、偽代碼描述該類的類定義，需說明該類的所有public 屬性和 public 方法。-可編輯修改-圖 7

8、類 xxx4.1.2. 功能實現(xiàn)說明1. xxx 功能圖 8 時序圖5. 數(shù)據(jù)庫設(shè)計本節(jié)列出所有的數(shù)據(jù)存儲類的實體（表、存儲過程、觸發(fā)器等） ，詳細描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關(guān)系也要注明。1.1. 實體定義1.1.1. 分解描述闡述設(shè)計思路及約束規(guī)則。詳細定義每個關(guān)鍵數(shù)據(jù)表、視圖中的各個字段屬性、存儲要求、完整性約束、功能、注意事項，對靜態(tài)數(shù)據(jù)表應(yīng)考慮定義初始配置記錄。1.1.2. 內(nèi)部依賴性描述使用 e-r 圖描述實體間的關(guān)聯(lián)依賴關(guān)系，分析對存取空間、性能、完整性的要求。1.2. 行為定義1.2.1. 分解描述根

9、據(jù)功能或其他方式對存儲過程/ 觸發(fā)器進行歸類，便于進一步細化和分解， 并說明每類存儲過程 /觸發(fā)器主要功能。詳細定義每個存儲過程（觸發(fā)器） 的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù)表和存儲過程，以及一些特殊要求（比如需要啟用事務(wù)等）。1.2.2. 外部依賴性描述描述與其它模塊之間的依賴關(guān)系。-可編輯修改-5.2.3. 內(nèi)部依賴性描述-可編輯修改-描述存儲過程間、存儲過程和數(shù)據(jù)表/視圖間依賴關(guān)系。6. 組件視圖6.1. 系統(tǒng)運行組件使用 component 圖、 deployment 圖來描述系統(tǒng)的運行組件（ exe 文件、 dll 等），及其網(wǎng)絡(luò)部署情況。6.2. 文件組織形式描述源代碼文件的目錄結(jié)構(gòu)（文件夾中各個目錄下應(yīng)存放什么文件）7.