軟件工程-詳細(xì)設(shè)計說明書

1、版本號:文檔名稱:詳細(xì)設(shè)計說明書項目名稱:XXX項目負(fù)責(zé)人:XX編寫:XX校對:XX審核:XX批準(zhǔn):XX開發(fā)單位:XXXX軟件開發(fā)小組1. 引言1.1 編寫目的在項目小組(系統(tǒng)分析員提交了軟件概要設(shè)計說明書,并經(jīng)程序員與系統(tǒng)分析員充分討論和分析后,由程序員提出了這份軟件詳細(xì)設(shè)計說明書。此詳細(xì)設(shè)計說明書對XXX軟件的總體設(shè)計和各模塊的功能、性能、輸入輸出、算法、接口、程序邏輯、存儲分配及其它給出了詳細(xì)的設(shè)計方案,為軟件開發(fā)制定詳細(xì)的計劃,同時也提交系統(tǒng)分析員,由其提出意見。這是程序員進(jìn)行開發(fā)及未來測試的重要文檔資料。1.2 項目背景XXX軟件即提供對個人社會關(guān)系數(shù)據(jù)庫系統(tǒng)(Individual

2、Social Connection Database System的全面高效管理。委托單位:XXX開發(fā)單位:XXX主管部門:XXX1.3 參考資料1 XXX2 XXX3 XXX4 Tom.Steve, Borland Delphi DataBase Application Development Manual, Prentice-Hall, 1998.2. 總體設(shè)計2.1 需求概述本軟件主要提供七方面功能:1. 瀏覽功能列出所有記錄(每項記錄只列出姓名、單位及部門、辦公室電話域;可選定一項記錄,顯示所有域;2. 查詢功能姓名匹配查詢;單位及部門匹配查詢;電話號碼匹配查詢(包括多個域;3. 修改

3、功能修改所有的域,姓名不能為空;4. 增加功能增加一個新的記錄;刪除一個記錄,提供確認(rèn)機制;6. 打印功能選擇特定記錄(一個或多個打印報表;打印信封封面;7. 快捷功能以數(shù)字鍵表示特定記錄,使用戶只需按一個鍵即可得到所需記錄;2.2 軟件結(jié)構(gòu)軟件結(jié)構(gòu)圖如上所示。3. 程序描述功能:初始化系統(tǒng),使系統(tǒng)進(jìn)入正常工作狀態(tài)。輸入項目:配置文件,數(shù)據(jù)庫文件。輸出項目:設(shè)置全局變量,瀏覽區(qū)和基本資料區(qū)。程序邏輯:P1:檢查配置文件與數(shù)據(jù)庫是否正確(完整性和一致性。若是,轉(zhuǎn)P4;P2:根據(jù)錯誤情況產(chǎn)生消息窗口W7;P3:用戶確認(rèn)后退出程序運行;P4:由數(shù)據(jù)庫與配置文件設(shè)置全局變量17;P5:產(chǎn)生窗口W1,設(shè)

4、置各區(qū)域;P6:調(diào)用刷新瀏覽模塊M2 .2(arg:hot_record;P7:調(diào)用刷新基本資料模塊M3.2(arg:刷新;P8:進(jìn)入事件等待狀態(tài);存儲分配:程序運行需要占用內(nèi)存約1MB左右。測試要點:配置文件或數(shù)據(jù)庫文件損壞,或沒有足夠內(nèi)存可供使用時是否正常。功能:關(guān)閉并退出系統(tǒng),保留相應(yīng)狀態(tài)數(shù)據(jù)。輸入項目:全局變量。輸出項目:更新后的數(shù)據(jù)庫文件和配置文件。程序邏輯:P1:設(shè)置數(shù)據(jù)庫和配置文件;P2:釋放系統(tǒng)資源并退出系統(tǒng);測試要點:若數(shù)據(jù)庫文件或配置文件不能正常操作,或全局?jǐn)?shù)據(jù)已經(jīng)不一致,怎樣處理。功能:維護(hù)窗口中瀏覽區(qū)中信息的更改和刷新。性能:這是經(jīng)常使用的一個模塊,對性能要求在12秒內(nèi)

5、作出反應(yīng)。輸入項目:鼠標(biāo)或鍵盤事件。輸出項目:重新設(shè)置的瀏覽區(qū)中信息程序邏輯:P1:若事件不是鼠標(biāo)單擊,轉(zhuǎn)P4;P2:恢復(fù)hot_record正常顯示,設(shè)置新的hot_record并突出顯示之;P3:調(diào)用刷新基本資料模塊M 3.2(arg:更換,轉(zhuǎn)P13;P4:若事件不是鼠標(biāo)雙擊或回車,轉(zhuǎn)P10;P5:調(diào)用詳細(xì)資料模塊M5;P6:若返回“修改”,調(diào)用修改模塊M4.3;P7:若返回“刪除”,調(diào)用刪除模塊M4.5;P8:若返回“打印”,調(diào)用打印模塊M4.6;P9:轉(zhuǎn)P13;P10:若事件不是上下方向鍵、pageup/pagedown或點擊滾動欄,轉(zhuǎn)P13;P11:恢復(fù)hot_record正常顯示,

6、設(shè)置新的hot_record并突出顯示之;P12:延遲1秒,此間若無其它事件改變hot_record則調(diào)用刷新基本資料模塊M3.2(arg:更換,否則不調(diào)用;P13:進(jìn)入事件等待狀態(tài);測試要點:對各事件進(jìn)行測試。功能:利用全局變量中的信息重新刷新瀏覽區(qū)。輸入項目:將要設(shè)置成熱點記錄的記錄號:new_record。輸出項目:設(shè)置瀏覽區(qū)。程序邏輯:P1:恢復(fù)hot_record 正常顯示,設(shè)置hot_record =new_record;P2:由全局變量1、2、6設(shè)置瀏覽區(qū);P3:突出顯示hot_record ,返回;測試要點:對有效和無效的輸入記錄號盡心測試。功能:維護(hù)窗口中基本資料區(qū)中信息的更

7、改和刷新。性能:這是經(jīng)常使用的一個模塊,對性能要求在12秒內(nèi)作出反應(yīng)。輸入項目:鼠標(biāo)或鍵盤事件。輸出項目:重新設(shè)置的基本資料區(qū)中信息程序邏輯:P1:由接收到的事件更改備注,令備注更改標(biāo)志= true;P2:進(jìn)入等待事件狀態(tài);測試要點:對各事件進(jìn)行測試。功能:利用全局變量中的信息重新刷新基本資料區(qū)。輸入項目:對原來記錄中memo域的處理方式(更新、刷新。輸出項目:設(shè)置瀏覽區(qū)和數(shù)據(jù)庫。程序邏輯:P1:若arg為刷新,則轉(zhuǎn)到P3;P2:由備注更改標(biāo)志決定是否實施保存當(dāng)前記錄的備注至數(shù)據(jù)庫;P3:令當(dāng)前記錄=hot_record ,備注更改標(biāo)志=false;P4:由當(dāng)前記錄變量從數(shù)據(jù)庫中取出詳細(xì)數(shù)據(jù);

8、P5:按照:姓名,單位及部門,電話(辦公室,手機,尋呼,宅電,傳真,E-Mail的順序列出前五個不空的域,同時列出備注域;P6:調(diào)用設(shè)置快捷選擇模塊M6.2,返回;3.7 系統(tǒng)功能模塊(M功能:選擇各種系統(tǒng)功能輸入項目:鼠標(biāo)或鍵盤事件。程序邏輯:P1:若事件為查詢,調(diào)用查詢模塊M4.2,轉(zhuǎn)P8;P2:若事件為修改,調(diào)用修改模塊M4.3,轉(zhuǎn)P8;P3:若事件為增加,調(diào)用增加模塊M4.4,轉(zhuǎn)P8;P4:若事件為刪除,調(diào)用刪除模塊M4.5,轉(zhuǎn)P8;P5:若事件為打印,調(diào)用打印模塊M4.6,轉(zhuǎn)P8;P6:若事件為最小化,執(zhí)行Windows缺省操作,轉(zhuǎn)P8;P7:若事件為關(guān)閉,調(diào)用關(guān)閉系統(tǒng)模塊M1.2;

9、P8:進(jìn)入事件等待狀態(tài);3.8 查詢模塊(M功能:完成查詢功能。性能:響應(yīng)時間控制在12秒內(nèi)。輸入項目:無。輸出項目:無。程序邏輯:P1:產(chǎn)生窗口W2;P2:若用戶取消,則返回;P3:(用戶確認(rèn)按用戶選擇查詢方式及關(guān)鍵字提交數(shù)據(jù)庫查詢,獲得查詢結(jié)果(記錄的index號;P4:產(chǎn)生窗口W9,Message:查詢結(jié)果項數(shù),并等待用戶確認(rèn);P5:若查詢結(jié)果項數(shù)等于零,返回;P6:利用查詢結(jié)果設(shè)置全局變量2;P7:調(diào)用刷新瀏覽模塊M2.2(arg:0;P8:調(diào)用刷新基本資料模塊M3.2(arg:刷新;測試要點:測試各種查詢方式。3.9 修改模塊(M功能:完成修改功能。輸入項目:熱點記錄號。輸出項目:設(shè)

10、置數(shù)據(jù)庫和全局變量。程序邏輯:P1:調(diào)用刷新基本資料模塊M3.2(arg:更換;P2:產(chǎn)生窗口W3;P3:由全局變量從數(shù)據(jù)庫中取出數(shù)據(jù)hot_record,并顯示;P4:等待用戶輸入;P5:若取消,則返回;P6:若復(fù)原,則轉(zhuǎn)到P3;P7:(確定進(jìn)一步判斷姓名域是否為空;P8:若為空,產(chǎn)生窗口W7,Message:姓名域不能為空,轉(zhuǎn)到P4;P9:若不為空,保存數(shù)據(jù)至數(shù)據(jù)庫,更新全局變量6;P10:調(diào)用刷新瀏覽模塊M2.2(arg:hot_record;P11:調(diào)用刷新基本資料模塊M3.2(arg:刷新,返回;3.10 增加模塊(M功能:完成增加功能。輸出項目:無。程序邏輯:P1:產(chǎn)生窗口W3;P

11、2:等待用戶輸入各項信息;P3:若用戶取消,則返回;P4:(確定,判斷姓名域是否為空;P5:若為空,產(chǎn)生窗口W7,Messge:姓名域不能為空,轉(zhuǎn)到P2;P6:(不空,設(shè)置全局變量1、2、6、7;P7:保存記錄至數(shù)據(jù)庫;P8:調(diào)用刷新瀏覽模塊M2.2(arg:增加記錄對應(yīng)之record_buf id; P9:調(diào)用刷新基本資料模塊M3.2(arg:更換,返回;3.11 刪除模塊(M功能:完成刪除功能。輸入項目:無。輸出項目:無。程序邏輯:P1:由全局變量3、6產(chǎn)生窗口W5;P2:若取消,則返回;P3:(確定,調(diào)用刪除快捷模塊M6.3;P4:從數(shù)據(jù)庫中刪除hot_record記錄;P5:設(shè)置全局變

12、量1、2、6P6:調(diào)用刷新瀏覽模塊M2.2(arg:hot_record - 1;P7:調(diào)用刷新基本資料模塊M3.2(arg:刷新,返回;3.12 打印模塊(M功能:完成打印功能。輸入項目:無。輸出項目:無。程序邏輯:P1:由全局變量產(chǎn)生窗口W6;P2:若取消,則返回;P3:(確定,完成打印任務(wù),返回;3.13 詳細(xì)資料模塊(M5功能:顯示記錄的詳細(xì)資料。輸入項目:熱點記錄號。輸出項目:下一步將要執(zhí)行的功能號(“確定”、“修改”、“刪除”、“打印”。程序邏輯:P1:由全局變量3、6從數(shù)據(jù)庫取出詳細(xì)數(shù)據(jù);P2:產(chǎn)生窗口W8,顯示相關(guān)信息;P3:根據(jù)用戶操作,返回相應(yīng)值;功能:利用快捷鍵事件調(diào)整瀏

13、覽區(qū)和基本資料區(qū)。輸入項目:鼠標(biāo)或鍵盤事件。輸出項目:設(shè)置全局變量、瀏覽區(qū)和基本資料區(qū)。程序邏輯： P1： 若事件為 ctrl-num，調(diào)用刪除快捷選擇模塊 M6.3（arg：short_keynum） ，轉(zhuǎn)到 P8； P2： 若事件為 shift-num，切換 short_keynum的上鎖狀態(tài)，轉(zhuǎn)到 P8； P3： 若事件為 alt-num，判斷 short_keynum是否為空； P4： 若空，響一聲警告，轉(zhuǎn)到 P8； P5： 不空，若 num 對快捷方式為動態(tài)，設(shè)置其在 FIFO 鏈中相應(yīng)位置； P6： 調(diào)用刷新瀏覽模塊 M2.2（arg：short_keynum） ； P7： 調(diào)用刷新基本資料模塊 M3.2（arg：更換） ； P8： 進(jìn)入事件等待狀態(tài)； 測試要點：測試各事件。 3.15 設(shè)置快捷選擇模塊（M6.2） 功能：設(shè)置當(dāng)前記錄為快捷記錄。 輸入項目：相應(yīng) record_buf 的 id：r_id。 輸出項目：設(shè)置快捷記錄