網(wǎng)站概要設(shè)計(jì)說明書模板

1、網(wǎng)站概要設(shè)計(jì)說明書(模板)1引言21.1編寫目的21.2背景21.3定義21.4參考資料32總體設(shè)計(jì)32.1需求規(guī)定32.2運(yùn)行環(huán)境42.3基本設(shè)計(jì)概念和處理流程42.4結(jié)構(gòu)42.5功能器求與程序的關(guān)系42.6人工處理過程42.7尚未問決的問題53接口設(shè)計(jì)53.1學(xué)生接口53.2外部接口53.3內(nèi)部接口54運(yùn)行設(shè)計(jì)54.1運(yùn)行模塊組合54.2運(yùn)行控制54.3運(yùn)行時間55系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)65.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)65.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)65.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系66系統(tǒng)出錯處理設(shè)計(jì)66.1出錯信息66.2補(bǔ)救措施66.3系統(tǒng)維護(hù)設(shè)計(jì)71引言本說明書為“XXXX網(wǎng)站系統(tǒng)”的概要設(shè)計(jì)說明書，概要闡述

2、了對學(xué)生所提出需求的設(shè)計(jì)方案，對系統(tǒng)中的各項(xiàng)功能需求、技術(shù)需求、實(shí)現(xiàn)環(huán)境及所使用的實(shí)現(xiàn)技術(shù)進(jìn)行了明確定義。同時，對軟件應(yīng)具有的功能和性能及其他有效性需求也進(jìn)行了定義。此外，本說明書還明確了系統(tǒng)的數(shù)據(jù)結(jié)構(gòu)和軟件結(jié)構(gòu)，還將給出內(nèi)部軟件和外部系統(tǒng)部件之間的接口定義，各個軟件模塊的功能說明，數(shù)據(jù)結(jié)構(gòu)的細(xì)節(jié)以及具體的裝配要求。1.1編寫目的l 編寫本說明書的目的是：1. 為編碼人員提供依據(jù)；2. 為修改、維護(hù)提供條件；3. 項(xiàng)目負(fù)責(zé)人將按計(jì)劃書的要求布置和控制開發(fā)工作全過程；4. 項(xiàng)目質(zhì)量保證組將按此計(jì)劃書做階段性和總結(jié)性的質(zhì)量驗(yàn)證和確認(rèn)。l 本說明書的預(yù)期讀者包括：1. 項(xiàng)目開發(fā)人員，特別是編碼人員；

3、2. 軟件維護(hù)人員；3. 技術(shù)管理人員；4. 執(zhí)行軟件質(zhì)量保證計(jì)劃的專門人員；5. 參與本項(xiàng)目開發(fā)進(jìn)程各階段驗(yàn)證、確認(rèn)以及負(fù)責(zé)為最后項(xiàng)目驗(yàn)收、鑒定提供相應(yīng)報告的有關(guān)人員；6. 合作各方有關(guān)部門的負(fù)責(zé)人；7. 項(xiàng)目組負(fù)責(zé)人和全體參加人員。1.2背景a. 項(xiàng)目名稱：XXXX網(wǎng)站系統(tǒng)項(xiàng)目 b. 系統(tǒng)名稱：XXXX網(wǎng)站系統(tǒng)c. 項(xiàng)目提出者：XXXXd. 系統(tǒng)學(xué)生：XXXX、XXXX、XXXX1.3定義總體設(shè)計(jì)：對有關(guān)系統(tǒng)全局問題的設(shè)計(jì)，也就是設(shè)計(jì)系統(tǒng)總的處理方案，又稱系統(tǒng)概要設(shè)計(jì)。它包括：計(jì)算機(jī)配置設(shè)計(jì)、系統(tǒng)模塊結(jié)構(gòu)設(shè)計(jì)、數(shù)據(jù)庫和文件設(shè)計(jì)、代碼設(shè)計(jì)以及系統(tǒng)可靠性與內(nèi)部控制設(shè)計(jì)等內(nèi)容。運(yùn)行設(shè)計(jì)：是針對建

4、筑或環(huán)境的特定要求，以活動發(fā)生地點(diǎn)的建筑或場地設(shè)計(jì)及現(xiàn)狀條件為基礎(chǔ)，對活動運(yùn)行期間的空間分配、人行和車輛流線及運(yùn)行所需的臨時設(shè)施進(jìn)行的妥善安排和布置。MySQL5.0:：MySQL名字的來歷MySQL是一個小型關(guān)系型數(shù)據(jù)庫管理系統(tǒng)，開發(fā)者為瑞典MySQLAB公司，在2008年1月16號被Sun公司收購。MySQL被廣泛地應(yīng)用在Internet上的中小型網(wǎng)站中。由于其體積小、速度快、總體擁有成本低，尤其是開放源碼這一特點(diǎn)，許多中小型網(wǎng)站為了降低網(wǎng)站總體擁有成本而選擇了MySQL作為網(wǎng)站數(shù)據(jù)庫。其中，5.0是其一個版本號。1.4參考資料1 XXXX.2 XXXX2總體設(shè)計(jì)2.1需求規(guī)定1. 輸入/

