(完整)軟件詳細(xì)設(shè)計(jì)文檔模板(最全面)

(完整)軟件詳細(xì)設(shè)計(jì)文檔模板(最全面)(完整)軟件詳細(xì)設(shè)計(jì)文檔模板(最全面)(完整)軟件詳細(xì)設(shè)計(jì)文檔模板(最全面)研發(fā)生產(chǎn)中心文檔編號版本A1密級商密A項(xiàng)目名稱Xx系統(tǒng)項(xiàng)目來源Xxx系統(tǒng)詳細(xì)設(shè)計(jì)說明書（內(nèi)部資料請勿外傳）編寫:劉玉龍日期：2018—2—10檢查：日期：審核：日期：批準(zhǔn)：日期：XX公司版權(quán)所有不得復(fù)制文檔變更記錄序號變更（+/—）說明作者版本號日期批準(zhǔn)12

目錄TOC\o”2—3”\f\h\z\t”標(biāo)題1，1”1.引言 4HYPERLINK”file：///C:\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc"\l”_Toc266115739#_Toc266115739"1.2術(shù)語表 4HYPERLINK”file：///C：\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc”1.3參考資料 4HYPERLINK”file：///C:\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc"1。4使用的文字處理和繪圖工具 4HYPERLINK”file:///C:\\Documents％20and％20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc”\l”_Toc266115742#_Toc266115742”2。全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明 5_Toc266115743＃_Toc266115743"2.1常量 5HYPERLINK”file:///C:\\Documents％20and％20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì).doc”\l”_Toc266115744＃_Toc266115744”2。2變量 5\l”_Toc266115745＃_Toc266115745”2。3數(shù)據(jù)結(jié)構(gòu) 53。1用例圖 53。2功能設(shè)計(jì)說明 5HYPERLINK”file：///C:\\Documents%20and％20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc"3.2.1模塊1 54。1內(nèi)部接口 7HYPERLINK”file:///C：\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc"\l”_Toc266115753#_Toc266115753”4.2外部接口 7_Toc266115754#_Toc266115754”4。2.1接口說明 7HYPERLINK”file:///C：\\Documents％20and％20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì).doc"4。2.2調(diào)用方式 8HYPERLINK”file:///C:\\Documents％20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì)。doc"\l”_Toc266115756#_Toc266115756”5.數(shù)據(jù)庫設(shè)計(jì) 8HYPERLINK”file：///C：\\Documents％20and％20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì).doc"6.2.1數(shù)據(jù)傳輸部分 8HYPERLINK”file：///C:\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì).doc”6。2.2IP過濾分部 8_Toc266115762#_Toc266115762”6。2。3身份驗(yàn)證部分 87。系統(tǒng)性能設(shè)計(jì) 9HYPERLINK”file：///C：\\Documents%20and%20Settings\\Administrator\\桌面\\詳細(xì)設(shè)計(jì).doc"\l”_Toc266115764#_Toc266115764"8.系統(tǒng)出錯(cuò)處理 9

