问技术设计文档的工具和标准

EN

任何设计文档背后的原因都是与所有相关人员进行清晰的沟通。因此，从这个角度来看，无论您作为架构师选择了什么工具，最终的产品现在都需要由所有相关人员阅读，以后也需要由维护者阅读。因此，选择至少一些相当标准的工具是有意义的，这些工具将在几年内仍然存在。

也就是说，设计文档通常用于项目或系统的启动和运行。之后，记录良好的代码和一些基本文档就足够了。我可能会更关注文档的组织，这样人们将来就可以很容易地找到他们正在寻找的东西。它可以帮助强制执行某种标准的存储库结构/系统来存储文档，但不一定要坚持所有类型的文档模板。专注于内容，而不是工具。

在我看来，在主要开发人员或团队成员之间进行彻底的讨论(可能会记录下来供以后使用)比任何文档都更有价值。给他们选择工具的自由，并要求他们在早期只写一个高级技术决策的简短摘要。这可以作为项目后面文档的基础。技术设计文档很快就会过时，并且需要花费太多的时间来编写。

我认为应该有一套在体系结构时指定的工具和标准来描述设计应该如何文档化。有一个记录这些东西的标准非常重要；否则，它们往往会半途而废；如果设计文档是异构的，那么真正需要了解设计的人可能无法在真正需要的时候找到他们真正需要的设计信息。

也就是说，工具和标准的选择完全取决于每个不同的组织；任何对组织有效的工具和标准都适合他们。只要标准(和工具，在某种程度上)是一致的，那么为单个组织选择的任何东西都是适合他们的。它只需要被决定，并强制执行。