architecture - 软件设计和架构的文档

Question

记录软件设计和架构的最佳实践和软件工具是什么？

1. 基于 Java 或 .NET 的基于 PC 的应用程序？

2. 基于 VxWorks 或嵌入式 Linux 或 Windows CE 的嵌入式应用程序？

我想到的一个工具是Enterprise Architect。这是一个不错的选择吗？

Answer 1

很大程度上取决于文档的目的。读者群是谁？是为了推动开发活动而使用它，还是为了提供一些历史记录而生产它？制作/使用本文档的团队有多大？

在我们的小型开发团队中，我们发现笔/纸和 wiki 足以容纳大多数架构/设计文档。一些设计/架构决策也可以合并到代码注释中（但如果文档用于驱动开发，这显然没有意义。）我们经常使用的两个专业工具是数据库图表/部署工具（例如DBWrench）和 UML 图表工具（例如ArgoUML）。

警告一句：不要编写需要花费大量精力来维护或任何人都不会阅读的文档。