引言背景在日常教學(xué)活動(dòng)中，為了檢驗(yàn)教學(xué)質(zhì)量，考察學(xué)生對于理論與實(shí)踐的掌握情況以及教學(xué)質(zhì)。根據(jù)學(xué)生所學(xué)學(xué)科生成考核試題檢測其學(xué)習(xí)效果和教師的教學(xué)質(zhì)量進(jìn)行量化考核而提出的綜合性的、全學(xué)科的、覆蓋大多數(shù)學(xué)科基礎(chǔ)教學(xué)內(nèi)容的課程管理系統(tǒng)。項(xiàng)目背景規(guī)劃如表1。1所示。項(xiàng)目名稱項(xiàng)目委托單位任務(wù)提出者項(xiàng)目承擔(dān)單位課程管理系統(tǒng)黃振華黃振華閆亮、劉玉龍、凌文表1.1項(xiàng)目背景規(guī)劃課程管理系統(tǒng)是教學(xué)過程階段性測評的一個(gè)重要組成部分，它需要學(xué)生信息系統(tǒng)提供學(xué)生的基本資料，包括姓名，學(xué)號，專業(yè)，班級等基礎(chǔ)信息；另外，它還需要題庫系統(tǒng)提供考核試題。編寫目的和范圍為了保證項(xiàng)目團(tuán)隊(duì)按時(shí)保質(zhì)地完成項(xiàng)目目標(biāo)，便于項(xiàng)目團(tuán)隊(duì)成員更好地了解項(xiàng)目情況，明確項(xiàng)目需求,使項(xiàng)目工作開展的各個(gè)過程合理有序，有必要以文件化的形式，把對于在需求分析的內(nèi)容以書面的方式描述出來，作為項(xiàng)目團(tuán)隊(duì)成員以及項(xiàng)目干系人之間的共識與約定，項(xiàng)目生命周期內(nèi)的所有項(xiàng)目活動(dòng)的行動(dòng)基礎(chǔ)，項(xiàng)目團(tuán)隊(duì)開展和檢查項(xiàng)目工作的依據(jù)。本項(xiàng)目需求規(guī)格說明書用于從總體上指導(dǎo)課程管理系統(tǒng)項(xiàng)目各個(gè)功能模塊開發(fā)順利進(jìn)行并最終得到通過評審的項(xiàng)目產(chǎn)品.本項(xiàng)目需求規(guī)格說明書面向項(xiàng)目組全體成員.術(shù)語表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語,為讀者在閱讀文檔時(shí)提供必要的參考信息。序號術(shù)語或縮略語說明性定義1PMProjectManager,項(xiàng)目經(jīng)理2參考資料文檔格式要求按照我國GB/T8567—1988國家標(biāo)準(zhǔn)和IEEE/ANSI830-1993標(biāo)準(zhǔn)規(guī)范要求進(jìn)行.包括以下文件：課程管理系統(tǒng)需求說明書軟件工程項(xiàng)目開發(fā)文檔范例軟件工程國家標(biāo)準(zhǔn)文檔軟件需求說明書編寫規(guī)范書籍包括：《軟件項(xiàng)目管理》朱少民，韓瑩編著人民郵電出版社《軟件項(xiàng)目管理》RajeevTShandilya編著科學(xué)出版社使用的文字處理和繪圖工具文字處理軟件:［編寫設(shè)計(jì)文檔使用的文字處理軟件，如RedOffice]繪圖工具：［使用的UML工具，如Rose、Jude、Visio]設(shè)計(jì)概述任務(wù)和目標(biāo)需求概述運(yùn)行環(huán)境概述條件與限制詳細(xì)設(shè)計(jì)方法和工具系統(tǒng)詳細(xì)需求分析主要對系統(tǒng)級的需求進(jìn)行分析.首先應(yīng)對需求分析提出的企業(yè)需求進(jìn)一步確認(rèn)，并對由于情況變化而帶來的需求變化進(jìn)行較為詳細(xì)的分析。詳細(xì)需求分析詳細(xì)功能需求分析詳細(xì)性能需求分析詳細(xì)資源需求分析詳細(xì)接口需求分析詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問題。系統(tǒng)總體結(jié)構(gòu)確認(rèn)對系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)行確認(rèn)，對應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實(shí)現(xiàn)的功能進(jìn)行確認(rèn)，細(xì)化集成設(shè)計(jì)及系統(tǒng)工作流程，特別要注意因軟件的引進(jìn)造成的系統(tǒng)本身結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變化。包括：系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認(rèn)應(yīng)用系統(tǒng)結(jié)構(gòu)確認(rèn)支撐系統(tǒng)結(jié)構(gòu)確認(rèn)系統(tǒng)集成確認(rèn)系統(tǒng)工作流程確認(rèn)系統(tǒng)詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式,網(wǎng)絡(luò)及數(shù)據(jù)庫對應(yīng)用系統(tǒng)的支撐方式，全局?jǐn)?shù)據(jù)的管理與存取方式等。系統(tǒng)內(nèi)部詳細(xì)界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍,模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法,全局?jǐn)?shù)據(jù)格式，系統(tǒng)性能要求等。全局?jǐn)?shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。常量包括數(shù)據(jù)文件名稱及其所在目錄，功能說明，具體常量說明等。變量本章說明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明(定義、注釋、取值）等。系統(tǒng)詳細(xì)設(shè)計(jì)功能結(jié)構(gòu)圖系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分對系統(tǒng)的組成及邏輯結(jié)構(gòu)進(jìn)行設(shè)計(jì)前確認(rèn)。劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有必要，特別是大型的軟件系統(tǒng)）.系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)按結(jié)構(gòu)化設(shè)計(jì)方法，在系統(tǒng)功能逐層分解的基礎(chǔ)上,對系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳細(xì)設(shè)計(jì)的主要部分之一。用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互，用IPO圖或其他方法描述各模塊完成的功能。以上建議采用HIPO圖進(jìn)行功能分解與模塊描述,更高的要求建議采用IDEF0方法進(jìn)行功能模型設(shè)計(jì).詳細(xì)設(shè)計(jì)應(yīng)用系統(tǒng)的各個(gè)構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系，以及需求、功能和模塊三者之間的交叉參照關(guān)系。每個(gè)模塊的描述說明可參照以下格式：模塊編號:模塊名稱:輸入:處理:算法描述：輸出：其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細(xì)設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì).如果對軟件需進(jìn)行二次開發(fā)（包括功能擴(kuò)展、功能改造、用戶界面改造等），則相應(yīng)的設(shè)計(jì)工作應(yīng)該設(shè)立子課題完成.系統(tǒng)界面詳細(xì)設(shè)計(jì)系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口.整個(gè)系統(tǒng)的其他接口(如系統(tǒng)硬件接口、通訊接口等)在相應(yīng)的部分說明。外部界面設(shè)計(jì)根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì),對系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進(jìn)行設(shè)計(jì)。內(nèi)部界面設(shè)計(jì)設(shè)計(jì)系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口。用戶界面設(shè)計(jì)規(guī)定人機(jī)界面的內(nèi)容、界面風(fēng)格、調(diào)用方式等,包括所謂的表單設(shè)計(jì)、報(bào)表設(shè)計(jì)和用戶需要的打印輸出等設(shè)計(jì)。此部分內(nèi)容可能比較多.開發(fā)和測試生產(chǎn)環(huán)境說明開發(fā)環(huán)境測試及產(chǎn)品環(huán)境-Developmentevnironment：programminglanuague，databaseVs2010—svn—iss6.1+—mysql/sqlserver2005/2008—.netframwork4。0

