軟件設(shè)計說明書范例

1、generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第1頁共16頁ktvsystem vi.o 詳細設(shè)計說明書ktvsystemgenerated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?200

2、7鹽城工學(xué)院星宇小組第2頁共16頁一、引 言 . 31.1.編寫目的 . 31.2.項目背景 . 31.3.備 注 . 3二、總體設(shè)計 . 41.4.需求概述 . 41-5. 軟件結(jié)構(gòu) . 416 系統(tǒng)模型 . 5三、程序描述 . 61.7.數(shù)據(jù)庫設(shè)計 . 61.8.客戶端模塊 . 61.9.服務(wù)器模塊 . 81.10.歌庫管理模塊 . 9四、改進計劃 . 101.11.程序界面 . 101.12.歌曲搜索 . 111.13.歌曲信息 . 111.14.外鬧軟件 . 111.15.改進說明 . 11五、運行環(huán)境 . 121.16 碩 件 . 121.17.支持軟件 . 12六、使用說明 . 1

3、31.18.安裝和初始化 . 131.19.出錯和恢復(fù) . 13七、程序文件 . 14八、版權(quán)說明 . 151.20.開發(fā)團隊 . 151.21.版權(quán)信息 . 151.22.免責(zé)條約 . 15九、結(jié)束語 . 16generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第3頁共16頁、 引 言1.1.編寫目的編寫詳細設(shè)計說明書是軟件開發(fā)過程必不可少的部分，其目的是為了使開發(fā)人員在完成

4、概耍設(shè)計說明書的壟礎(chǔ)上完成概耍設(shè)計觀經(jīng)的各項模塊的具體實現(xiàn)的設(shè)計工作。作為- 個參賽項目，詳細設(shè)計說明書同時乜是為了更好的讓評委老師了解項目開發(fā)的信息。另外，考慮到木軟件的非正式性以及時間關(guān)系，遂將用戶手冊中與詳細設(shè)計說明中的冗余內(nèi)容公除，續(xù)任詳細說明書之后。提供給用戶一個軟件使用說明。12項目背景軟件系統(tǒng)名稱：ktvsystem 軟件開發(fā)平臺 :microsoft visual basic 6.0 中文版、microsoft? sql server?2000、macromedia fii eworks 8 木項目的提出是按照學(xué)校程序大賽組委會的耍求，經(jīng)過小組成員的討論，結(jié)合暑期工作實踐而最終

5、決定的，該項目結(jié)合了網(wǎng)絡(luò)技術(shù)、多媒體技術(shù)、數(shù)據(jù)庫技術(shù)，采用了c/s的客戶機 / 服務(wù)器模式。ktv系統(tǒng)乂稱為vod點播系統(tǒng)，用于娛樂行業(yè)，囚此，有較好的市場前景與商業(yè)價值。該軟件運行f windows系統(tǒng)平臺。1.3. 備 注由丁?時間關(guān)系以及其它原因，本說明書中關(guān)丁?程序描述部分，不再對每一模塊進行詳細的分類說明，只進行大概的功能說明、操作、輸入輸出、程序邏輯等方面的說明。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsy

6、stem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第4頁共16頁二、總體設(shè)計1.4. 需求概述ktysystem能夠?qū)崿F(xiàn)客戶機端的視頻點播、播放列表的控制、視頻播放控制等功能; 服務(wù)器端能對歌庫進行添加、修改、刪除等操作，以及對客戶機的控制、保存播放列表、信息提示、火警提示、鎖定、關(guān)機等操作。ktysystem采用c/s的軟件體系結(jié)構(gòu)，服務(wù)器采windows/nt , sqlserver?？蛻舳瞬捎脀indows98/nt/2000o 1.5. 軟件結(jié)構(gòu)1?客八端( ktvclieiit) 2?服務(wù)端(ktvserver) 3?歌庫管理( ktvconfig)generated by foxi

