軟件概要設(shè)計(jì)說明書.doc

精品文檔xxx項(xiàng)目概要設(shè)計(jì)說明書（xxx模塊）擬制日期yyyy-mm-dd評(píng)審人日期批準(zhǔn)日期簽發(fā)日期文檔修訂記錄版本完成人修改內(nèi)容審核批準(zhǔn)時(shí)間V0.00創(chuàng)建文檔目 錄1. 簡介51.1. 編寫目的51.2. 適用范圍51.2.1. 軟件名稱51.2.2. 軟件功能51.2.3. 軟件應(yīng)用51.3. 定義及關(guān)鍵詞51.4. 參考資料52. 第0層設(shè)計(jì)描述62.1. 軟件系統(tǒng)上下文定義62.2. 設(shè)計(jì)思路(可選)62.2.1. 設(shè)計(jì)可選方案62.2.2. 設(shè)計(jì)約束62.2.3. 其他62.3. 系統(tǒng)結(jié)構(gòu)62.3.1. 系統(tǒng)結(jié)構(gòu)描述62.3.2. XXX模塊63. 第一層設(shè)計(jì)描述83.1. 模塊的系統(tǒng)結(jié)構(gòu)83.1.1. 模塊內(nèi)部結(jié)構(gòu)83.1.2. 業(yè)務(wù)流程說明83.2. 分解描述83.2.1. XXX子模塊83.2.2. 數(shù)據(jù)設(shè)計(jì)83.3. 依賴性描述83.4. 接口描述93.4.1. 子模塊1的接口描述94. 第二層設(shè)計(jì)描述104.1. XXX子模塊104.1.1. 子模塊設(shè)計(jì)描述104.1.2. 功能實(shí)現(xiàn)說明105. 數(shù)據(jù)庫設(shè)計(jì)115.1. 實(shí)體定義115.1.1. 分解描述115.1.2. 內(nèi)部依賴性描述115.2. 行為定義115.2.1. 分解描述115.2.2. 外部依賴性描述115.2.3. 內(nèi)部依賴性描述116. 組件視圖126.1. 系統(tǒng)運(yùn)行組件126.2. 文件組織形式127. 進(jìn)程視圖12表目錄表1.關(guān)鍵詞5圖目錄圖1軟件架構(gòu)圖6圖2軟件體系結(jié)構(gòu)圖6圖3基本包依賴關(guān)系圖6圖4與其它模塊關(guān)系圖7圖5模塊內(nèi)部結(jié)構(gòu)圖8圖6模塊結(jié)構(gòu)圖10圖7類XXX10圖8時(shí)序圖101. 簡介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)鍵詞英文全名中文解釋1.4. 參考資料12. 第0層設(shè)計(jì)描述2.1. 軟件系統(tǒng)上下文定義本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實(shí)體的關(guān)系，可以使用系統(tǒng)結(jié)構(gòu)圖來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。外部實(shí)體屬性描述只限于描述與本系統(tǒng)軟件設(shè)計(jì)相關(guān)的屬性。圖1 軟件架構(gòu)圖2.2. 設(shè)計(jì)思路(可選)2.2.1. 設(shè)計(jì)可選方案對(duì)本軟件系統(tǒng)的幾種設(shè)計(jì)方案進(jìn)行分析、比較，并確定所采用的方案。圖2 軟件體系結(jié)構(gòu)圖2.2.2. 設(shè)計(jì)約束1. 遵循標(biāo)準(zhǔn)2. 硬件限制3. 技術(shù)限制2.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)圖、層次分解圖或包圖來描述，并應(yīng)說明系統(tǒng)結(jié)構(gòu)劃分的原則（例如，基于標(biāo)準(zhǔn)、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基于原有體系結(jié)構(gòu)的限制）。圖3 基本包依賴關(guān)系圖2.3.2. XXX模塊1. 簡介這里要描述本文檔所設(shè)計(jì)的模塊，其功能簡介，與其它模塊的關(guān)系。圖4 與其它模塊關(guān)系圖2. 接口描述本文檔設(shè)計(jì)的模塊與其它模塊之間的接口。3. 第一層設(shè)計(jì)描述3.1. 模塊的系統(tǒng)結(jié)構(gòu)3.1.1. 模塊內(nèi)部結(jié)構(gòu)這里要描述本文檔所設(shè)計(jì)的模塊的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分解圖或包圖來描述，并應(yīng)說明結(jié)構(gòu)劃分的原則（例如，基于標(biāo)準(zhǔn)、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基于原有體系結(jié)構(gòu)的限制）。圖5 模塊內(nèi)部結(jié)構(gòu)圖3.1.2. 業(yè)務(wù)流程說明描述該模塊用例模型中的典型用例場(chǎng)景，以體現(xiàn)其功能是如何實(shí)現(xiàn)的。建議采用Sequence圖、Collaboration圖等來描述。3.2. 分解描述3.2.1. XXX子模塊1. 簡介 2. 功能列表3.2.2. 數(shù)據(jù)設(shè)計(jì)本節(jié)描述本文檔所設(shè)計(jì)的模塊中的數(shù)據(jù)結(jié)構(gòu)，外部數(shù)據(jù)實(shí)體不必描述。1. 數(shù)據(jù)實(shí)體1描述1) 標(biāo)識(shí)：2) 類型：3) 目的：3.3. 依賴性描述本節(jié)描述本文檔所設(shè)計(jì)的模塊的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進(jìn)程等設(shè)計(jì)實(shí)體間的關(guān)系。依賴關(guān)系描述可以使用文字，結(jié)構(gòu)圖，（交互）事務(wù)圖。3.4. 接口描述3.4.1. 子模塊1的接口描述該子模塊與其它子模塊之間的接口描述。名稱：接口名稱說明：對(duì)接口的簡短說明定義：接口原型定義，說明接口類型及相關(guān)參數(shù)4. 第二層設(shè)計(jì)描述4.1. XXX子模塊4.1.1. 子模塊設(shè)計(jì)描述描述子模塊的功能定義。定義出具體的設(shè)計(jì)類，用類圖來描述其相互關(guān)系，并說明所采用的設(shè)計(jì)模式。圖6 模塊結(jié)構(gòu)圖1. 類名XXX1) 標(biāo)識(shí)說明該類的配置項(xiàng)標(biāo)識(shí)(用于需求跟蹤，配置項(xiàng)的命名方式在CMP中已定義)2) 簡介簡單介紹該類的功能3) 類定義如果該類在前面沒有定義，使用類圖、偽代碼描述該類的類定義，需說明該類的所有public屬性和public方法。圖7 類XXX4.1.2. 功能實(shí)現(xiàn)說明1. XXX功能圖8 時(shí)序圖5. 數(shù)據(jù)庫設(shè)計(jì)本節(jié)列出所有的數(shù)據(jù)存儲(chǔ)類的實(shí)體(表、存儲(chǔ)過程、觸發(fā)器等)，詳細(xì)描述實(shí)體的內(nèi)容和并列出全部屬性。對(duì)每個(gè)屬性，詳細(xì)描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實(shí)體的所有約束及實(shí)體間的關(guān)系也要注明。5.1. 實(shí)體定義5.1.1. 分解描述闡述設(shè)計(jì)思路及約束規(guī)則。詳細(xì)定義每個(gè)關(guān)鍵數(shù)據(jù)表、視圖中的各個(gè)字段屬性、存儲(chǔ)要求、完整性約束、功能、注意事項(xiàng)，對(duì)靜態(tài)數(shù)據(jù)表應(yīng)考慮定義初始配置記錄。5.1.2. 內(nèi)部依賴性描述使用E-R圖描述實(shí)體間的關(guān)聯(lián)依賴關(guān)系，分析對(duì)存取空間、性能、完整性的要求。5.2. 行為定義5.2.1. 分解描述根據(jù)功能或其他方式對(duì)存儲(chǔ)過程/觸發(fā)器進(jìn)行歸類，便于進(jìn)一步細(xì)化和分解，并說明每類存儲(chǔ)過程/觸發(fā)器主要功能。詳細(xì)定義每個(gè)存儲(chǔ)過程(觸發(fā)器)的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù)表和存儲(chǔ)過程，以及一些特殊要求（比如需要啟用事務(wù)等）。5.2.2. 外部依賴性描述描述與其它模塊之間的依賴關(guān)系。5.2.3. 內(nèi)部依賴性描述描述存儲(chǔ)過程間、存儲(chǔ)過程和數(shù)據(jù)表/視圖間依賴關(guān)系。6. 組件視圖6.1. 系統(tǒng)運(yùn)行組件使用Component圖、deployment圖來描述系統(tǒng)的運(yùn)行組件（EXE文件、DLL等），及其網(wǎng)絡(luò)部署情況。6.2. 文件組織形式描述源代碼文件的目錄結(jié)構(gòu)（文件夾中各個(gè)目錄下應(yīng)存放什么文件）7. 進(jìn)程視圖本節(jié)描述將系統(tǒng)分解為輕量級(jí)進(jìn)