-Testing&productionenvironment：OS，database—。netframwork4.0Windwos2003，iis6。0，MySQL,模塊設(shè)計(jì)用例圖功能設(shè)計(jì)說明模塊1模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。子模塊1設(shè)計(jì)圖功能描述簡要描述子模塊1的業(yè)務(wù)功能。輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)(包括任何輸入設(shè)備)以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程.數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值)等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）源程序文件說明給出本程序的各源程序文件的說明,包括源程序文件名稱及其所在目錄，功能說明,包含的前導(dǎo)文件及函數(shù)名稱等。函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件,功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明,使用約束等。限制條件其他說明模塊2模塊1主要分為以下幾個(gè)子模塊：子模塊1、子模塊2和子模塊N。子模塊1設(shè)計(jì)圖功能描述簡要描述子模塊1的業(yè)務(wù)功能。輸入數(shù)據(jù)詳細(xì)描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗(yàn)規(guī)則。詳細(xì)描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。輸出數(shù)據(jù)詳細(xì)描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細(xì)描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程。數(shù)據(jù)設(shè)計(jì)給出本程序中的局部數(shù)據(jù)結(jié)構(gòu)說明，包括數(shù)據(jù)結(jié)構(gòu)名稱，功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋設(shè)計(jì)、取值）等。相關(guān)數(shù)據(jù)庫表，數(shù)據(jù)存儲(chǔ)設(shè)計(jì)（具體說明需要以文件方式保存的數(shù)據(jù)文件名、數(shù)據(jù)存儲(chǔ)格式、數(shù)據(jù)項(xiàng)及屬性等。）源程序文件說明給出本程序的各源程序文件的說明，包括源程序文件名稱及其所在目錄，功能說明,包含的前導(dǎo)文件及函數(shù)名稱等.函數(shù)說明具體說明本程序中的各個(gè)函數(shù)，包括函數(shù)名稱及其所在文件，功能，格式，參數(shù)，全局變量，局部變量，返回值，算法說明，使用約束等。限制條件其他說明接口設(shè)計(jì)內(nèi)部接口外部接口接口說明例如：xx子系統(tǒng)通過xx從xx子系統(tǒng)取得xx等，相關(guān)標(biāo)準(zhǔn)，調(diào)用示例，可根據(jù)需要增加章節(jié)描述接口。調(diào)用方式例如：內(nèi)部接口調(diào)用：例：/＊＊*通過用戶服務(wù)號碼取得該客戶認(rèn)證密碼等信息，如果該客戶存在返回為0,其他情況參考錯(cuò)誤編碼＊/publicRUserInfogetUserInfo（StringuserNo）;數(shù)據(jù)庫設(shè)計(jì)詳見[xxx數(shù)據(jù)庫設(shè)計(jì)說明書］如果數(shù)據(jù)庫設(shè)計(jì)內(nèi)容比較少，則直接在此處描述。系統(tǒng)安全保密設(shè)計(jì)說明例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問安全的問題。設(shè)計(jì)例如:分為數(shù)據(jù)傳輸部分，IP過濾部分,身份驗(yàn)證部分.［章節(jié)可補(bǔ)充］數(shù)據(jù)傳輸部分例如：在部分?jǐn)?shù)據(jù)傳遞的時(shí)候，考慮以https協(xié)議，需要在部署的時(shí)候作相關(guān)處理。IP過濾分部例如：可在系統(tǒng)前端通過Filter實(shí)現(xiàn)，該Filter實(shí)現(xiàn)對該地址訪問的IP過濾作用?？尚湃蜪P地址通過xml文件進(jìn)行配置。身份驗(yàn)證部分例如：對信任的用戶，頒發(fā)身份驗(yàn)證碼，通過該標(biāo)識進(jìn)行身份識別.系統(tǒng)性能設(shè)計(jì)系統(tǒng)出錯(cuò)處理例如：為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示，可采用兩種方式予以提示：1．使用Javascript的alert()函數(shù)直接提示，這主要在輸入或修改的情況下使用；2．使用統(tǒng)一的錯(cuò)誤界面提示，該界面對應(yīng)于errorpage。jsp頁面。錯(cuò)誤界面樣式如下圖所示:錯(cuò)誤提示界面設(shè)計(jì)和開發(fā)規(guī)范【可以列表方式列出設(shè)計(jì)開發(fā)的參考文檔的索引，內(nèi)容較少/關(guān)鍵內(nèi)容可以章節(jié)方式填寫】數(shù)據(jù)庫設(shè)計(jì)規(guī)范【參見《XXXX數(shù)據(jù)庫設(shè)計(jì)規(guī)范》】.NET編碼規(guī)范特別強(qiáng)調(diào)：詳細(xì)請參見《ASP.Net文檔規(guī)范》這里只做簡單闡述，如有變動(dòng)，會(huì)及時(shí)同事整個(gè)項(xiàng)目組相關(guān)人員。（1) 不要給類名加前綴.使用PascalCasing風(fēng)格，不使用匈牙利命名法。(2） 要用名詞詞組來給類型命名.使用PascalCasing風(fēng)格.（3） 類名少用縮寫,不要使用下劃線字符(_）。(4) 基類CBase的文件名為:FileBase.cs；（5） 泛型類命名：考慮用T來命名參數(shù)類型，類如：publicclassList〈T〉。(6） 接口（Interface）命名規(guī)范和類命名規(guī)范相同,唯一區(qū)別是接口在名字前加上“I"前綴。(7) 枚舉命名:以復(fù)數(shù)結(jié)尾，表明這是一個(gè)枚舉，例如：EnumColorButtons（8） 結(jié)構(gòu)命名：表明這是一個(gè)結(jié)構(gòu)體，例如：StructureCustomerInfoRecord’以Record結(jié)尾除使用工具直接生成的類外,其它所有類的功能要有注