軟件詳細(xì)設(shè)計文檔模板

1、.文檔編號版本密級研發(fā)生產(chǎn)中心項目名稱學(xué)生科技實踐綜合管理平臺項目來源課程項目Xxx 系統(tǒng)詳細(xì)設(shè)計說明書( 內(nèi)部資料請勿外傳 )編寫：邵文潮日 期：檢查：日 期：審核：日 期：批準(zhǔn)：日 期：版權(quán)所有不得復(fù)制.文檔變更記錄序號變更（ +/-）說明作者版本號日期批準(zhǔn)12.目錄1.引言.41.1編寫目的和范圍 .41.2術(shù)語表.41.3參考資料 .41.4使用的文字處理和繪圖工具 .52.全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 .52.1常量 .52.2變量 .52.3數(shù)據(jù)結(jié)構(gòu) .63.模塊設(shè)計 .73.1用例圖.73.2功能設(shè)計說明 .73.2.1模塊 1 .73.2.2模塊 2 .94.接口設(shè)計 .104.1內(nèi)部接口

2、 .104.2外部接口 .104.2.1接口說明 .104.2.2調(diào)用方式 .105.數(shù)據(jù)庫設(shè)計 .116.系統(tǒng)安全保密設(shè)計 .錯誤 ! 未定義書簽。6.1說明 .錯誤 ! 未定義書簽。6.2設(shè)計 .錯誤 ! 未定義書簽。6.2.1數(shù)據(jù)傳輸部分 .錯誤 ! 未定義書簽。6.2.2 IP 過濾分部 .錯誤 ! 未定義書簽。6.2.3身份驗證部分 .錯誤 ! 未定義書簽。7.系統(tǒng)性能設(shè)計 .128.系統(tǒng)出錯處理 .錯誤 ! 未定義書簽。.引言1.1 編寫目的和范圍本詳細(xì)設(shè)計說明書編寫的目的是說明程序模塊的設(shè)計考慮， 包括程序描述、輸入 / 輸出、算法和流程邏輯等，為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。 本

3、說明書的預(yù)期讀者為系統(tǒng)設(shè)計人員、軟件開發(fā)人員、軟件測試人員和項目評審人員。在顧客點(diǎn)菜時 ,為了能夠使得菜單更加直觀 ,更加人性化 ,改善傳統(tǒng)菜單古板 ,繁瑣的形式 ,從而設(shè)計了電子菜單 ;主要應(yīng)用于一些快餐店 ,特色餐館或者一些學(xué)校外個性的小餐館 .1.2 術(shù)語表序號術(shù)語或縮略語說明性定義1PMProject Manager, 項目經(jīng)理21.3 參考資料列出有關(guān)資料的名稱、作者、文件編號或版本等。參考資料包括：a需求說明書、架構(gòu)設(shè)計說明書等；b本項目的其他已發(fā)表的文件；c引用文件、資料、軟件開發(fā)標(biāo)準(zhǔn)等。資料名稱作者文件編號、版本資料存放地點(diǎn)80 例上手 Delphi 7程旭松，許哲平，1432

4、222渭水圖書館三編程萬重庫Delphi 6 數(shù)據(jù)庫系陳豫龍、何旭洪1004923渭水圖書館三統(tǒng)開發(fā)實例導(dǎo)航庫Delphi 程序設(shè)計周志德，張燕編1191914渭水圖書館三庫.1.4 使用的文字處理和繪圖工具文字處理軟件 :wps office個人版 , windows office 2007繪圖工具 :windowsofficevisio2007全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明1.5 常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。數(shù)據(jù)文件名所在目錄功能說明具體常量說明12345678桌面點(diǎn)菜實現(xiàn)對菜別的圖片顯示1.6 變量w1,w2,w3,w4,w5,w6,w7,w8,w9:Real;x011

5、,x021,x031,x041,x051,x061,x071,x081,x091,x101:Real;y1,y2,y3,y4,y5,y6,y7,y8,y9,y10:integer;a011,a021,a031,a041,a051,a061,a071,a081,a091,a101,a111,a121,a131,a141,a151,a161,a171,a181,a191,a201:real;b1,b2,b3,b4,b5,b6,b7,b8,b9,b10,b11,b12,b13,b14,b15,b16,b17,b18,b19,b20:integer;c011,c021,c031,c041,c051,c

