架構設計文檔 (轉)

很多同學問做架構設計,怎麼才能寫出比較好的文檔。其實很簡單,都是有套路的,今天剛好借這個機會,和大家分享下一般做架構設計該怎麼寫文檔。 背景 首先介紹下項目背景、基於什麼原因需要需求。 如果是新產品,描述下產品啓動的原因和背景、產品定位 如果是升級版本,描述升級需求、對原系統的影響,以及到達的預期效果 名詞解釋 文檔中出現新的或者不常見的名詞、概念給出定義和解釋。 設計目標 實現功能 大致描述系統
相關文章
相關標籤/搜索