设计文档内容 - 需要什么？

Question

在编写低级设计文档时，必须拥有什么并且很好。对高级文档也重复相同的问题。

Answer 1

假设您正在为某人创建设计文档或为某些目的服务。它需要包含的内容只能由该人或目的决定，当然没有一般的答案。

如果有人要求你写一份设计文件，你应该问他们他们需要什么。

如果您的开发流程规定了设计文档，它也应该指定它包含的内容。

就我个人而言，我同意Jack Reeves的概念the code is the design，我不想写一个单独的设计文档。

如果我需要清楚地思考一个设计，我当然会在白板或纸上绘制一些UML图表和/或笔记，但是如果我能够摆脱它，我宁愿不保留它们。