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

1、（完整）軟件詳細設(shè)計文檔模板（最全面）（完整） 軟件詳細設(shè)計文檔模板（最全面）文檔編 號一版*A1密級商密A項目名 稱Xx系統(tǒng)編輯整理：弊敬的讀者朋友們：這里是精品文檔編輯中心，本文檔內(nèi)容是山我和我的同事精心編輯整理后發(fā)布的，發(fā)布之前我們對文中內(nèi)容進行仔細校對，但是難免會有疏漏的地方，但是任然希望（完整）軟件詳細設(shè) 計文檔模板（最全面） ） 的內(nèi)容能夠給 您的工作和學(xué)習(xí)帶來 便利。同時也真誠的 希望收到您的建議和 反饋，這將是我們進 步的源泉，前進的動 力。本文可編輯可修改，如果覺得對您有幫助請收藏以便隨時查閱，最后祝您生活愉快業(yè)績進步，以下 為（完整）軟件詳細設(shè)計文檔模板（最全面）的全部內(nèi)容

2、。項目來 源（完整）軟件詳細設(shè)計文檔模板（最全面）Xxx系統(tǒng)詳細設(shè)計說明書（內(nèi)部資料請勿外傳）劉玉龍日2018-2-10日_期：日_期：日_期：XX公司版權(quán)所有不得復(fù)制文檔變更記錄序號變更（+/-）說明作者版本號日期批準12（完整）軟件詳細設(shè)計文檔模板（最全面）編 寫: 檢査: 審 核:批 準:（完整）軟件詳細設(shè)計文檔模板（最全面）目 錄1 o弓|言.51. 1編寫目的和范圍.51.2術(shù)語表.51.3參考資料.61o 4使用的文字處理和繪圖工具.62。全局數(shù)據(jù)結(jié)構(gòu)說明.82.1常量.82o 2變量.82. 3數(shù)據(jù)結(jié)構(gòu).93o模塊設(shè)計.103. 1用例圖.103o 2功能設(shè)計說明.103. 2.

3、 1模塊1. 103. 2o 2模塊2. 114o接口設(shè)計.124o1內(nèi)部接口.124o2外部接口.124。.2o 1接口說明124.2o 2調(diào)用方式.135.數(shù)據(jù)庫設(shè)計.136o系統(tǒng)安全保密設(shè)計.136. 1說明.136o2設(shè)計.136. 2o 1數(shù)據(jù)傳輸部分.136c 2.2 IP過濾分部.136. 2.3身份驗證部分.137.系統(tǒng)性能設(shè)計.138o系統(tǒng)出錯處理.14（完整）軟件詳細設(shè)計文檔模板（最全面）1.引言1.1背景在日常教學(xué)活動中，為了檢驗教學(xué)質(zhì)量，考察學(xué)生對于理論與實踐的掌握情況以 及教學(xué)質(zhì)。根據(jù)學(xué)生所學(xué)學(xué)科生成考核試題檢測其學(xué)習(xí)效果和教師的教學(xué)質(zhì)量進行 量化考核而提出的綜合性的

4、、全學(xué)科的、覆蓋大多數(shù)學(xué)科基礎(chǔ)教學(xué)內(nèi)容的課程管理 系統(tǒng)項目背景規(guī)劃如表1所示.項目名稱項目委托單 位任務(wù)提出者項目承擔單 位課程管理系 統(tǒng)黃振華黃振華閆亮、 劉玉 龍、凌文表1.1項目背景規(guī)劃課程管理系統(tǒng)是教學(xué)過程階段性測評的一個重要組成部分，它需要學(xué)生信息系 統(tǒng)提供學(xué)生的基本資料，包括姓名，學(xué)號，專業(yè)，班級等基礎(chǔ)信息；另外，它還需要 題庫系統(tǒng)提供考核試題。1.2編寫目的和范圍為了保證項目團隊按時保質(zhì)地完成項目目標，便于項目團隊成員更好地了解項 目情況，明確項目需求，使項目工作開展的各個過程合理有序，有必要以文件化的 形式，把對于在需求分析的內(nèi)容以書面的方式描述出來，作為項目團隊成員以及項目