7、t pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第5頁共16頁1? 6?系統(tǒng)模型當然在實際操作中，很多娛樂場所為了減少投入，會公掉冗余服務(wù)器和備份服務(wù)器，以及按客戶機數(shù)彊來采購交換機。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsyst

8、em詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第6頁共16頁三、程序扌苗述1.7. 數(shù)據(jù)庫設(shè)計1.數(shù)據(jù)庫概念結(jié)構(gòu)設(shè)計2.數(shù)據(jù)庫邏輯結(jié)構(gòu)設(shè)計歌曲信息表songs 列名數(shù)據(jù)類型是否為空說明idintnot null歌曲自動編號 ,五位數(shù)樂songcharnot null歌名singercharnull歌手ulltextnot null歌1111存放路徑，在此只存放文件名1.8. 客戶端模塊1. 程序界面generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktv

9、system ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第7頁共16頁2. 功能說明客戶端軟件采用兩個窗口分別對應(yīng)實際應(yīng)用中的客人控制端與電視播放端，采用獨立窗口方式設(shè)計也為以后軟件的升級，巫泄向視頻輸出流提供便利。ktvcontrol主耍是用控制ktvideo主耍是用丁 ?視頻的輸岀，模仿電視軟件丿1動后在ktrontrol左部datagrid小以adobe査詢數(shù)據(jù)庫為數(shù)據(jù)源，顯示出所有歌曲的編號、歌名、歌手等內(nèi)容。選擇歌曲列表中的任意一條記錄單擊軟件中部的“點播”按鈕可以將該刻錄添加到“已點”列表中并i動播放，“在播”和“下首”文本框也作相應(yīng)的改變。重復(fù)以上過程以添加更多

10、歌曲。選擇“已點”列表框中的一項后，“優(yōu)先”“刪除”按鈕激活，此時可以對點播的歌曲進行優(yōu)先播放及刪除操作。軟件最下而一行按鈕分別可以實現(xiàn)：播下播放列表中的下一首歌曲; 重新播 放當前播放的歌曲 ; 消除 / 恢復(fù)原聲 ; 暫停/ 全屏播放 ; 退出程序等功能。更新播放列表后，能 |動發(fā)送到服務(wù)器備份保存，萬一程序出錯非正常退出, 可以從服務(wù)器獲取列表，繼續(xù)播放。軟件啟動后能 |動向服務(wù)器發(fā)送連接信息，向服務(wù)器注冊，為接受服務(wù)器控制提供信息。4. 算法設(shè)計由丁? visual basic采用的事件驅(qū)動方式，程序過程都是處丁?控件響應(yīng)事件中, 并無特殊算法，大部份均為操作流，i大1此，算法方面不作

11、深入介紹。感謝使用kgenerated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第8頁共16頁在網(wǎng)絡(luò)連接方而，考慮到udp協(xié)議比tcp協(xié)議操作簡單，并且該系統(tǒng)對數(shù)據(jù)傳送要求不高，因此采用udp協(xié)議。程序啟動后進行接收消息循環(huán), 收到消息后根據(jù)消息類型進行相應(yīng)操作。1.9. 服務(wù)器模塊1. 程序界面2. 功能說明程序啟動使用udp協(xié)議建立網(wǎng)絡(luò)連接，進入消息循環(huán)，當收到類型為“信息”的消息

12、后，在本地列表中查找是否存在該客戶機，如果存在則更新本地信息, 如果不存在則在本地添加新客戶機 , 保存播放列表。選中列表中的任意工項后，可以激活最上方的按鈕，使用按鈕對客戶機進行管理（暫不支持全體操作）。使用上而的按鈕可以分別對客戶機進行：改變視頻上方字幕 ; 在視頻窗口彈出信息框; 火警提示 ; 鎖定、巫啟、關(guān)閉客戶機等操作。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇

