1、xxx項目概要設(shè)計說明書（ xxx模塊）擬制 評審人 批準 簽發(fā)yyyy-mm-dd概要設(shè)計說明書概要設(shè)計說明書第 第 頁 共 12 頁文檔修訂記錄版本完成人修改內(nèi)容審核批準時間V0.00創(chuàng)建文檔目錄簡介 5 TOC o 1-5 h z HYPERLINK l bookmark9 o Current Document 編寫目的 5 HYPERLINK l bookmark11 o Current Document 適用范圍 5 HYPERLINK l bookmark13 o Current Document 軟件名稱 5 HYPERLINK l bookmark15 o Current Do

2、cument 軟件功能 5 HYPERLINK l bookmark17 o Current Document 軟件應(yīng)用 5 HYPERLINK l bookmark19 o Current Document 定義及關(guān)鍵詞 5 HYPERLINK l bookmark21 o Current Document 參考資料 5 HYPERLINK l bookmark23 o Current Document 第 0 層設(shè)計描述 6 HYPERLINK l bookmark25 o Current Document 軟件系統(tǒng)上下文定義 6 HYPERLINK l bookmark27 o Curr

3、ent Document 設(shè)計思路（可選） 6 HYPERLINK l bookmark29 o Current Document 設(shè)計可選方案 6 HYPERLINK l bookmark31 o Current Document 設(shè)計約束 6 HYPERLINK l bookmark39 o Current Document 其他 6 HYPERLINK l bookmark41 o Current Document 系統(tǒng)結(jié)構(gòu) 6 HYPERLINK l bookmark43 o Current Document 系統(tǒng)結(jié)構(gòu)描述 6 HYPERLINK l bookmark45 o Curr

4、ent Document XXX模塊 6 HYPERLINK l bookmark51 o Current Document 第一層設(shè)計描述 8 HYPERLINK l bookmark53 o Current Document 模塊的系統(tǒng)結(jié)構(gòu) 8 HYPERLINK l bookmark55 o Current Document 模塊內(nèi)部結(jié)構(gòu) 8 HYPERLINK l bookmark57 o Current Document 業(yè)務(wù)流程說明 8 HYPERLINK l bookmark59 o Current Document 分解描述 8 HYPERLINK l bookmark61 o

5、 Current Document XXX子模塊 8 HYPERLINK l bookmark67 o Current Document 數(shù)據(jù)設(shè)計 8 HYPERLINK l bookmark71 o Current Document 依賴性描述 8 HYPERLINK l bookmark73 o Current Document 接口描述 9 HYPERLINK l bookmark75 o Current Document 子模塊 1 的接口描述 9 HYPERLINK l bookmark77 o Current Document 第二層設(shè)計描述 10 HYPERLINK l book

6、mark79 o Current Document XXX子模塊 10 HYPERLINK l bookmark81 o Current Document 子模塊設(shè)計描述 10 HYPERLINK l bookmark85 o Current Document 功能實現(xiàn)說明 10 HYPERLINK l bookmark89 o Current Document 數(shù)據(jù)庫設(shè)計 11 HYPERLINK l bookmark91 o Current Document 實體定義 11 HYPERLINK l bookmark93 o Current Document 分解描述 11 HYPERLIN

7、K l bookmark95 o Current Document 內(nèi)部依賴性描述 11 HYPERLINK l bookmark97 o Current Document 行為定義 11 HYPERLINK l bookmark99 o Current Document 分解描述 11 HYPERLINK l bookmark101 o Current Document 外部依賴性描述 11 HYPERLINK l bookmark103 o Current Document 內(nèi)部依賴性描述 11 HYPERLINK l bookmark105 o Current Document 組件視圖

8、 12 HYPERLINK l bookmark107 o Current Document 系統(tǒng)運行組件 12 HYPERLINK l bookmark109 o Current Document 文件組織形式 12 HYPERLINK l bookmark111 o Current Document 進程視圖 12表目錄表 1. 關(guān)鍵詞 5圖目錄軟件架構(gòu)圖 6軟件體系結(jié)構(gòu)圖 6基本包依賴關(guān)系圖 6與其它模塊關(guān)系圖 7模塊內(nèi)部結(jié)構(gòu)圖 8模塊結(jié)構(gòu)圖 10 HYPERLINK l bookmark83 o Current Document 類 XXX 10時序圖 10簡介編寫目的這部分要描述文檔

