軟件設計文檔模板

《軟件設計文檔模板》由會員上傳分享，免費在線閱讀，更多相關內容在行業(yè)資料-天天文庫。

1、軟件設計文檔V文檔管理信息表主題版本內容關鍵字參考文檔創(chuàng)建時間創(chuàng)建人最新發(fā)布日期文檔變更紀錄更改人日期更改內容2004-1-1創(chuàng)建文件V文檔主要評審意見產品組評審人員日期意見QA組評審人員日期意見V目錄1開發(fā)規(guī)劃11.1開發(fā)人員11.2開發(fā)計劃21.3開發(fā)環(huán)境和工具31.4開發(fā)規(guī)范32總體設計42.1概念術語描述42.1.1術語142.1.2術語242.2基本設計描述52.2.1系統(tǒng)總體邏輯結構圖52.2.2系統(tǒng)部署結構圖62.3主要界面流程描述72.3.1功能1界面流程72.3.2功能2界面流程72.4模塊列表83數(shù)

2、據(jù)結構94接口規(guī)范104.1<模塊1API>104.1.1Interface1104.1.2Interface2104.2<模塊2API>114.3<模塊3API>114.4<數(shù)據(jù)庫API>115模塊設計125.1Module1設計125.1.1模塊設計描述125.1.2模塊界面描述125.2Module2設計136附錄146.1第三方組件146.2參考資料156.3附加文檔15VVxx項目.項目目標1開發(fā)規(guī)劃1.1開發(fā)人員角色主要職責負責模塊人員備注項目經理PMn項目全面負責n項目設計n主要框架/模塊編寫n項目進度控

3、制nxxx模塊xxx產品經理PTn定義需求n產品監(jiān)督n結果驗證（測試）n用戶文檔無xxx程序員DEVnnxxx模塊xxx程序員DEVnnxxx模塊xxxnn15xx項目.項目目標1.1開發(fā)計劃<附開發(fā)計劃表>15xx項目.項目目標1.1開發(fā)環(huán)境和工具開發(fā)工具工具作用Delphi7.net客戶端VBA開發(fā)Excel插件VS.NETWeb頁面，WebService1.2開發(fā)規(guī)范文檔名稱位置Delphi編碼規(guī)范系統(tǒng)目錄規(guī)范15xx項目.項目目標1總體設計1.1概念術語描述1.1.1術語1<術語1的描述>1.1.2術語2<術語

4、2的描述>15xx項目.項目目標1.1基本設計描述<文字性的設計思路>1.1.1系統(tǒng)總體邏輯結構圖層/包1模塊1模塊3模塊2層/包2模塊2模塊115xx項目.項目目標1.1.1系統(tǒng)部署結構圖數(shù)據(jù)庫服務器Web服務器防火墻內部客戶機內部客戶機VPN/INTERNET遠程客戶機遠程客戶機系統(tǒng)網絡拓撲結構15xx項目.項目目標1.1主要界面流程描述1.1.1功能1界面流程1.1.2功能2界面流程15xx項目.項目目標1.1模塊列表模塊名稱(英文)功能備注模塊1Module1模塊2Module2模塊3Module315xx項目

5、.項目目標1數(shù)據(jù)結構數(shù)據(jù)庫表列表表名作用<附SQL數(shù)據(jù)庫結構定義文檔>15xx項目.項目目標接口規(guī)范1.1<模塊1API>l描述<模塊功能和設計描述(簡要描述)>l集成和部署<描述模塊如何同系統(tǒng)集成，實現(xiàn)形式是DLL,EXE或是嵌入式代碼>1.1.1Interface1lFunction1stringfunction1(intparam1,stringparam2,…)param1-param

6、2-lFunction2stringfunction2(intparam1,stringparam2,…)param1-param2-1.1.2Interface215xx項目.項目目標1.1<模塊2API>1.2<模塊3API>1.3<數(shù)據(jù)庫API>定義數(shù)據(jù)庫存儲過程接口15xx項目.項目目標1模塊設計1.1Module1設計<更具具體情況細化模塊設計>1.1.

7、1模塊設計描述1.1.2模塊界面描述15xx項目.項目目標1.1Module2設計15xx項目.項目目標1附錄1.1第三方組件Delphi組件組件名稱版本用途.NET組件組件名稱版本用途15xx項目.項目目標1.1參考資料DesignPattern-1.2附加文檔文檔名稱文件名描述項目計劃表Wind.net.plan.mpp項目時間規(guī)劃數(shù)據(jù)庫定義X.sql數(shù)據(jù)庫定義腳本15