📈系统架构文档是整个项目最重要的起点,但很多人第一章就“写穿了”: 不是写得太细,就是没有重点。想要写出高质量、能协作、能传承的架构文档,这一篇会告诉你应该怎么做——
✅ 架构总览的终极目标
明确边界、定义角色、画清数据流
别讲执行细节,别深入函数调用。
✅ 架构总览回答四个问题:
分类 | 应该讲 | 不应该讲 |
---|---|---|
模块 | 有哪些模块,每个负责什么 | 模块内怎么实现功能 |
关系 | 模块之间怎么协作 | 模块里函数怎么写 |
流向 | 数据怎么流、事件怎么驱动 | 哪个 API 要怎么调用 |
规则 | 系统行为守则(不调用、不耦合) | 状态机怎么切换 |
🎯 一句话总结边界感:
架构总览只负责回答“谁做什么、怎么配合”,不负责解释“他是怎么做的”。