http://blog.51cto.com/13527416/2164794

很多同學問做架構設計，怎么才能寫出比較好的文檔。其實很簡單，都是有套路的，今天剛好借這個機會，和大家分享下一般做架構設計該怎么寫文檔。

背景

首先介紹下項目背景、基于什么原因需要需求。

• 如果是新產品，描述下產品啟動的原因和背景、產品定位
• 如果是升級版本，描述升級需求、對原系統的影響，以及到達的預期效果

名詞解釋

文檔中出現新的或者不常見的名詞、概念給出定義和解釋。

設計目標

實現功能

大致描述系統本身的功能性需求，不需描述外部依賴的系統。功能點之間的層級和關聯關系要明晰。這里僅描述功能，不需要涉及實現方案、功能取舍等問題。

性能指標

描述系統性能需求。建議分條列出量化的性能指標，比如響應時間、超時率、資源占用、運行周期等。

系統環境

相關軟件及硬件

在這里加入系統所需的軟、硬件, 包括操作系統, 機器型號及配置要求。建議采用表格形式列出，最好還能規劃出服務器和軟件構件的部署圖。

數據規模預估

通過經驗或者調研，對數據規模進行估計，包括用戶量、數據量、帶寬消耗及增長速度等方面。

設計思路

描述系統設計中需要解決或考慮的關鍵問題或難點問題，解決這些問題可能有不同方案, 在這里加入方案設計的選擇, 折衷及解釋，并在后面的系統設計中對選中的方案給出進一步闡述。

建議分類列出，比如性能、可擴展性、安全性、服務穩定性、反作弊、復用等方面。建議使用調研數據支持設計方案的選擇。

系統設計

基礎介紹

對系統整體的簡要說明。

系統架構圖

把系統分解為若干子系統或模塊，給出系統架構圖，同時簡單闡述每個模塊完成的主要功能（必要時，給出模塊劃分的解釋，即說明為什么把某些功能設計在某個模塊中）。

系統流程圖

通過流程圖說明系統之間的模塊是怎么交互來實現系統功能的

XXX 模塊說明

XXX 模塊功能

描述該模塊要實現的功能，可以先簡要描述，再分條列出。對于模塊相關的關鍵功能和關鍵技術，也在此說明，供詳細設計人員參考。

與其它模塊的接口

在此描述該模塊與系統內其它模塊的接口，不包括模塊內部的接口

風險評估

已知的或可預知的風險

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

與其它系統可能的影響

這里描述這些依賴關系可能帶來的影響。包括本系統對其它系統可能造成的影響以及其它系統可能給本系統造成的影響兩個方面

附件及參考資料

填寫文檔相關的附件或參考資料

轉載于:https://www.cnblogs.com/davidwang456/articles/9566816.html

《新程序員》：云原生和全面數字化實踐50位技術專家共同創作，文字、視頻、音頻交互閱讀

總結

以上是生活随笔為你收集整理的架构设计文档的全部內容，希望文章能夠幫你解決所遇到的問題。

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