494 | 软件架构文档规范:如何写好架构文档
场景引入
医生写病历 vs 架构师写文档:
去医院看病,医生在病历本上写:
主诉:头痛3天 诊断:偏头痛 处方:XXX药病人拿着病历,可以去任何医院继续看病,因为信息清晰、完整。
架构文档也是一样——好的文档让后人能继续维护和演进系统。
架构文档的重要性
没有文档会怎样?
没文档的代码 = : "这段代码是张三写的" "张三已经离职了" "代码还在跑" "没人敢动" "怎么办?" "重构!" "从头写!" "又写了一遍!"文档的价值
✓ 知识传承 ✓ 降低风险 ✓ 提高效率 ✓ 便于协作 ✓ 符合规范架构文档体系
1. 架构愿景文档(Vision)
目的:阐述为什么做这个系统 读者:管理层、投资者 内容: - 业务背景 - 核心价值 - 成功标准 - 约束条件2. 架构概览文档(Overview)
<