概要設計 -
系統名稱:*****
文檔修訂歷史
版本號 | 作者 | 備註 | 修訂日期 |
---|---|---|---|
v1.0 | **** | 創建模版 | 2020-7-29 |
1. 需求背景
【【描述需求背景或者開發重構的目的/出發點】
原先大家寫文檔都是本機寫文檔,然後評審時統一交給主持人進行投影,文檔版本管理也比較混亂
2. 需求分析
2.1. 產品需求分析【產品需求適用】
【用於描述對產品提出的需求的理解和分析:產品定位、新增功能、業務目標等,避免對需求的理解和產品不一致,導致做無用功】
XXXX。。。
2.2. 技術技術需求分析【技術優化適用】
【用於描述對技術團隊提出的技術需求的理解和分析:技術債務清理、市場反饋問題改善、性能體驗優化、技術指標達成、技術方案更新等。此處應包含技術改善項目和大致的實現策略】
XXXX。。。
3. 整體實現方案
3.1. 整體框架圖
【展示應用整體的框架圖,包括整體結構、應用分層、模塊解耦】
XXXX。。。
3.2. 核心功能流程圖
【展示新增核心功能的流程圖,幫助梳理整個功能的邏輯,減少編碼過程中由於前期考慮不周導致的不穩定性和隨機bug】
XXXX。。。
4. 模塊設計
【根據原型或者UX稿識別需要新增或修改的頁面、模塊、組件,儘量解耦】
XXXX。。。
5. 接口設計
【列出所有關聯接口及功能描述,詳細參數交互後續補充,標註新增或修改】
XXXX。。。
6.異常流程設計
【列出所有交互異常流程處理方案,接口異常處理方案】
7. 風險及應對方案
【列出開發相關的風險項:資損風險、安全風險、指標達成風險、進度風險等,以及針對各項風險的應對方案。如設計中包含,需詳細說明;如不包含,請寫明【確認無此風險】
7.1. 資損風險分析
XXXX。。。
7.2. 安全風險分析
XXXX。。。
7.3. 接口改動是否兼容老版本
XXXX。。。
7.4. 代碼改動是否兼容老版
XXXX。。。
7.5. 路由修改刪除是否已檢查頁面投放情況
XXXX。。。
7.6. 其它風險說明
XXXX。。。
8. 各節點裏程碑
【列出各領域的關鍵事項及時間節點,以便各領域協同、項目透明、進度可預知】
XXXX。。。