撰寫架構設計文檔的心得體會
1.架構設計文檔閱讀對象:
是軟體工程師,平台産品經理,不是乙方客戶;
2.架構設計文檔目的與意義:
a.系統規劃;
b.有利于軟體工程師的開展工作;
c.便于配置設定工作,指導工作;
3.不在于篇幅,注重幹貨;
4.系統思維,全面思考,注重規劃,關注設計,考慮細節,不局限細節,來解決實際問題;
如軟體注冊問題,涉及到使用者安全、角色、權限、密碼加密,驗證碼的問題。
5.平台總體架構不要照搬照抄的現有系統,分析現有系統的利弊,揚長避短,少走彎路,多走捷徑,注重系統的可擴充,可伸縮,未來3-5年擴容與發展;
6.可以利用UML模組化工具,來進一步說明一些技術問題;
7.注重技術的深度,關注技術的廣度;
8.文檔中盡量用書面語,不要出現“我們”口頭語。