資源描述:
《軟件詳細(xì)設(shè)計(jì)文檔模板(最詳細(xì)面.)》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、\研發(fā)生產(chǎn)中心文檔編號(hào)版本A1密級(jí)商密A項(xiàng)目名稱Xx系統(tǒng)項(xiàng)目來(lái)源Xxx系統(tǒng)詳細(xì)設(shè)計(jì)說(shuō)明書(內(nèi)部資料請(qǐng)勿外傳)編寫:日期:檢查:日期:審核:日期:批準(zhǔn):日期:XX公司版權(quán)所有不得復(fù)制文檔變更記錄\序號(hào)變更(+/-)說(shuō)明作者版本號(hào)日期批準(zhǔn)12\目錄1.引言41.1編寫目的和范圍41.2術(shù)語(yǔ)表41.3參考資料41.4使用的文字處理和繪圖工具42.全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明52.1常量52.2變量52.3數(shù)據(jù)結(jié)構(gòu)53.模塊設(shè)計(jì)53.1用例圖53.2功能設(shè)計(jì)說(shuō)明53.2.1模塊153.2.2模塊264.接口設(shè)計(jì)74.1內(nèi)部接口74.2外部接口74.2.1接口說(shuō)明74.2.2調(diào)
2、用方式85.數(shù)據(jù)庫(kù)設(shè)計(jì)86.系統(tǒng)安全保密設(shè)計(jì)86.1說(shuō)明86.2設(shè)計(jì)86.2.1數(shù)據(jù)傳輸部分86.2.2IP過(guò)濾分部86.2.3身份驗(yàn)證部分87.系統(tǒng)性能設(shè)計(jì)98.系統(tǒng)出錯(cuò)處理9\\1.引言1.1背景此文檔的背景1.2編寫目的和范圍說(shuō)明寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的。本詳細(xì)設(shè)計(jì)說(shuō)明書編寫的目的是說(shuō)明程序模塊的設(shè)計(jì)考慮,包括程序描述、輸入/輸出、算法和流程邏輯等,為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ)。本說(shuō)明書的預(yù)期讀者為系統(tǒng)設(shè)計(jì)人員、軟件開(kāi)發(fā)人員、軟件測(cè)試人員和項(xiàng)目評(píng)審人員。1.3術(shù)語(yǔ)表定義系統(tǒng)或產(chǎn)品中涉及的重要術(shù)語(yǔ),為讀者在閱讀文檔時(shí)提供必要的參考信息。序號(hào)術(shù)語(yǔ)或縮略語(yǔ)
3、說(shuō)明性定義1PMProjectManager,項(xiàng)目經(jīng)理21.4參考資料列出有關(guān)資料的名稱、作者、文件編號(hào)或版本等。參考資料包括:a.需求說(shuō)明書、架構(gòu)設(shè)計(jì)說(shuō)明書等;b.本項(xiàng)目的其他已發(fā)表的文件;c.引用文件、資料、軟件開(kāi)發(fā)標(biāo)準(zhǔn)等。資料名稱作者文件編號(hào)、版本資料存放地點(diǎn)1.5使用的文字處理和繪圖工具文字處理軟件:[編寫設(shè)計(jì)文檔使用的文字處理軟件,如RedOffice]繪圖工具:[使用的UML工具,如Rose、Jude、Visio]\1.設(shè)計(jì)概述1.1任務(wù)和目標(biāo)1.1.1需求概述1.1.2運(yùn)行環(huán)境概述1.1.3條件與限制1.1.4詳細(xì)設(shè)計(jì)方法和工具2.系統(tǒng)詳細(xì)需求分
4、析主要對(duì)系統(tǒng)級(jí)的需求進(jìn)行分析。首先應(yīng)對(duì)需求分析提出的企業(yè)需求進(jìn)一步確認(rèn),并對(duì)由于情況變化而帶來(lái)的需求變化進(jìn)行較為詳細(xì)的分析。2.1詳細(xì)需求分析2.1.1詳細(xì)功能需求分析2.1.2詳細(xì)性能需求分析2.1.3詳細(xì)資源需求分析2.1.4詳細(xì)接口需求分析2.1.5詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析3.總體方案確認(rèn)著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問(wèn)題。\1.1系統(tǒng)總體結(jié)構(gòu)確認(rèn)對(duì)系統(tǒng)組成、邏輯結(jié)構(gòu)及層次進(jìn)行確認(rèn),對(duì)應(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)變化。包括:1.1.1系統(tǒng)組成
5、、邏輯結(jié)構(gòu)及層次確認(rèn)1.1.2應(yīng)用系統(tǒng)結(jié)構(gòu)確認(rèn)1.1.3支撐系統(tǒng)結(jié)構(gòu)確認(rèn)1.1.4系統(tǒng)集成確認(rèn)1.1.5系統(tǒng)工作流程確認(rèn)1.2系統(tǒng)詳細(xì)界面劃分1.2.1應(yīng)用系統(tǒng)與支撐系統(tǒng)的詳細(xì)界面劃分應(yīng)用系統(tǒng)與支撐系統(tǒng)之間的界面包括系統(tǒng)主服務(wù)器與其他服務(wù)器的服務(wù)范圍及訪問(wèn)方式,網(wǎng)絡(luò)及數(shù)據(jù)庫(kù)對(duì)應(yīng)用系統(tǒng)的支撐方式,全局?jǐn)?shù)據(jù)的管理與存取方式等。1.2.2系統(tǒng)內(nèi)部詳細(xì)界面劃分系統(tǒng)各功能之間的界面包括覆蓋范圍,模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法,全局?jǐn)?shù)據(jù)格式,系統(tǒng)性能要求等。2.全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。2.1常量包括數(shù)據(jù)文件名稱及其所在目
6、錄,功能說(shuō)明,具體常量說(shuō)明等。\1.1變量本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量、變量和數(shù)據(jù)結(jié)構(gòu)。1.2數(shù)據(jù)結(jié)構(gòu)包括數(shù)據(jù)結(jié)構(gòu)名稱,功能說(shuō)明,具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明(定義、注釋、取值)等。2.系統(tǒng)詳細(xì)設(shè)計(jì)2.1功能結(jié)構(gòu)圖2.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì)及子系統(tǒng)劃分對(duì)系統(tǒng)的組成及邏輯結(jié)構(gòu)進(jìn)行設(shè)計(jì)前確認(rèn)。劃分系統(tǒng)功能模塊或子系統(tǒng)(如果有或者有必要,特別是大型的軟件系統(tǒng))。2.3系統(tǒng)功能模塊詳細(xì)設(shè)計(jì)按結(jié)構(gòu)化設(shè)計(jì)方法,在系統(tǒng)功能逐層分解的基礎(chǔ)上,對(duì)系統(tǒng)各功能模塊或子系統(tǒng)進(jìn)行設(shè)計(jì)。此為詳細(xì)設(shè)計(jì)的主要部分之一。用層次圖描述系統(tǒng)的總體結(jié)構(gòu)、功能分解及各個(gè)模塊之間的相互調(diào)用關(guān)系和信息交互,用IPO
7、圖或其他方法描述各模塊完成的功能。以上建議采用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è)模塊的描述說(shuō)明可參照以下格式:模塊編號(hào):模塊名稱:輸入:處理:算法描述:輸出:其中處理和算法描述部分主要采用偽碼或具體的程序語(yǔ)言完成。對(duì)詳細(xì)設(shè)計(jì)更高的要求建議用IDEF0圖進(jìn)行各功能模塊的設(shè)計(jì)。如果對(duì)軟件需進(jìn)行二次開(kāi)發(fā)(包括功能擴(kuò)展、功能改造、用戶界面改造等),則相應(yīng)
8、的設(shè)計(jì)工作應(yīng)該設(shè)立子課題