軟件開發(fā)技術方案模板

技術開發(fā)方案模板概述及術語1.可以引用產(chǎn)品文檔，并且?guī)袭a(chǎn)品文檔鏈接2.對一些系統(tǒng)中產(chǎn)生的術語做出解釋交代清楚技術方案設計的背景、邏輯2架構設計2.1整體架構說明：講清楚業(yè)務架構、應用架構，二選一。即使是小迭代架構不變也需要引用之前的架構圖。2.2各個核心功能的流程圖/時序圖/狀態(tài)3功能清單/系統(tǒng)用例3.1依賴方功能清單序號依賴系統(tǒng)功能點功能描述修改類型對接人1服務1功能1新增小可愛2服務2功能2新增小可愛3服務3功能3注意訂單類型與業(yè)務訂單的映射修改小可愛4新增????3.2內(nèi)部功能清單序號功能點功能描述修改類型開發(fā)者1功能11、防重校驗2、安全校驗新增小可愛2功能21、功能描述1新增小可愛3功能31、功能描述修改小可愛4新增????41亦模型設ER根據(jù)需求的大小，若是小迭代，可以不用DDL考慮索引DML4.4MQ設計5配置說明：項目中涉及到的相關數(shù)據(jù)庫初始化配置、參數(shù)配置、定時任務配置、消息配置等5.1配置中心nacos/Apollo配置屬于新增或者修改需要備注清楚#新增xx1:xx2:xx3:305.2定時任務配置填寫定時任務的JobHandler.任務描述、cron.任務參數(shù)（根據(jù)業(yè)務需要可填可不填）、負責人信息

JobHandler*JobHandler*任務描述*Cron*任務參數(shù)*負責人*xxJob任務描述00/10***?無小可愛5.3mq配填寫新增的mqtopic名稱以及group名稱。mq的類名新增的topic新增的group^口詳細設計6.1創(chuàng)建活動說明：接口入?yún)?、出參字段、錯誤碼、實現(xiàn)的邏輯描述、接口變更的影響范圍7其他方面7.1監(jiān)控方案監(jiān)控類型監(jiān)控內(nèi)容指標項責任人鏈路監(jiān)控Rest接口的非200鏈路數(shù)據(jù)庫寫入失敗MQ發(fā)送失敗緩存鏈路監(jiān)控調(diào)用外部接口的異常監(jiān)控錯誤量錯誤率延遲變化指數(shù)負責開發(fā)該模塊的研發(fā)日志監(jiān)控1.數(shù)據(jù)庫慢日志日志量級負責開發(fā)該

業(yè)務打印日志日志量級業(yè)務日志告警變化指數(shù)模塊的研發(fā)數(shù)據(jù)監(jiān)控數(shù)據(jù)日增長總量級監(jiān)控某種業(yè)務角度匯總的總量級數(shù)據(jù)量級增長率負責開發(fā)該模塊的研發(fā)用戶行為監(jiān)控頁面錯誤頁面訪問量級頁面加載性能頁面加載異常錯誤量錯誤率PV、UV負責該產(chǎn)品的前端研發(fā)基礎設施監(jiān)控各種中間件、設備的運行狀態(tài)防火墻監(jiān)控數(shù)據(jù)庫宿主機購買的三方資源使用量CPU內(nèi)存磁盤資源使用量運維*注意監(jiān)控并不一定都能聯(lián)動報警，但在已知的確定性的異常監(jiān)控數(shù)據(jù)，可以聯(lián)動報警；監(jiān)控需要做到常規(guī)巡檢，系統(tǒng)上線不是終點，上線后的穩(wěn)定性保障性工作更重要；監(jiān)控需要常態(tài)化，監(jiān)控指標是洞察系統(tǒng)運行質(zhì)量的眼睛；上線前需要預先設置好以上監(jiān)控的點，建議各負責人上線后定期產(chǎn)出巡檢報告。7.2灰度方案*注意灰度是系統(tǒng)平滑升級的必要條件灰度方案需要找準灰度的特征屬性，常用的如：區(qū)域、人員id7.3應急方案*注意當通過監(jiān)控或者業(yè)務反饋并確認異常后，需要有如下必要流程：發(fā)布故障通告，確保通知、協(xié)調(diào)到各方（運營人員、產(chǎn)品、研發(fā)Leader）,必要時需要提供相關信息給運營人員，并且做停服維護公告；緊急問題，可以聯(lián)系運維做端上流量限制：包括數(shù)據(jù)庫關鍵詞限流、網(wǎng)關接口限流/關閉、配置防火墻隔離規(guī)則、用戶/IP訪問熔斷等；BUG修復類問題，需要緊急發(fā)布的需要領導審批；因故障連帶其他服務異常的，需要聯(lián)系運維做緊急資源隔離，縮小故障范圍；故障處理完畢及時發(fā)布故障解除公告。說明：目前基礎設施缺失服務內(nèi)部接口限流、熔斷措施，對于一些來源為內(nèi)部服務調(diào)用產(chǎn)生的故障可能還需要調(diào)用方的服務緊急發(fā)布，停止調(diào)用行為；對于來