6、061,c071,c081,c091,c101,c111,c121,c131,c141,c151,c161,c171,c181,c191,c201:real;d1,d2,d3,d4,d5,d6,d7,d8,d9,d10,d11,d12,d13,d14,d15,d16,d17,d18,d19,d20:integer;e011,e021,e031,e041,e051,e061,e071,e081,e091,e101,e111,e121,e131,e1.41,e151,e161,e171,e181,e191,e201:real;f1,f2,f3,f4,f5,f6,f7,f8,f9,f10,f11,f

7、12,f13,f14,f15,f16,f17,f18,f19,f20:integer;g011,g021,g031,g041,g051,g061,g071,g081,g091,g101,g111,g121,g131,g141,g151,g161,g171,g181,g191,g201:real;h1,h2,h3,h4,h5,h6,h7,h8,h9,h10,h11,h12,h13,h14,h15,h16,h17,h18,h19,h20:integer;i011,i021,i031,i041,i051,i061,i071,i081,i091,i101,i111,i121,i131,i141,i15

8、1,i161,i171,i181,i191,i201:real;j1,j2,j3,j4,j5,j6,j7,j8,j9,j10,j11,j12,j13,j14,j15,j16,j17,j18,j19,j20:integer;k011,k021,k031,k041,k051,k061,k071,k081,k091,k101,k111,k121,k131,k141,k151,k161,k171,k181,k191,k201:real;l1,l2,l3,l4,l5,l6,l7,l8,l9,l10,l11,l12,l13,l14,l15,l16,l17,l18,l19,l20:integer;m011,

9、m021,m031,m041,m051,m061,m071,m081,m091,m101,m111,m121,m131,m141,m151,m161,m171,m181,m191,m201:real; n1,n2,n3,n4,n5,n6,n7,n8,n9,n10,n11,n12,n13,n14,n15,n16,n17,n18,n19,n 20:integer;1.7 數(shù)據(jù)結(jié)構(gòu)名稱 :樹形數(shù)據(jù)結(jié)構(gòu).功能說明 :2. 模塊設(shè)計2.1 用例圖2.2 功能設(shè)計說明2.2.1 模塊 1主要分為兩個子模塊 :子模塊 1,子模塊 22.2.1.1 子模塊 12.2.1.1.1 設(shè)計圖2.2.1.1.2 功能

10、描述業(yè)務(wù)功能 :1 進(jìn)入點(diǎn)菜界面進(jìn)行點(diǎn)菜2.2.1.1.3 輸入數(shù)據(jù)觸屏或者鼠標(biāo) ,.當(dāng)進(jìn)入到點(diǎn)菜界面后 ,若用鼠標(biāo)則將鼠標(biāo)光標(biāo)移到欲選的類別上 ,然后點(diǎn)擊鼠標(biāo)左鍵即可進(jìn)入下一界面 ;若采用觸屏形式 ,則直接用手指點(diǎn)擊欲選類別對應(yīng)的屏幕位置即可 .2.2.1.1.4 輸出數(shù)據(jù)數(shù)據(jù)名稱 :特色菜 ,熱菜 ,涼菜 ,湯羹 ,酒水 ,甜點(diǎn)表現(xiàn)形式 :在點(diǎn)菜界面隨意分布 .2.2.1.1.5 業(yè)務(wù)算法和流程在該流程中采用了 label 組件 ,用來表示各種分類 ,當(dāng)鼠標(biāo)光標(biāo)移到某一分類上或者觸摸到某一分類 ,該組件起作用 ,即進(jìn)入該分類的具體描述界面 ,另一組件為 button 組件實現(xiàn)返回主界面操作

11、2.2.1.1.6 數(shù)據(jù)設(shè)計給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明， 包括數(shù)據(jù)結(jié)構(gòu)名稱， 功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲設(shè)計（具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項及屬性等。 ）該模塊下分為六個子模塊 ,分別用來表示不同的菜得類型 ,該模塊的文字描述沒有用到數(shù)據(jù)庫,只有圖片的引用 ,涉及到了數(shù)據(jù)庫的引用 .具體為 :2.2.1.1.7 源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。2.2.1.1.8 限制條件3.2.1.2 子模塊 23.2.1.2.1設(shè)計圖3.