5、輸出（I/O）項(xiàng)目一覽表（參見表4.1）表4.1 I/O項(xiàng)目一覽表NO.項(xiàng)目名稱操作（I/O）類型備注1學(xué)生名I字符2密碼I字符3密碼確認(rèn)I字符4性別I字符5電話號碼I字符6電子郵箱I字符7住所I字符8郵編I字符2. 校驗(yàn)項(xiàng)目（參見表4.2）表4.2 校驗(yàn)項(xiàng)目NO.校驗(yàn)項(xiàng)目正常條件錯誤信息1學(xué)生名半角英文字母、數(shù)字、字符學(xué)生名類型錯誤2密碼半角英文字母、數(shù)字、字符密碼類型錯誤3電子郵箱半角英文字母、數(shù)字、字符、非法郵箱地址錯誤2.2運(yùn)行環(huán)境服務(wù)器：服務(wù)器配置（基本要求）：雙核CPU、內(nèi)存2G以上、硬盤80G網(wǎng)卡：10M/1000M Ethernet客戶機(jī)：CPU：Inter Pentium E

6、 2200或AMD Athlon 5000及以上內(nèi)存：512M以上硬盤：8G以上網(wǎng)卡：10M/1000M Ethernet外圍設(shè)備：打印機(jī) 掃描儀 繪圖儀通訊設(shè)備：傳真機(jī)操作系統(tǒng)： WINDOWS2000/2003 Server   IE4.0 SP1/NT SP4/2000/2003 SERVER SP4數(shù)據(jù)庫服務(wù)器： MySQL Server 5WEB服務(wù)器軟件：IIS6.0+客戶端： WINDOWS系統(tǒng)皆可2.3基本設(shè)計(jì)概念和處理流程學(xué)生行為流程：學(xué)生輸入用戶名和密碼用戶名、密碼是否正確進(jìn)入學(xué)生功能頁面是否選擇審核個人信息功能？進(jìn)入審核個人信息頁面是否選擇進(jìn)入成績查詢頁面是否選

7、擇選課管理功能是否選擇在線學(xué)習(xí)功能進(jìn)入選課查詢頁面進(jìn)入在線學(xué)習(xí)頁面退出系統(tǒng)NONONONOYESYESYESYES教師行為流程：教師輸入用戶名和密碼用戶名、密碼是否正確進(jìn)入教師功能頁面是否選擇個人信息管理功能？進(jìn)入個人信息管理頁面是否選擇信息發(fā)布功能？進(jìn)入信息發(fā)布頁面是否選擇網(wǎng)上答疑功能？是否選擇學(xué)生成績查看功能？進(jìn)入網(wǎng)上答疑頁面進(jìn)入學(xué)生成績查看頁面退出系統(tǒng)NONONONOYESYESYESYES管理員行為流程：管理員輸入用戶名和密碼用戶名、密碼是否正確進(jìn)入管理員功能頁面是否選擇個人信息管理功能？進(jìn)入個人信息管理頁面是否選擇個人信息管理功能？進(jìn)入個人信息管理頁面是否選擇課程安排功能？是否選擇新

8、聞發(fā)布功能？進(jìn)入課程安排頁面進(jìn)入新聞發(fā)布頁面退出系統(tǒng)NONONONOYESYESYESYES2.4結(jié)構(gòu)1. 學(xué)生子系統(tǒng)（參見表4.3）表 4.3 NO.模塊名稱 功能需求程序ID1個人信息模塊 創(chuàng)建個人基本信息修改個人基本信息查看個人基本信息StudentManage_*2成績查詢按照查詢條件進(jìn)行成績查詢StudentScore_*3學(xué)習(xí)資料共享在線下載學(xué)習(xí)資料Studing_*4學(xué)習(xí)管理與老師在線學(xué)習(xí)互動與同學(xué)在線討論學(xué)習(xí)給老師留言作業(yè)提交StudentStudy_*2. 教師子系統(tǒng)（參見表4.4）表4.4NO.模塊名稱 功能需求程序ID1個人信息模塊 創(chuàng)建個人基本信息修改個人基本信息查看個

9、人基本信息TeacherManage_*2學(xué)生信息查詢按照查詢條件進(jìn)行學(xué)生信息查詢TeacherSearch_*3教學(xué)安排在線答疑回復(fù)學(xué)生提問TeacherArrange_*4信息發(fā)布各種學(xué)習(xí)資料發(fā)布TeacherRelease_*3. 管理員子系統(tǒng)（參見表4.5）表4.5NO.模塊名稱 功能需求程序ID1學(xué)生信息管理添加學(xué)生信息刪除學(xué)生信息修改學(xué)生信息ManageStu_*2教師信息管理添加教師信息刪除教師信息修改教師信息ManageTea_*3課程安排任課老師授課安排學(xué)生課程安排ManageCourse_*4新聞發(fā)布各類學(xué)習(xí)活動信息發(fā)布各類參考書籍信息發(fā)布更新時事新聞發(fā)布NewPublis

