目錄

需求背景

接口文檔

系統間關系

系統內模塊

環境信息

容量預估

容災容錯

監控告警

代碼變更

上線方案

---

需求背景

簡單描述需求背景，詳細內容可以貼PRD鏈接，重點表述對技術側的影響。

示例：為了支持xxxxx，我們需要構建一個具備靈活擴展能力的xxxxx。

接口文檔

可以貼接口文檔鏈接，如swagger、yapi等。

系統間關系

使用數據流向圖或者調用關系圖來表達現有系統與外部系統的關系。比如數據/請求是誰發起的，在大的系統架構上處于什么位置。數據流向圖/調用關系圖提供一個即可。

對于數據為主的應用，建議使用數據流向圖。

對于調用為主的應用，可以使用調用關系圖。

系統內模塊

使用時序圖或者流程圖來表達內部處理邏輯，或者不同模塊之間的執行順序或者關系。

環境信息

略。

容量預估

類型????????12

接口性能	qps峰值 xxx 響應時間 TP99 和 TP9999 預計 xx 壓測時性能下降不能超過 10%
中間件????????	涉及數據新接入的 新增 每天新增數據xx 一年后預計數據量 xxx 數據保留xxx （多久） 如何操作老數據的過期 全量 每天數據量多少 單條數據多大 保留幾個版本 中間件是否需要進行內存/磁盤的擴容

容災容錯

容災：是否要應對可用區級別的異常，一般來說只有一級系統需要。

容錯：主要針對外部系統，或者依賴的其他組件/服務異常時，當前服務需要做哪些事情，來保證功能正常。

監控告警

針對系統是否要在上線前，配置好對應的監控和告警。建議格式。

監控地址：XXXXX

告警項：

流量突增超出閾值告警，當前閾值xxx。

流量突降超出閾值告警，當前閾值yyy。

流量低語閾值告警，當前閾值zzz。

服務存活告警。

錯誤數超閾值告警，當前閾值hhh。

代碼變更

羅列重要代碼變更。

上線方案

用于描述上線過程，盡可能細化。可以使用里程碑的時間。必寫回滾方案。

總結

以上是生活随笔為你收集整理的一个开发文档模板的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。