为什么你需要一份「系统设计文档」

为什么你需要一份「系统设计文档」

很多程序员不喜欢写文档——"代码就是文档"、"我写的代码自己都看得懂"。

但项目大了、团队大了,「系统设计文档」是必须的。


一、什么是系统设计文档

不是 API 文档,不是代码注释。

是回答这个问题:这个系统是怎么设计的、为什么这么设计

内容包括:


二、为什么需要

1. 自己做决定的时候有记录

半年后回头看:"当时为什么选这个方案?"

文档能回答,记忆不能。

2. 新人接手有参考

新来的程序员不需要"猜",有文档可以参考。

3. 和 PM/管理层沟通有工具

不用讲技术细节,直接看架构图。


三、什么时候写

不是"项目做完再补",是项目开始前写

"系统设计文档"的意义不是"记录",是让决策者把设计想清楚

写文档的过程就是思考的过程。


四、怎么写

原则:够用就好,不要完美主义

文档是给团队看的,不是给评审看的。

格式:


五、一句话总结

系统设计文档不是负担,是让你"想清楚再做"的工具


标签: 系统设计, 技术文档, 开发流程, 团队协作, 架构

/*]]>*/