9、的目的，并指明文檔的讀者。適用范圍軟件名稱軟件功能解釋軟件產(chǎn)品將完成或不完成的功能軟件應(yīng)用描述軟件的應(yīng)用領(lǐng)域定義及關(guān)鍵詞表 1. 關(guān)鍵詞關(guān)鍵詞英文全名中文解釋參考資料1第 0 層設(shè)計描述軟件系統(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)圖設(shè)計思路（可選）設(shè)計可選方案對本軟件系統(tǒng)的幾種設(shè)計方案進行分析、比較，并確定所采用的方案。圖 2 軟件體系結(jié)構(gòu)圖設(shè)計約束遵循標準硬件限制技術(shù)限制其他系統(tǒng)結(jié)構(gòu)系統(tǒng)結(jié)構(gòu)描述這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)，可以使用結(jié)構(gòu)圖、層次分解圖或包圖來描述，并

10、應(yīng)說明系統(tǒng)結(jié)構(gòu)劃分的原則（例如，基于標準、協(xié)議所規(guī)定的體系結(jié)構(gòu)，來自于分析模型的方案，或者基于原有體系結(jié)構(gòu)的限制）。圖 3 基本包依賴關(guān)系圖XXX 模塊簡介這里要描述本文檔所設(shè)計的模塊，其功能簡介，與其它模塊的關(guān)系。與其它模塊關(guān)系圖圖4與其它模塊關(guān)系圖接口描述本文檔設(shè)計的模塊與其它模塊之間的接口。第一層設(shè)計描述模塊的系統(tǒng)結(jié)構(gòu)模塊內(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)的限制）。圖 5 模塊內(nèi)部結(jié)構(gòu)圖業(yè)務(wù)流程說明描述該模塊用例模型中的典型用例場景

11、，以體現(xiàn)其功能是如何實現(xiàn)的。建議采用Sequence 圖、Collaboration 圖等來描述。分解描述XXX 子模塊簡介功能列表數(shù)據(jù)設(shè)計本節(jié)描述本文檔所設(shè)計的模塊中的數(shù)據(jù)結(jié)構(gòu)，外部數(shù)據(jù)實體不必描述。數(shù)據(jù)實體1 描述標識：類型：目的：依賴性描述本節(jié)描述本文檔所設(shè)計的模塊的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進程等設(shè)計實體間的關(guān)系。依賴關(guān)系描述可以使用文字，結(jié)構(gòu)圖，（交互）事務(wù)圖。接口描述子模塊 1 的接口描述該子模塊與其它子模塊之間的接口描述。名稱：接口名稱說明：對接口的簡短說明定義：接口原型定義，說明接口類型及相關(guān)參數(shù)第二層設(shè)計描述XXX 子模塊子模塊設(shè)計描述描述子模塊的功能定義。定義出具體的設(shè)計類，

12、用類圖來描述其相互關(guān)系，并說明所采用的設(shè)計模式。圖 6 模塊結(jié)構(gòu)圖類名 XXX標識說明該類的配置項標識(用于需求跟蹤，配置項的命名方式在CMP 中已定義)簡介簡單介紹該類的功能類定義如果該類在前面沒有定義，使用類圖、偽代碼描述該類的類定義，需說明該類的所有public 屬性和 public 方法。圖 7 類 XXX功能實現(xiàn)說明XXX 功能圖 8 時序圖數(shù)據(jù)庫設(shè)計本節(jié)列出所有的數(shù)據(jù)存儲類的實體（表、存儲過程、觸發(fā)器等），詳細描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關(guān)系也要注明。實體定義分解描述闡述設(shè)計思路及約束規(guī)則。詳細定義每個關(guān)鍵數(shù)據(jù)表、視圖中的各個字段屬性、存儲要求、完整性約束、功能、注意事項，對靜態(tài)數(shù)據(jù)表應(yīng)考慮定義初始配置記錄。內(nèi)部依賴性描述使用 E-R 圖描述實體間的關(guān)聯(lián)依賴關(guān)系，分析對存取空間、性能、完整性的要求。行為定義分解描述根據(jù)功能或其他方式對存儲過程/觸發(fā)器進行歸類，便于進一步細化和分解，并說明每類存儲過程 /觸發(fā)器主要功能。詳細定義每個存儲過程（觸發(fā)器）的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù)表和存儲過程，以及一些特殊要求（比如需要啟用事務(wù)等）。外部依賴性描述描述與其它模塊之間的依賴關(guān)系。內(nèi)部依賴性描述描述存儲過程間、存儲過程和數(shù)據(jù)表/視圖間依賴關(guān)系。