詳細設計文件格式

2021-09-20 08:02:48 字數 1217 閱讀 7929

(背景、原因)

(對文件**現新的或不常見的名詞、概念或簡略語給出定義和解釋)

(概要描述要實現的功能,列出要實現的功能點及子功能點,並對每乙個功能點進行詳細說明。功能點之間的層級和關聯關係要明晰。僅描述功能,不需要涉及實現方案、功能取捨等問題)

(效能目標需要分解到模組,描述對該模組的效能要求。比如響應時間、cpu峰值、記憶體分配等)

(與外界其他系統/模組的聯絡。採用文字分條列出或採用模組結構圖描述均可)

(系統所需的軟,硬體,包括作業系統,機器型號及配置要求。建議採用**形式列出)

(系統已知的或可預知的限制)

(通過調研或經驗,對資料規模進行估計,包括使用者量、資料量、頻寬消耗及增長速度等方面分條列出)

( 描述模組設計中需要解決或考慮的關鍵問題,解決這些問題可能有不同方案, 在這裡加入方案設計的選擇, 折衷及解釋,並在後面的模組設計中對選中的方案給出進一步闡述。建議分類列出,比如效能、可擴充套件性、安全性、服務穩定性、反作弊、復用等方面。)

( 描述模組設計架構,對模組相關的實現流程和業務規則進行詳細說明。描述實現流程時,建議採用流程圖的方式,也可以採用偽碼或文字描述。無論採取哪種方式,都要注意分支的完備性,特別是異常分支。)

( 說明在該模組中涉及到的核心資料結構的核心內容(可以以文字描述或**的方式給出),並進行必要說明)

( 對關鍵或複雜的演算法進行描述,該節可根據需要進行裁剪)

( 說明模組呼叫的介面方式並進行定義,如函式的引數定義、返回值,介面資料結構和定義等。若需要使用外部提供的lib庫,需要在設計階段協調好將使用的版本,並在此進行說明)

( 對模組中異常情況的處理進行說明,比如輸入資料不合法、記憶體分配失敗、模組內部錯誤需要向外部模組返回的錯誤碼及含義等。)

( 對模組中使用的邊界值進行定義)

( 對模組涉及到的配置項進行說明)

( 說明從測試角度考慮設計方案,以及單元測試或聯合測試需要考慮的關鍵事項。比如,測試計畫、單元測試的思路、聯合測試的重點、測試工具的開發和使用等。)

( 在這裡加上已經知道的或可能會發生的風險,包括技術、業務等方面。最好針對每個風險,列出相應的應對措施)

( 在「4.1 」中描述了該模組與其它模組的依賴關係。在這裡描述這些依賴關係可能帶來的影響。包括本模組對其它模組可能造成的影響以及其它模組可能給本模組造成的影響兩個方面)

no問題描述

提出人處理方式/說明狀態1

open

2closed

3

詳細設計文件

如上圖,可以看到詳細設計文件是,瀑布模型 中承上啟下的乙個關鍵環節,在做好需求分析和軟體架構之後,寫好詳細設計文件就意味可以進行編碼了。由此,可以看到詳細設計文件有三個作用 1,為具體編碼環節做好鋪墊與設計,從而指導編碼工作 2,提供測試所需文件參考 3,可作為理解編碼的參考文件。詳細設計的主要任務...

詳細設計文件

如何寫詳細設計文件是乙個很頭疼的話題,簡單的說是需求文件的昇華,也可以說是開發人員開發程式的依據,當然根據詳細設計文件的粒度進行。好的詳細設計文件是需求人員和開發人員之間的橋梁,不過目前好多程式開發都是先開發後,然後為了應付審核,公司制度,文件規範,開發完成後後續補上該文件。如果這樣的方式,詳細設計...

需求分析文件 概要設計文件 詳細設計文件

由於專案工作需要 需要提供 軟體需求規格說明書 軟體概要設計說明書 和 軟體詳細設計說明書 所以這裡整理學習一下相關文件需要的內容。文章並不設計對所有需求分析,概要設計和詳細設計的詳細描述。因為這其中的任何一點都可以單獨提取出來成為軟體工程學科中的一本書籍內容。2.1 我們為什麼需要 軟體需求規格說...