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

文檔編號(hào)文檔編號(hào)版本版本A1密級(jí)密級(jí)商密 A 項(xiàng)目名稱項(xiàng)目名稱XxXx 系統(tǒng)系統(tǒng)研發(fā)生產(chǎn)中心研發(fā)生產(chǎn)中心 項(xiàng)目來(lái)源項(xiàng)目來(lái)源 XxXxx x 系統(tǒng)系統(tǒng) 詳細(xì)設(shè)計(jì)說(shuō)明書(shū)詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 內(nèi)部資料 請(qǐng)勿外傳 編編 寫(xiě) 寫(xiě) 日日 期 期 檢檢 查 查 日日 期 期 審審 核 核 日日 期 期 批批 準(zhǔn) 準(zhǔn) 日日 期 期 XX 公公司司 版權(quán)所有版權(quán)所有 不得復(fù)制不得復(fù)制 文檔變更記錄文檔變更記錄 序號(hào)序號(hào)變更 變更 說(shuō)明 說(shuō)明作者作者版本號(hào)版本號(hào)日期日期批準(zhǔn)批準(zhǔn) 1 2 目 錄 1 引言 4 1 1 編寫(xiě)目的和范圍 4 1 2 術(shù)語(yǔ)表 4 1 3 參考資料 4 1 4 使用的文字處理和繪圖工具 4 2 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明 5 2 1 常量 5 2 2 變量 5 2 3 數(shù)據(jù)結(jié)構(gòu) 5 3 模塊設(shè)計(jì) 5 3 1 用例圖 5 3 2 功能設(shè)計(jì)說(shuō)明 5 3 2 1 模塊 1 5 3 2 2 模塊 2 6 4 接口設(shè)計(jì) 7 4 1 內(nèi)部接口 7 4 2 外部接口 7 4 2 1 接口說(shuō)明 7 4 2 2 調(diào)用方式 8 5 數(shù)據(jù)庫(kù)設(shè)計(jì) 8 6 系統(tǒng)安全保密設(shè)計(jì) 8 6 1 說(shuō)明 8 6 2 設(shè)計(jì) 8 6 2 1 數(shù)據(jù)傳輸部分 8 6 2 2 IP 過(guò)濾分部 8 6 2 3 身份驗(yàn)證部分 8 7 系統(tǒng)性能設(shè)計(jì) 9 8 系統(tǒng)出錯(cuò)處理 9 1 引言 1 1 背景 此文檔的背景 1 2 編寫(xiě)目的和范圍 說(shuō)明寫(xiě)這份詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的目的 本詳細(xì)設(shè)計(jì)說(shuō)明書(shū)編寫(xiě)的目的是說(shuō)明程序模塊的設(shè)計(jì)考慮 包括程序描述 輸入 輸出 算法和流程邏輯等 為軟件編程和系統(tǒng)維護(hù)提供基礎(chǔ) 本說(shuō)明書(shū)的預(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)序號(hào)術(shù)語(yǔ)或縮略語(yǔ)術(shù)語(yǔ)或縮略語(yǔ)說(shuō)明性定義說(shuō)明性定義 1PM Project Manager 項(xiàng)目經(jīng)理 2 1 4 參考資料 列出有關(guān)資料的名稱 作者 文件編號(hào)或版本等 參考資料包括 a 需求說(shuō)明書(shū) 架構(gòu)設(shè)計(jì)說(shuō)明書(shū)等 b 本項(xiàng)目的其他已發(fā)表的文件 c 引用文件 資料 軟件開(kāi)發(fā)標(biāo)準(zhǔn)等 資料名稱作者文件編號(hào) 版本資料存放地點(diǎn) 1 5 使用的文字處理和繪圖工具 文字處理軟件 編寫(xiě)設(shè)計(jì)文檔使用的文字處理軟件 如 RedOffice 繪圖工具 使用的 UML 工具 如 Rose Jude Visio 2 設(shè)計(jì)概述 2 1 任務(wù)和目標(biāo) 2 1 1 需求概述 2 1 2 運(yùn)行環(huán)境概述 2 1 3 條件與限制 2 1 4 詳細(xì)設(shè)計(jì)方法和工具 3 系統(tǒng)詳細(xì)需求分析 主要對(duì)系統(tǒng)級(jí)的需求進(jìn)行分析 首先應(yīng)對(duì)需求分析提出的企業(yè)需求進(jìn)一步確認(rèn) 并對(duì) 由于情況變化而帶來(lái)的需求變化進(jìn)行較為詳細(xì)的分析 3 1 詳細(xì)需求分析 3 1 1 詳細(xì)功能需求分析 3 1 2 詳細(xì)性能需求分析 3 1 3 詳細(xì)資源需求分析 3 1 4 詳細(xì)接口需求分析 3 1 5 詳細(xì)系統(tǒng)運(yùn)行環(huán)境及限制條件分析 4 總體方案確認(rèn) 著重解決系統(tǒng)總體結(jié)構(gòu)確認(rèn)及界面劃分問(wèn)題 4 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)變化 包括 4 1 1 系統(tǒng)組成 邏輯結(jié)構(gòu)及層次確認(rèn) 4 1 2 應(yīng)用系統(tǒng)結(jié)構(gòu)確認(rèn) 4 1 3 支撐系統(tǒng)結(jié)構(gòu)確認(rèn) 4 1 4 系統(tǒng)集成確認(rèn) 4 1 5 系統(tǒng)工作流程確認(rèn) 4 2 系統(tǒng)詳細(xì)界面劃分 4 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ù)的管理與存取方式等 4 2 2 系統(tǒng)內(nèi)部詳細(xì)界面劃分 系統(tǒng)各功能之間的界面包括覆蓋范圍 模塊間功能調(diào)用涉及到的系統(tǒng)模塊及方法 全 局?jǐn)?shù)據(jù)格式 系統(tǒng)性能要求等 5 全局?jǐn)?shù)據(jù)結(jié)構(gòu)說(shuō)明 本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量 變量和數(shù)據(jù)結(jié)構(gòu) 5 1 常量 包括數(shù)據(jù)文件名稱及其所在目錄 功能說(shuō)明 具體常量說(shuō)明等 5 2 變量 本章說(shuō)明本程序系統(tǒng)中使用的全局?jǐn)?shù)據(jù)常量 變量和數(shù)據(jù)結(jié)構(gòu) 5 3 數(shù)據(jù)結(jié)構(gòu) 包括數(shù)據(jù)結(jié)構(gòu)名稱 功能說(shuō)明 具體數(shù)據(jù)結(jié)構(gòu)說(shuō)明 定義 注釋 取值 等 6 系統(tǒng)詳細(xì)設(shè)計(jì) 6 1 功能結(jié)構(gòu)圖 6 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) 6 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 圖或其他方法描述各模塊完成的功能 以上建議采用 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)的 設(shè)計(jì)工作應(yīng)該設(shè)立子課題完成 6 4 系統(tǒng)界面詳細(xì)設(shè)計(jì) 系統(tǒng)界面說(shuō)明應(yīng)用系統(tǒng)軟件的各種接口 整個(gè)系統(tǒng)的其他接口 如系統(tǒng)硬件接口 通 訊接口等 在相應(yīng)的部分說(shuō)明 6 4 1 外部界面設(shè)計(jì) 根據(jù)系統(tǒng)界面劃分進(jìn)行系統(tǒng)外部界面設(shè)計(jì) 對(duì)系統(tǒng)的所有外部接口 包括功能和數(shù)據(jù) 接口 進(jìn)行設(shè)計(jì) 6 4 2 內(nèi)部界面設(shè)計(jì) 設(shè)計(jì)系統(tǒng)內(nèi)部各功能模塊間的調(diào)用關(guān)系和數(shù)據(jù)接口 6 4 3 用戶界面設(shè)計(jì) 規(guī)定人機(jī)界面的內(nèi)容 界面風(fēng)格 調(diào)用方式等 包括所謂的表單設(shè)計(jì) 報(bào)表設(shè)計(jì)和用 戶需要的打印輸出等設(shè)計(jì) 此部分內(nèi)容可能比較多 7 開(kāi)發(fā)和測(cè)試生產(chǎn)環(huán)境說(shuō)明 7 1 開(kāi)發(fā)環(huán)境 7 2 測(cè)試及產(chǎn)品環(huán)境 Development evnironment programming lanuague database Vs 2010 svn iss 6 1 mysql sql server 2005 2008 net framwork 4 0 Testing 10 數(shù)據(jù)庫(kù)設(shè)計(jì) 詳見(jiàn) xxx 數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū) 如果數(shù)據(jù)庫(kù)設(shè)計(jì)內(nèi)容比較少 則直接在此處描述 11 系統(tǒng)安全保密設(shè)計(jì) 11 1 說(shuō)明 例如 由于存在與外部系統(tǒng)的接口 所以需要考慮訪問(wèn)安全的問(wèn)題 11 2 設(shè)計(jì) 例如 分為數(shù)據(jù)傳輸部分 IP 過(guò)濾部分 身份驗(yàn)證部分 章節(jié)可補(bǔ)充 11 2 1 數(shù)據(jù)傳輸部分 例如 在部分?jǐn)?shù)據(jù)傳遞的時(shí)候 考慮以 https 協(xié)議 需要在部署的時(shí)候作相關(guān)處理 11 2 2 IP 過(guò)濾分部 例如 可在系統(tǒng)前端通過(guò) Filter 實(shí)現(xiàn) 該 Filter 實(shí)現(xiàn)對(duì)該地址訪問(wèn)的 IP 過(guò)濾作用 可 信任 IP 地址通過(guò) xml 文件進(jìn)行配置 11 2 3 身份驗(yàn)證部分 例如 對(duì)信任的用戶 頒發(fā)身份驗(yàn)證碼 通過(guò)該標(biāo)識(shí)進(jìn)行身份識(shí)別 12 系統(tǒng)性能設(shè)計(jì) 13 系統(tǒng)出錯(cuò)處理 例如 為了在系統(tǒng)出現(xiàn)異常情況下給用戶以明確的提示 可采用兩種方式予以提示 1 使用 Javascript 的 alert 函數(shù)直接提示 這主要在輸入或修改的情況下使用 2 使用統(tǒng)一的錯(cuò)誤界面提示 該界面對(duì)應(yīng)于 errorpage jsp 頁(yè)面 錯(cuò)誤界面樣式如下 圖所示 錯(cuò)誤提示 返回 錯(cuò)誤提示內(nèi)容 錯(cuò)誤提示界面 14 設(shè)計(jì)和開(kāi)發(fā)規(guī)范 可以列表方式列出設(shè)計(jì)開(kāi)發(fā)的參考文檔的索引 內(nèi)容較少 關(guān)鍵內(nèi)容可以章節(jié)方式填 寫(xiě) 14 1 數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范 參見(jiàn) XXXX 數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范 14 2 NET 編碼規(guī)范 特別強(qiáng)調(diào) 詳細(xì)請(qǐng)參見(jiàn) ASP Net 文檔規(guī)范 這里只做簡(jiǎn)單闡述 如有變動(dòng) 會(huì)及時(shí)同事整個(gè)項(xiàng)目組相關(guān)人員 1 不要給類名加前綴 使用 PascalCasing 風(fēng)格 不使用匈牙利命名法 2 要用名詞詞組來(lái)給類型命名 使用 PascalCasing 風(fēng)格 3 類名少用縮寫(xiě) 不要使用下劃線字符 4 基類 CBase 的文件名為 FileBase cs 5 泛型類命名 考慮用 T 來(lái)命名參數(shù)類型 類如 public class List 6 接口 Interface 命名規(guī)范和類命名規(guī)范相同 唯一區(qū)別是 接口在名字前 加上 I 前綴 7 枚舉命名 以復(fù)數(shù)結(jié)尾 表明這是一個(gè)枚舉 例如 Enum ColorButtons 8 結(jié)構(gòu)命名 表明這是一個(gè)結(jié)構(gòu)體 例如 Structure CustomerInfoRecord 以 Record 結(jié)尾 除使用工具直接生成的類外 其它所有類的功能要有注釋 即使只是一個(gè)數(shù)據(jù)對(duì) 象 非常見(jiàn)功能的 API 必須要有功能描述的注釋 獨(dú)立的要被應(yīng)用其他功能所調(diào) 用的模塊的接口和公共 API 的注釋要完備 即包括功能說(shuō)明 參數(shù)和返回值說(shuō)明 其它情況的 API 的注釋盡量完備 但不強(qiáng)制要求 一次性的流打開(kāi)后必須關(guān)閉和釋放 一般地 在流打開(kāi)后 都有一個(gè) try catch 語(yǔ)句 務(wù)必加上 finally 塊釋放流資源 即使 IF While 是單語(yǔ)句 也要使用 來(lái)劃分程序塊 不要有完全為調(diào)試使用的日志信息 如 xxxx info 1 如要使用 在調(diào)試完 成后請(qǐng)及時(shí)刪除 一些常識(shí)性代碼 不需要寫(xiě)沒(méi)必要的注釋 不要用工具生成沒(méi)用的注釋 14 3 代碼目錄結(jié)構(gòu) 系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計(jì)圖 如下 結(jié)構(gòu)說(shuō)明 作用范圍包名描述 Images 存放圖片 Scripts Jquery 以及樣式表等 Scripts jquery easyui 1 2 6 jquery easyui 包數(shù)字為版本 Scripts jquery ui 1 8 20 jquery ui 包數(shù)字為版本 Scripts jthok ui 自定義的 js 格式文件 整個(gè)程序 Content Scripts them