12、2.1.2.2 功能描述實現(xiàn)結(jié)賬功能3.2.1.2.3 輸入數(shù)據(jù) :點(diǎn)菜結(jié)束后 ,返回到主界面 ,點(diǎn)擊結(jié)賬按鈕 ,進(jìn)入結(jié)賬界面后點(diǎn)擊顯示結(jié)果按鈕3.2.1.2.4 輸出數(shù)據(jù)數(shù)據(jù)名稱 :用戶點(diǎn)餐后的詳細(xì)結(jié)果 (菜名 ,價格 ,總賬單等 )表現(xiàn)形式 :按菜名 ,價格等的分類顯示在結(jié)果表格上.3.2.1.2.5 業(yè)務(wù)算法和流程結(jié)賬界面中有兩個 button 組件 ,其中一個是實現(xiàn)顯示結(jié)果 ,點(diǎn)擊后顯示用戶點(diǎn)菜詳細(xì)結(jié)果 ,另一個是實現(xiàn)返回功能 .3.2.1.2.6 數(shù)據(jù)設(shè)計.該模塊用來顯示點(diǎn)餐詳細(xì)結(jié)果,其中應(yīng)用的數(shù)據(jù)庫為3.2.1.2.7 源程序文件說明3.2.1.2.8 限制條件2.2.2 模塊 2

13、主要分為模塊 1,模塊 2,模塊 3,模塊 4,模塊 5,模塊 62.2.2.1 子模塊2.2.2.1.1 設(shè)計圖2.2.2.1.2 功能描述實現(xiàn)對各分類的具體顯示,包括名稱 ,價格等 .2.2.2.1.3 輸入數(shù)據(jù)點(diǎn)擊模塊 2 中個不同分類對應(yīng)名稱即可2.2.2.1.4 輸出數(shù)據(jù)子模塊 1 輸出:子模塊 2 輸出:子模塊 3 輸出:子模塊 4 輸出:子模塊 5 輸出:子模塊 6 輸出:2.2.2.1.5 業(yè)務(wù)算法和流程進(jìn)入各子模塊后 ,有若干 label 組件用來顯示菜名 ,點(diǎn)擊選中所選的菜 ,選擇結(jié)束后點(diǎn)擊返回按鈕 ,返回主界面 .2.2.2.1.6 數(shù)據(jù)設(shè)計給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明

14、， 包括數(shù)據(jù)結(jié)構(gòu)名稱， 功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲設(shè)計（具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲格式、數(shù)據(jù)項及屬性等。 ）每一子模塊均涉及若干若干文字說明,是對該子模塊的詳細(xì)介紹,其中的名稱顯示部分未用到數(shù)據(jù)庫 ,只是采用了固定的顯示方式,2.2.2.1.7 源程序文件說明給出本程序的各源程序文件的說明， 包括源程序文件名稱及其所在目錄， 功能說明，包含的前導(dǎo)文件及函數(shù)名稱等。.主界面：進(jìn)入分類的子目錄和最后結(jié)賬的窗口Unit2 ：菜的分類Unit3Unit10 ：各個分類的具體的菜的名稱以及點(diǎn)菜功能。前導(dǎo)文件為Unit2Unit11Unit170 ：各個菜的具體介紹以及菜的圖片。前導(dǎo)文件為Unit3Unit10Unit171 ：顯示已點(diǎn)菜的名稱，數(shù)量價格以及價錢的總計。前導(dǎo)文件為主界面。函數(shù)計算已點(diǎn)菜的所需價錢。2.2.2.1.8 函數(shù)說明具體說明本程序中的各個函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明，使用約束等。功能 :實現(xiàn)對顧客最終點(diǎn)菜結(jié)果數(shù)量,及最終賬單總額的計算.2.2.2.1.9 限制條件2.2.2.1.10 其他說明3. 接口設(shè)計3.1 內(nèi)部接口3.2 外部接口3.2.1 接口說明例如： xx 子系統(tǒng)通過 xx 從 xx 子系統(tǒng)取得 xx 等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例，