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

Question

我想知道我的同事现在使用哪些工具和标准来制作技术设计文档。

在过去，当我在我们公司时，我们只提供客户端服务器赢取应用程序，我们为我们的设计文档提供了单词模板。我们的模板总是从数据库图表开始，然后是UI模型，字段映射，功能描述等等。对于Word和Visio，我们已经有足够的了。但最近我们正在将Wiki，UML图表，原型工具等结合起来......对标准和工具没有真正强有力的政策。你认为给予架构师自由选择他们认为在每个项目的特定时刻适合的工具和标准是否有益，或者公司是否应该强制执行这些工具和标准？

Answer 1

任何设计文档背后的原因都是与所有相关人员之间的明确沟通。因此，从这个角度来看，无论您作为架构师选择哪种工具，都需要现在由所有参与者读取完成的产品，然后由维护人员读取。因此，选择至少一些相当标准的工具是有道理的，这些工具在未来几年仍将存在。

也就是说，设计文件通常用于使项目或系统启动和运行。此后有足够的文档记录代码和一些基本文档应该足够了。我可能会更多地关注文档的组织结构，以便人们可以很容易地找到他们未来寻找的内容。它可以帮助执行某种标准的存储库结构/系统来存储文档，但不一定要坚持各种各样的文档模板。关注内容而不是工具。

Answer 2

除非您的项目是千篇一律的，否则只有将最佳工具组合应用于手头工作才有意义。也就是说，可能需要一些宽松的（粗略的指导方针）或狭义的（适用于特定的环境）标准。

Answer 3

在我看来，首席开发人员或团队成员（可能记录在后面）之间的深入讨论比任何文档都更有价值。给他们所有的选择工具的自由，并要求他们在早期写出高层技术决策的简短摘要。这可以成为项目后续文档的基础。技术设计文件过早过早，需要花费太多时间来编写。

Answer 4

我认为应该有一套工具和标准在体系结构时指定，描述应该如何记录设计。有一个记录这些事情的标准是非常重要的;否则，他们倾向于站不住脚;如果设计文档是异构的，那么真正需要了解设计最多的人可能无法在真正需要设计信息时找到他们真正需要的设计信息。

也就是说，工具和标准的选择完全取决于每个不同的组织;无论一个组织的作品是否适合他们。只要标准（以及某种程度上的工具）保持一致，为个别组织选择的任何内容都适合他们。它只是需要决定并执行。