architecture - 技术设计文件的工具和标准

Question

就目前而言，这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the help center寻求指导。




10年前关闭。




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

过去，在我的公司中，我们只提供客户端-服务器双赢应用程序，我们的设计文档有文字模板。我们的模板总是从数据库图表开始，然后是 UI 模型、字段映射、功能描述等……有了 Word 和 Visio，我们已经受够了。但最近我们正在结合 Wiki、UML 图、原型(prototype)工具等……没有真正强有力的标准和工具政策。您认为让建筑师在每个项目的特定时刻自由选择他们认为合适的工具和标准集是好的还是公司应该强制执行和标准化这一点？

Answer 1

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

也就是说，设计文档通常用于启动项目或系统。此后记录良好的代码和一些基本文档就足够了。我可能会更加关注文档的组织，以便人们将来可以轻松找到他们正在寻找的内容。它可以帮助强制执行某种标准的存储库结构/系统来存储文档，但不一定坚持使用各种模板来存储文档。关注内容而不是工具。