軟件詳細設(shè)計文檔模板(最全面)-詳細設(shè)計文檔

創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日研發(fā)生產(chǎn)中心之老陽二干創(chuàng)作版本A1密級商密A創(chuàng)作時間文檔編號項目名稱Xx系統(tǒng)項目來源Xxx系統(tǒng)詳細設(shè)計說明書（內(nèi)部資料請勿外傳）編寫：日期:檢杳：日期:審核：日期:批準：日期:XX公司版權(quán)所有不得復制文檔變動記錄引言4編寫目的和范圍4術(shù)語表4參考資料4使用的文字處置和繪圖工具4全局數(shù)據(jù)結(jié)構(gòu)說明5常量5變量5數(shù)據(jù)結(jié)構(gòu)5模塊設(shè)計5用例圖5功能設(shè)計說明5模塊15模塊26接口設(shè)計7內(nèi)部接口7外部接口7接口說明7調(diào)用方式8數(shù)據(jù)庫設(shè)計8系統(tǒng)平安保密設(shè)計8說明8設(shè)計8數(shù)據(jù)傳輸部份8IP過濾分部8身份驗證部份8系統(tǒng)性能設(shè)計9系統(tǒng)犯錯處置91.引言1.1布景此文檔的布景1.2編寫目的和范圍說明寫這份詳細設(shè)計說明書的目的.本詳細設(shè)計說明書編寫的目的是說明法式模塊的設(shè)計考慮,包括法式描述、輸入/輸出、算法和流程邏輯等,為軟件編程和系統(tǒng)維護提供基礎(chǔ).本說明書的預期讀者為系統(tǒng)設(shè)計人員、軟件開發(fā)人員、軟件測試人員和項目評審人員.1.3術(shù)語表界說系統(tǒng)或產(chǎn)物中涉及的重要術(shù)語,為讀者在閱讀文檔時提供需要的參考信息.序號術(shù)語或縮略語說明性界說1PMProjectManager,項目經(jīng)理21.4參考資料列出有關(guān)資料的名稱、作者、文件編號或版本等.參考資料包括：a?需求說明書、架構(gòu)設(shè)計說明書等；b?本項目的其他已發(fā)表的文件；c?引用文件、資料、軟件開發(fā)標準等資料名稱作者文件編號、版本資料寄存地址1.5使用的文字處置和繪圖工具文字處置軟件：[編寫設(shè)計文檔使用的文字處置軟件,如RedOffice]繪圖工具：[使用的UML工具,如Rose、Jude、Visio]2.設(shè)計概述2.1任務(wù)和目標2.1.1需求概述2.1.2運行環(huán)境概述2.1.3條件與限制2.1.4詳細設(shè)計方法和工具系統(tǒng)詳細需求分析主要對系統(tǒng)級的需求進行分析.首先應(yīng)對需求分析提出的企業(yè)需求進一步確認,并對由于情況變動而帶來的需求變動進行較為詳細的分析.3.1詳細需求分析3.1.1詳細功能需求分析3.1.2詳細性能需求分析3.1.3詳細資源需求分析3.1.4詳細接口需求分析3.1.5詳細系統(tǒng)運行環(huán)境及限制條件分析總體方案確認著重解決系統(tǒng)總體結(jié)構(gòu)確認及界面劃分問題.系統(tǒng)總體結(jié)構(gòu)確認對系統(tǒng)組成、邏輯結(jié)構(gòu)及條理進行確認,對應(yīng)用系統(tǒng)、支撐系統(tǒng)及各自實現(xiàn)的功能進行確認,細化集成設(shè)計及系統(tǒng)工作流程,特別要注意因軟件的引進造成的系統(tǒng)自己結(jié)構(gòu)和公司其他系統(tǒng)的結(jié)構(gòu)變動.包括：創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日系統(tǒng)組成、邏輯結(jié)構(gòu)及條理確認4.1.2應(yīng)用系統(tǒng)結(jié)構(gòu)確認4.1.3支撐系統(tǒng)結(jié)構(gòu)確認4.1.4系統(tǒng)集成確認4.1.5系統(tǒng)工作流程確認系統(tǒng)詳細界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問方式,網(wǎng)絡(luò)及數(shù)據(jù)庫對應(yīng)用系統(tǒng)的支撐方式,全局數(shù)據(jù)的管理與存取方式等.4.2.2系統(tǒng)內(nèi)部詳細界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍,模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法,全局數(shù)據(jù)格式,系統(tǒng)性能要求等.全局數(shù)據(jù)結(jié)構(gòu)說明本章說明本法式系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié).構(gòu)5.1常量包括數(shù)據(jù)文件名稱及其所在目錄,功能說明,具體常量說明等.創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日創(chuàng)作時間：二零二一年六月三十日5.2變量本章說明本法式系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié).構(gòu)5.3數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱,功能說明,具體數(shù)據(jù)結(jié)構(gòu)說明（界說、注釋、取值）等.系統(tǒng)詳細設(shè)計6.1功能結(jié)構(gòu)圖系統(tǒng)結(jié)構(gòu)設(shè)計及子系統(tǒng)劃分對系統(tǒng)的組成及邏輯結(jié)構(gòu)進行設(shè)計前確認.劃分系統(tǒng)功能模塊或子系統(tǒng)（如果有或者有需要,特別是年夜型的軟件系統(tǒng)）.6.3系統(tǒng)功能模塊詳細設(shè)計按結(jié)構(gòu)化設(shè)計方法,在系統(tǒng)功能逐層分解的基礎(chǔ)上,對系統(tǒng)各功能模塊或子系統(tǒng)進行設(shè)計.此為詳細設(shè)計的主要部份之一.用條理圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個模塊之間的相互調(diào)用關(guān)系和信息交互,用IPO圖或其他方法描述各模塊完成的功能以上建議采納HIPO圖進行功能分解與模塊描述更高的要求建議采納IDEFO方法進行功能模型設(shè)計詳細設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功能及其相互之間的關(guān)系，用IPO或結(jié)構(gòu)圖描述各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系,以及需求、功能和模塊三者之間的交叉參照關(guān).系每個模塊的描述說明可參照以下格式：模塊編號：模塊名稱：輸入：處置：算法描述：輸出：其中處置和算法描述部份主要采納偽碼或具體的法式語言完.成對詳細設(shè)計更高的要求建議用［DEF0圖進行各功能模塊的設(shè)計如果對軟件需進行二次開發(fā)（包括功能擴展、功能改造、用戶界面改造等）,則相應(yīng)的設(shè)計工作應(yīng)該設(shè)立子課題完成.6.4系統(tǒng)界面詳細設(shè)計系統(tǒng)界面說明應(yīng)用系統(tǒng)軟件的各種接口.整個系統(tǒng)的其他接口（如系統(tǒng)硬件接口、通訊接口等）在相應(yīng)的部份說.明6.4.1外部界面設(shè)計根據(jù)系統(tǒng)界面劃分進行系統(tǒng)外部界面設(shè)計對系統(tǒng)的所有外部接口（包括功能和數(shù)據(jù)接口）進行設(shè)計.6.4.2內(nèi)部界面設(shè)計設(shè)計系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接.口6.4.3用戶界面設(shè)計規(guī)定人機界面的內(nèi)容、界面風格、調(diào)用方式等,包括所謂的表單設(shè)計、報表設(shè)計和用戶需要的打印輸出等設(shè)計.此部份內(nèi)容可能比力多.開發(fā)和測試生產(chǎn)環(huán)境說明7.1開發(fā)環(huán)境7.2測試及產(chǎn)物環(huán)境-Developmentevnironment:programminglanuague,databaseWindwos2003,iis6.0,MySQL,8.模塊設(shè)計8.1用例圖8.2功能設(shè)計說明8.2.1模塊1模塊1主要分為以下幾個子模塊：子模塊1、子模塊2和子模塊N.子模塊.1設(shè)計圖功能描述簡要描述子模塊1的業(yè)務(wù)功能.輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗規(guī)則.詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件.輸出數(shù)據(jù)詳細描述子功能1所發(fā)生的數(shù)據(jù)以及這些數(shù)據(jù)的暗示形式.業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)發(fā)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程..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ù)項及屬性等.）.7源法式文件說明給出本法式的各源法式文件的說明,包括源法式文件名稱及其所在目錄,功能說明,包括的前導文件及函數(shù)名稱等..8函數(shù)說明具體說明本法式中的各個函數(shù),包括函數(shù)名稱及其所在文件,功能,格式,參數(shù),全局變量,局部變量,返回值,算法說明,使用約束等.限制條件其他說明8.2.2模塊2模塊1主要分為以下幾個子模塊：子模塊1、子模塊2和子模塊N.子模塊.1設(shè)計圖.2功能描述簡要描述子模塊1的業(yè)務(wù)功能..3輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗規(guī)則.詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件..4輸出數(shù)據(jù)詳細描述子功能1所發(fā)生的數(shù)據(jù)以及這些數(shù)據(jù)的暗示形式..5業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)發(fā)生輸出數(shù)據(jù)的業(yè)務(wù)算法和流程.數(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ù)名稱等..8函數(shù)說明具體說明本法式中的各個函數(shù),包括函數(shù)名稱及其所在文件,功能,格式,參數(shù),全局變量,局部變量,返回值,算法說明,使用約束等..9限制條件其他說明9.接口設(shè)計9.1內(nèi)部接口9.2外部接口9.2.1接口說明例如：XX子系統(tǒng)通過XX從XX子系統(tǒng)取得XX等,相關(guān)標準調(diào)用示例,可根據(jù)需要增加章節(jié)描述接口.9.2.2調(diào)用方式例如：內(nèi)部接口調(diào)用：例:/***通過用戶服務(wù)號碼取得該客戶認證密碼等信息如果該客戶存在返回為0,其他情況參考毛病編碼*/publicRUserlnfogetUserinfo(StringuserNo);10.數(shù)據(jù)庫設(shè)計詳見［xxx數(shù)據(jù)庫設(shè)計說明書如果數(shù)據(jù)庫設(shè)計內(nèi)容比力少,則直接在此處描述.11.系統(tǒng)平安保密設(shè)計11.1說明例如：由于存在與外部系統(tǒng)的接口,所以需要考慮訪問平安的問題.11.2設(shè)計例如：分為數(shù)據(jù)傳輸部份IP過濾部份，身份驗證部份［章節(jié)可彌補］數(shù)據(jù)傳輸部份例如：在部份數(shù)據(jù)傳遞的時候陽慮以https協(xié)議，需要在布置的時候作相關(guān)處置.IP過濾分部例如：可在系統(tǒng)前端通過Filter實現(xiàn)該Filter實現(xiàn)對該地址訪問的IP過濾作用可信任IP地址通過xml文件進行配置身份驗證部份例如：對信任的用戶公布身份驗證碼,通過該標識進行身份識別.12.系統(tǒng)性能設(shè)計13.系統(tǒng)犯錯處置例如：為了在系統(tǒng)呈現(xiàn)異常情況下給用戶以明確的提示,可采納兩種方式予以提示：1?使用Javascript的alert()函數(shù)直接提示這主要在輸入或修改的情況下使用；2．使用統(tǒng)一的毛病界面提示,該界面對應(yīng)于頁面.毛病界面樣式如下圖所示：毛病提示界面14.設(shè)計和開發(fā)規(guī)范【可以列表方式列出設(shè)計開發(fā)的參考文檔的索引內(nèi)容較少/關(guān)鍵內(nèi)容可以章節(jié)方式填寫】數(shù)據(jù)庫設(shè)計規(guī)范【拜會《XXXX數(shù)據(jù)庫設(shè)計規(guī)范》】.NET編碼規(guī)范特別強調(diào)：?詳細請拜會《ASP.Net文檔規(guī)范》?這里只做簡單論述，如有變動，會及時同事整個項目組相關(guān)人員.不要給類名加前綴.使用PascalCasing風格，不使用匈牙利命名法.要用名詞詞組來給類型命名.使用PascalCasing風格.類名少用縮寫，不要使用下劃線字符(_).基類CBase的文件名為：FileBase.cs;泛型類命名：考慮用T來命名參數(shù)類型，類如：publicclassList〈T>.接口(Interface)命名規(guī)范和類命名規(guī)范相同，唯一區(qū)別是接口在名字前加上“I”前綴.枚舉命名：以復數(shù)結(jié)尾，標明這是一個枚舉，例如：EnumColorButtons結(jié)構(gòu)命名：標明這是一個結(jié)構(gòu)體，例如：StructureCustomerInfoRecord'以Record結(jié)尾?除使用工具直接生成的類外，其它所有類的功能要有注釋，即使只是一個數(shù)據(jù)對象；非罕見功能的API必需要有功能描述的注釋.自力的要被應(yīng)用其他功能所調(diào)用的模塊的接口和公共API的注釋要完備，即包括功能說明、參數(shù)和返回值說明.其它情況的API的注釋盡量完備，但不強制要求.一次性的流翻開后必需關(guān)閉和釋放.一般地，在流翻開后，都有一個trycatch語句，務(wù)必加上finally塊釋放流資源.?即使IF,While是單語句，也要使用“{}”來劃分法式塊.不要有完全為調(diào)試使用的日志信息，如(“1”)；如要使用,在調(diào)試完成后請及時刪除.?一些知識性代碼，不需要寫沒需要的注釋.?不要用工具生成沒用的注釋.14.3代碼目錄結(jié)構(gòu)系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計圖，如下結(jié)構(gòu)說明：作用范圍包名描述整個法式ContentImages寄存圖片ScriptsJquery以及樣式表等jquery-eas