作为一名软件工程师，我花了很多时间阅读和编写设计文档。在完成了数百篇这些文档之后，我亲眼目睹了优秀设计文档与项目最终成功之间的强烈关联。
本文试图描述使设计文档变得更好的原因。
本文分为4个部分：
为什么要写一份设计文件
什么在设计文档，包括
怎么写
围绕它的过程
为什么要写一个设计文件？设计文档 - 也称为技术规范 - 描述了您计划如何解决问题。
关于为什么在进入编码之前编写设计文档很重要的原因已经有很多文章。所以我在这里说的是：
设计文档是确保正确工作完成的最有用工具。
设计文档的主要目标是通过强迫您思考设计并收集其他人的反馈来提高您的效率。人们通常认为设计文档的目的是教会其他人关于某个系统或稍后作为文档。虽然这些可能是有益的副作用，但它们本身并不是目标。
作为一般的经验法则，如果您正在处理可能需要1个工程师月或更长时间的项目，那么您应该编写设计文档。但不要止步于此 - 许多小型项目也可以从迷你设计文档中受益。
大！如果您还在阅读，您会相信设计文档的重要性。但是，不同的工程团队，甚至同一团队的工程师，经常以不同的方式编写设计文档。让我们来谈谈优秀设计文档的内容，风格和流程。