10、h_*2.5功能器求與程序的關(guān)系本條用一張如下的矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系：程序功能需求個人信息程序課程安排程序新聞發(fā)布管理程序教學(xué)信息發(fā)布程序個人信息更新程序信息查詢個人信息管理（學(xué)生）課程安排（老師）新聞發(fā)布管理（管理員）教學(xué)資料上傳（教師）個人信息更新(教師、學(xué)生)信息查詢（學(xué)生）2.6人工處理過程1.創(chuàng)建學(xué)生（注冊新學(xué)生）：學(xué)生信息需要手工輸入計(jì)算機(jī)。2.學(xué)生登錄：學(xué)生登錄系統(tǒng)需要手工輸入學(xué)生名及密碼。2.7尚未問決的問題暫無；3接口設(shè)計(jì)3.1學(xué)生接口（1）進(jìn)入“XXXX網(wǎng)站系統(tǒng)”主頁面，學(xué)生輸入ID和密碼，只有輸入正確才能進(jìn)入系統(tǒng)。(2) 在做新建和更新類操作時

11、，只有輸入合法的內(nèi)容才能成功地編輯內(nèi)容。3.2外部接口說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。3.3內(nèi)部接口模塊間接口采用數(shù)據(jù)耦合方式，通過參數(shù)表傳送數(shù)據(jù)，交換信息。4運(yùn)行設(shè)計(jì)4.1運(yùn)行模塊組合XXXX網(wǎng)站系統(tǒng)的所有模塊在服務(wù)器啟動的時候完成所有模塊的加載工作，隨時等候?qū)W生的調(diào)用。包括：注冊、登陸、個人資料管理、課程、資料共享、管理學(xué)生教師課程新聞?wù)搲?.2運(yùn)行控制1、在頁面上，通過鼠標(biāo)點(diǎn)擊觸發(fā)相應(yīng)的操作。2、在頁面上，也可以通過Tab鍵、回車鍵等功能鍵完成某些特定的功能。說明每種運(yùn)行模塊組合將占用各種資源的時間。5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)5.1邏

12、輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)1教師表NO.字段名稱類型SizeNULL主鍵說明1tea_idCHAR101教師的ID2tea_nameCHAR20教師姓名3tea_pidCHAR504tea_sexualCHAR10性別5tea_nationCHAR50可以國籍6tea_birthdayDATETIME8可以生日7tea_office_addressCHAR50可以辦公室地址8tea_polityCHAR10可以政治面貌9tea_home_addressCHAR50可以家庭地址10tea_home_mailidCHAR10可以11tea_mobileCHAR50可以手機(jī)號12tea_home_phoneCH

13、AR50可以居住電話13tea_office_phoneCHAR50可以辦公電話14tea_mailCHAR50可以郵箱15tea_marriageINT4婚姻情況16tea_educationCHAR10可以教育等級17tea_postCHAR10可以崗位2學(xué)生表NO.字段名稱類型SizeNULL主鍵說明1stu_idCHAR101學(xué)生ID2stu_nameCHAR20姓名3stu_pidCHAR 504stu_sexualCHAR10性別5stu_nationCHAR20可以籍貫6stu_yearINT4可以出生年份7stu_birthdayDATETIME8可以生日時間8stu_clas

14、sCHAR10可以班級9stu_polityCHAR10可以政治面貌10stu_home_addressCHAR50可以家庭住址11stu_home_mailidCHAR10可以12stu_mobileCHAR50可以手機(jī)號13stu_home_phoneCHAR50可以家庭電話14stu_dorm_phoneCHAR50可以公寓電話15stu_ mailCHAR50可以郵箱16stu_ marriageINT4婚姻情況17Stu_mentor_companyCHAR20可以導(dǎo)師18stu_menter_schoolCHAR20可以學(xué)校導(dǎo)師19stu_intershipINT4實(shí)習(xí)情況20st

15、u_financeINT4經(jīng)濟(jì)情況21stu_majorCHAR50可以主修3課程信息表列名數(shù)據(jù)類型可否為空說明course_NoINT(4)NOT NULL課程編號(主鍵)course_NameCHAR(10)NULL課程名稱course_TypeCHAR(10)NULL課程類型course_DesCHAR(50)NULL課程描述5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)xxxx網(wǎng)站系統(tǒng)在mysql上是一個物理數(shù)據(jù)庫，命名為GRUSystem。系統(tǒng)的物理結(jié)構(gòu)具體有數(shù)據(jù)庫來設(shè)計(jì)與生成，此處略。5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系系統(tǒng)的數(shù)據(jù)結(jié)構(gòu)由標(biāo)準(zhǔn)數(shù)據(jù)庫語言SQL生成。具體的實(shí)例如創(chuàng)建系統(tǒng)學(xué)生表格ad_info的程序用SQL表示就是：CREATE TABLEdbo.ad_info(ad_idchar(10)COLLATE Chinese_PRC_CI_AS NOT NULL,ad_PWDchar(10)COLLATE Chinese_PRC_CI_AS NULL,as_Deschar(10)COLLATE Chinese_PRC_CI_AS NULL)ON PRIMARY6系統(tǒng)出