13、小組第9頁共16頁1.10. 歌庫管理模塊1. 程序界而2.功能說明程序啟動，首先會在左部列表框中顯示出歌曲列表，選擇其中一項，該記錄會鬥動顯示在右邊上方的修改欄中，此時修改數(shù)據(jù)后點“修改”按鈕即可修改一條記錄。如果點“刪除”按鈕即可刪除一條記錄。點“清空”按鈕町以清除上方文本框中的內(nèi)容。在下方新增欄中輸入適當信息，點“添加”按鈕即可新增一條記錄，“淸空” 按鈕作用同上。點擊路徑文本框右邊的“ ”按鈕可以打開通用文件對話框，方便選擇歌曲文件。點擊“退出” , 退出管理。四、改進計劃1.11. 程序界面當前版本由丁 ?時間關(guān)系木作程序界面上的修飾，存在的界而不美觀， 上手難 , 不具親和力等問題

14、，這對丁 ?一款用丁 ?娛樂行業(yè)的商業(yè)軟件來說是一個非常嚴巫的問題。幸好，冃前vl.o版本是為了向大家演示本程序功能，對界面方面的耍求也就相對較低。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第10頁共16頁在后續(xù)版本中，有關(guān)因而方面，會采用多窗口輪換顯示，降低操作的復(fù)朵性; 每個窗口，底層采用圖冊i,在其上層添加透明的命令控件，來達到程序控制的目的，下圖為效果圖，是用

15、ve開發(fā)的信息管理系統(tǒng)， form窗體中使用一張圖片作為背最， 上面用image控件作按鈕，達到了目的。后續(xù)版本屮也將釆用類似的方式以增強美觀性。1? 12?歌曲搜索由丁?當前版本的數(shù)據(jù)結(jié)構(gòu)較為簡單，數(shù)據(jù)最亦比較少，所以未設(shè)置任何搜索功能，在后續(xù)版本中會加入如根據(jù)：歌名酋字母、歌手名首字母、筆劃、歌手所在地、歌手組合等一系列信息進行搜索，提高用戶的方便性。1.13. 歌曲信息目前的數(shù)據(jù)庫結(jié)構(gòu)較為簡單，造成了靈活性不夠，在后續(xù)版本中會增加其它數(shù)據(jù)表，如歌手信息等，這樣能提高程序的靈活性和可操作性。為搜索創(chuàng)造條件。generated by foxit pdf creator ? foxit sof

16、twarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第11頁共16頁1.14. 外圍軟件作為一款娛樂行業(yè)的軟件，那么其外由的如酒水點送系統(tǒng)、總臺結(jié)帳系統(tǒng)、倉庫管理系統(tǒng)等均需耍做全才能更好的打出市場。一款成熟的軟件不光是h 身做得的，他相應(yīng)的環(huán)境也耍做好才能占據(jù)更大的市場份額。1.15. 改進說明由丁?時間的限制，很多想法未能在程序中得以體現(xiàn)，如果可以的話，那么我們會將該想法延續(xù)到大四的畢業(yè)設(shè)訃屮來，用列靈沾的vc卄或c#進行開發(fā)一款功能完善， 忡?能穩(wěn)定，外形

17、美觀的商業(yè)軟件，完成畢業(yè)設(shè)計，再加上h前我們 現(xiàn)在客戶的資源，努力實現(xiàn)商業(yè)化運作。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第12頁共16頁五、運行環(huán)境1? 16?硬 件服務(wù)器p4以上,256m內(nèi)存以上，100m/1000m網(wǎng)卡工作站ciii 1g, 128m 內(nèi)存，tp_link 8 1 3 9 帶pxe 芯片網(wǎng)卡網(wǎng)絡(luò)連接服務(wù)器與t?作站苴接用網(wǎng)線相連接，按586a

