??系統架構文檔是整個項目最重要的起點,但很多人第一章就“寫穿了”: 不是寫得太細,就是沒有重點。想要寫出高質量、能協作、能傳承的架構文檔,這一篇會告訴你應該怎么做——
? 架構總覽的終極目標
明確邊界、定義角色、畫清數據流
別講執行細節,別深入函數調用。
? 架構總覽回答四個問題:
分類 | 應該講 | 不應該講 |
---|---|---|
模塊 | 有哪些模塊,每個負責什么 | 模塊內怎么實現功能 |
關系 | 模塊之間怎么協作 | 模塊里函數怎么寫 |
流向 | 數據怎么流、事件怎么驅動 | 哪個 API 要怎么調用 |
規則 | 系統行為守則(不調用、不耦合) | 狀態機怎么切換 |
?? 一句話總結邊界感:
架構總覽只負責回答“誰做什么、怎么配合”,不負責解釋“他是怎么做的”。