5、干系人之間的共識與約定，項目生命周期內(nèi)的所有項目活動的行動基礎(chǔ)，項目團隊 開展和檢查項目工作的依據(jù).本項目需求規(guī)格說明書用于從總體上指導(dǎo)課程管理系統(tǒng)項目各個功能模塊開發(fā) 順利進行并最終得到通過評審的項目產(chǎn)品。本項目需求規(guī)格說明書而向項目組全體 成員。1.3術(shù)語表定義系統(tǒng)或產(chǎn)站中涉及的重要術(shù)語,為讀者在閱讀文檔時提供必要的參考信息.序號術(shù)語或縮略語說明性定義1PMProject Manager,項目經(jīng)理（完整）軟件詳細設(shè)計文檔模板（最全面）21.4參考資料文檔格式要求按照我國GB/T85671988國家標準和IEEE/ANS1830-1993標準規(guī) 范要求進行包插以下文件：課程管理系統(tǒng)需求說明書

6、軟件工程項目開發(fā)文檔范例軟件工程國家標準文檔軟件需求說明書編寫規(guī)范書籍包括：軟件項目管理朱少民，韓瑩編著人民郵電出版社軟件項目管理Rajeev T Shand i I ya編著科學(xué)出版社1.5使用的文字處理和繪圖工具文字處理軟件：編寫設(shè)計文檔使用的文字處理軟件，如RedOffice J繪圖工具:使用的UML工具，如Rose、Jude、Vis io（完整）軟件詳細設(shè)計文檔模板（最全面）2.設(shè)計概述2.1任務(wù)和冃標2.1.1需求概述2.1.2運行環(huán)境概述2.1.3條件與限制2.1.4詳細設(shè)計方法和工具3.系統(tǒng)詳細需求分析主要對系統(tǒng)級的需求進行分析。首先應(yīng)對需求分析提出的企業(yè)需求進一步確認，并對由于

7、 情況變化而帶來的需求變化進行較為詳細的分析。3.1詳細需求分析3.1.1詳細功能需求分析3.1.2詳細性能需求分析3.1.3詳細資源需求分析3.1.4詳細接口需求分析3.1.5詳細系統(tǒng)運行環(huán)境及限制條件分析4.總體方案確認著重解決系統(tǒng)總體結(jié)構(gòu)確認及界而劃分問題。（完整）軟件詳細設(shè)計文檔模板（最全面）4.1系統(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)變化。包括:4.1.1系統(tǒng)組成、邏輯結(jié)構(gòu)及層次確認4.1.2應(yīng)用系統(tǒng)結(jié)構(gòu)確認4.1.3支撐系統(tǒng)結(jié)構(gòu)確認

8、4.1.4系統(tǒng)集成確認4.1.5系統(tǒng)工作流程確認4.2系統(tǒng)詳細界面劃分4.2.1應(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)性能要求等。5.全局數(shù)據(jù)結(jié)構(gòu)說明本章說明本程序系統(tǒng)中使用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu).5.1常量包括數(shù)據(jù)文件名稱及其所在目錄,功能說明,具體常量說明等.5.2變量（完整）軟件詳細設(shè)計文檔模板（最全面）本章說明本程序系統(tǒng)中使