18、、586b方式接線。?586a接法：橙白、橙、綠白、藍、藍白、綠、棕白、棕?586b接法：綠白、綠、橙白、藍、藍口、橙、棕口、棕1.17. 支持軟件服務(wù)器windows2000 或rer? 2000 工作站windows98 第二版generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第13頁共16頁六、使用說明1.18. 安裝和初始化1.安裝、配置windows2000 在服務(wù)

19、器上安裝好windows2000后，配置tcp/ip協(xié) 議中ip為,?作組為workgroup,計算機名為seiver,設(shè)置打印機與文件共享。安裝ktvserver、ktvconfig,將ktvserver.exe 快 捷方式加入啟動項。在其它分區(qū)中建立songs文件夾，將獲得的路徑以sen-erx：的形式修改config.iiii文件中的url項。安裝sql seiver 2000,將用戶名、密碼設(shè)為：sa、admin,導(dǎo)入位丁 ?database文件夾中的數(shù)據(jù)庫備份文件。使用ktronfig添加一條信息以供測試。2.安裝客戶機應(yīng)用軟件同樣安裝好系統(tǒng)后 , 配置tcp/

20、ip協(xié)議中ip為?55, 設(shè)置工作組為workgroup,計算機名為房間號。安裝ktvclient,將ktvclient.exe快捷方式加入啟動項。3.安裝調(diào)試運行服務(wù)器端ktvserver.exe,運行客戸機端ktvclient.exe看是否能警獲得播放列表，如不能則査看網(wǎng)絡(luò)以數(shù)據(jù)陽是否連接。點播視頻，如不能播放査看coiifig.ini | url的設(shè)置以及網(wǎng)絡(luò)共7是否良好。1? 19?出錯和恢復(fù)一燉情況下，如遇客戶端出錯，重啟客戶機即可，不影響服務(wù)器及其它客戶機的工作, 并且, 系統(tǒng)會自動保存客戶已點歌曲列表, 重啟后可自動從中斷處繼續(xù)播入。如

21、遇服務(wù)器出錯，重啟電腦，如不能解決，重裝服務(wù)器端程序即可，如遇其它網(wǎng)絡(luò)問題需自行解決。如遇數(shù)據(jù)出現(xiàn)問題，將數(shù)據(jù)庫備份文件雨新導(dǎo)入，注意，數(shù)據(jù)庫需經(jīng)常備份。?2007鹽城工學(xué)院星宇小組第14頁共16頁generated by foxit pdf creator ? foxit software http:/ for evaluation only.ktvsystemktvsystem詳細設(shè)計說明書七、程序文件當然這里我們必須說明的是發(fā)布版本和開發(fā)版本的目錄結(jié)構(gòu)是不- 樣的，開發(fā)版本屮的h錄更多，更復(fù)雜，因此這甲. 只介紹開發(fā)版本的h錄。+ktvsystem+bin編譯器編譯后的二進制文件以及動態(tài)

22、鏈接庫文件+pic圖片+docs文檔目錄+source源代碼目錄，分為ktvclient、ktvseivet、ktvconfigdatabase+songs+object數(shù)據(jù)庫備份歌曲文件發(fā)行版目錄，包抱安裝文件object冃錄為發(fā)行版冃錄，安裝時h接運行setup.exe即可，安裝完成后需修改相應(yīng)目錄下的config.iiii文件。generated by foxit pdf creator ? foxit softwarehttp:/www.foxitsoftware.coni for evaluation only.ktvsystem ktvsystem詳細設(shè)計說明書?2007鹽城工學(xué)院星宇小組第15頁共16頁八、版權(quán)說明1.20. 開發(fā)團隊鹽城工學(xué)院星宇小組：stars_625 （許鑫）、天痕（張奎）、浮云（徐寧）、_ 晴（杜瑜）。1? 21?版權(quán)信息版權(quán)所有?2007鹽城工學(xué)院星宇小組保留所有權(quán)力。ktvsystem由stars_625、天痕、浮云、 _啃 共同開發(fā) , 全部核心技術(shù)i丿i w