如何写出一份优秀的软件设计文档

作者: 程序员阿沐 | 来源:发表于2021-04-06 13:37 被阅读0次

设计文档是确保正确完成工作的最有用工具。它的主要目标是通过强迫你思考设计并收集其他人的反馈来提高你的效率。作为一般经验法则，如果你正在处理可能需要 1 个工程师月或更长时间的项目，那么你应该编写设计文档。但不要止步于此 - 许多小型项目也可以从迷你设计文档中受益。

设计文档中应该包含哪些内容？

标题和参与者

概览：高度概括且内容能让公司所有人都读懂，不超过3段。

背景：描述项目的必要性以及跟技术战略和产品战略的关联性。

目标和非目标：描述项目的目的和可衡量的目标，非目标是指不会修复哪些问题。

里程碑：一个可衡量的检查点列表

当前解决方案：描述当前实现，并提供流程图/用例图。

推荐解决方案：系统架构，有细节。

替代方案：除了上述的解决方案，你还想到了什么？购买第三方解决方案？或者使用开源的？优缺点都有哪些？

监控和警报

跨团队配合方面：工作量？钱？性能？安全漏洞？副作用？

讨论：任何你不确定的公开问题或有争议的决定等。

应该怎么写呢？

写得尽可能简单，使用简单的话、短句、列表、例子等。

添加大量的表格和图示，包括数字。

试着写的有趣，提前发给他人审核。

网友评论

本文标题：如何写出一份优秀的软件设计文档

本文链接：https://www.haomeiwen.com/subject/lvzqkltx.html

如何写出一份优秀的软件设计文档