9、用的全局數(shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。5.3數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱,功能說明，具體數(shù)據(jù)結(jié)構(gòu)說明（定義、注釋、取值）等。6.系統(tǒng)詳細設(shè)計6.1功能結(jié)構(gòu)圖6.2系統(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圖進行功能分解與模塊描述,更 高的要求建議采

10、用IDEFO方法進行功能模型設(shè)計。詳細設(shè)計應(yīng)用系統(tǒng)的各個構(gòu)成模塊完成的功能及其相互之間的關(guān)系,用IPO或結(jié)構(gòu)圖描述 各模塊的組成結(jié)構(gòu)、算法、模塊間的接口關(guān)系,以及需求、功能和模塊三者之間的交叉參照關(guān) 系.每個模塊的描述說明可參照以下格式:模塊編號:模塊名稱:輸入:處理:算法描述:輸出:其中處理和算法描述部分主要采用偽碼或具體的程序語言完成。對詳細設(shè)計更高的要求建議用IDEFO圖進行各功能模塊的設(shè)計。如果對軟件需進行二次開發(fā)（包括功能擴展、功能改造、用戶界面改造等），則相應(yīng)的設(shè) 計工作應(yīng)該設(shè)立子課題完成。6.4系統(tǒng)界面詳細設(shè)計系統(tǒng)界而說明應(yīng)用系統(tǒng)軟件的各種接口。整個系統(tǒng)的其他接口 （如系統(tǒng)硬件接

11、口、通訊接 口等）在相應(yīng)的部分說明.（完整）軟件詳細設(shè)計文檔模板（最全面）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ù)接口。643用戶界面設(shè)計規(guī)定人機界而的內(nèi)容、界而風格、調(diào)用方式等,包括所謂的表單設(shè)計、報表設(shè)計和用戶需 要的打印輸岀等設(shè)計。此部分內(nèi)容可能比較多。7.開發(fā)和測試生產(chǎn)環(huán)境說明7.1開發(fā)環(huán)境7.2測試及產(chǎn)品環(huán)境 DeveIopment evnironment：programming Ianuague, databaseVs 2010 - svn一i

12、ss 6. 1 + mysq l/sq I server 2005/2008 .net f ramwork 4o0-Test i ng & product i on envi ronment：OS, database 。net framwork 4。0Wi ndwos 2003, i i s 6。0, MySQL,8.模塊設(shè)計8.1用例圖&2功能設(shè)計說明8.2.1模塊1模塊1主要分為以下幾個子模塊:子模塊1、子模塊2和子模塊N。（完整）軟件詳細設(shè)計文檔模板（最全面）子模塊1821.1.1設(shè)計圖.2功能描述簡要描述子模塊1的業(yè)務(wù)功能。.3

13、輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗規(guī)則。詳細描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4輸出數(shù)據(jù)詳細描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(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源程序文件說明給岀本程序的各源程序文件的

14、說明,包括源程序文件名稱及其所在目錄功能說明,包含的 前導(dǎo)文件及函數(shù)名稱等。.8函數(shù)說明具體說明本程序中的各個函數(shù),包括函數(shù)名稱及其所在文件,功能,格式,參數(shù),全局變 量,局部變量,返回值，算法說明,使用約束等..9限制條件.10其他說明8.2.2模塊2模塊1主要分為以下幾個子模塊:子模塊1、子模塊2和子模塊N.& 2.2.1子模塊1（完整）軟件詳細設(shè)計文檔模板（最全面）8.221.1設(shè)計圖.2功能描述簡要描述子模塊1的業(yè)務(wù)功能。.3輸入數(shù)據(jù)詳細描述用戶輸入的數(shù)據(jù)（包括任何輸入設(shè)備）以及這些數(shù)據(jù)的有效性檢驗規(guī)則。詳細

15、描述從物理模型中的哪些表獲取數(shù)據(jù)以及獲取這些數(shù)據(jù)的條件。.4輸岀數(shù)據(jù)詳細描述子功能1所產(chǎn)生的數(shù)據(jù)以及這些數(shù)據(jù)的表現(xiàn)形式。.5業(yè)務(wù)算法和流程從業(yè)務(wù)角度詳細描述根據(jù)輸入數(shù)據(jù)產(chǎn)生輸出數(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源程序文件說明給岀本程序的備源程序文件的說明,包括源程序文件名稱及其所在目錄,功能說明,包含 的前導(dǎo)文件及函數(shù)名稱等。8.2.

16、2.1.8函數(shù)說明具體說明本程序中的各個函數(shù),包括函數(shù)名稱及其所在文件,功能,格式,參數(shù),全局變量, 局部變量,返回值,算法說明,使用約束等。.9限制條件.10其他說明9接口設(shè)計9.1內(nèi)部接口9.2外部接口9.2.1接口說明（完整）軟件詳細設(shè)計文檔模板（最全面）例如:XX子系統(tǒng)通過XX從XX子系統(tǒng)取得XX筆相關(guān)標準,調(diào)用示例,可根據(jù)需要增加章 節(jié)描述接口.922調(diào)用方式例如:內(nèi)部接口調(diào)用:例:/*通過用戶服務(wù)號碼取得該客戶認證密碼等信息，如果該客戶存在返回為0,其他情況參 考錯誤編碼public RUser Info getUser Info（String us e

17、r No）；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é)可補充11.2.1數(shù)據(jù)傳輸部分例如:在部分數(shù)據(jù)傳遞的時候,考慮以https協(xié)議,需要在部署的時候作相關(guān)處理。11.2.2 IP過濾分部例如:可在系統(tǒng)前端通過FiIter實現(xiàn),該Fi Iter實現(xiàn)對該地址訪問的IP過濾作用可信 任IP地址通過xml文件進行配置.11.2.3身份驗證部分例如:對信任的用戶,頒發(fā)身份驗證碼,通過該標識進行身份識別

18、.（完整）軟件詳細設(shè)計文檔模板（最全面）12.系統(tǒng)性能設(shè)計13.系統(tǒng)岀錯處理例如:為了在系統(tǒng)岀現(xiàn)界常情況下給用戶以明確的提示,可采用兩種方式予以提示:7.使用Javascript的alert（）函數(shù)直接提示,這主要在輸入或修改的情況下使用:2.使用統(tǒng)一的錯誤界而提示,該界面對應(yīng)于errorpage. jsp頁面。錯誤界面樣式如下圖所 示:錯誤提示： “錯謀捉示內(nèi)容”返回錯誤提示界面14.設(shè)計和開發(fā)規(guī)范可以列表方式列岀設(shè)計開發(fā)的參考文檔的索引,內(nèi)容較少/關(guān)鍵內(nèi)容可以章節(jié)方式填寫、14.1數(shù)據(jù)庫設(shè)計規(guī)范I參見XXXX數(shù)據(jù)庫設(shè)計規(guī)范14.2 . NET編碼規(guī)范特別強調(diào)：。詳細請參見ASP. Net文

19、檔規(guī)范這里只做簡單闡述，如有變動,會及時同事整個項目組相關(guān)人員。（1）不要給類名加前綴使用Pascal Casing風格，不使用匈牙利命名法.（2）要用名詞詞組來給類型命名。使用Pascal Casing風格。（3）類名少用縮寫，不要使用下劃線字符（_）。（4）基類CBase的文件名為:Fi leBase. cs；（完整）軟件詳細設(shè)計文檔模板（最全面）（5）泛型類命名：考慮用T來命名參數(shù)類型，類如:publ ic class List。（6）接口（Interface）命名規(guī)范和類命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上（完整）軟件詳細設(shè)計文檔模板（最全面）(完整)軟件詳細設(shè)計文檔模板(最全面

20、)“I”前綴。(7)枚舉命名：以復(fù)數(shù)結(jié)尾，表明這是一個枚舉，例如:Enum ColorButtons(8)結(jié)構(gòu)命名：表明這是一個結(jié)構(gòu)體，例如：Structure Customer InfoRecord 以Record結(jié)尾除使用工具直接生成的類外，其它所有類的功能要有注釋，即使只是一個數(shù)據(jù)對象； 非常見功能的API必須耍有功能描述的注釋。獨立的要被應(yīng)用其他功能所調(diào)用的模塊 的接口和公共API的注釋要完備，即包括功能說明、參數(shù)和返回值說明.其它情況的API的注釋盡量完備，但不強制要求.。一次性的流打開后必須關(guān)閉和釋放。一般地，在流打開后，都有一個try catch語句, 務(wù)必加上finally塊釋放流資源.。即使IF, While是單語句，也要使用“ ”來劃分程序塊。0不要有完全為調(diào)試使用的日志信息，如xxxxo info( “1” ):如要使用，在調(diào)試完成 后請及時刪除。一些常識性代碼，不需要寫沒必要的注釋。不要用工具生成沒用的注釋。14.3代碼目錄結(jié)構(gòu)系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計圖,如下：；解決方案Authority (2個項目): 腳本文襠白虛5 AuthorityO倉PropertiesS)田引用0匕Content(- Li Images(=)二Scripts