软件设计和架构的文档

Question

用于记录软件设计和架构的最佳实践和软件工具

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

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

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

Answer 1

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

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

警告：不要制作需要花费大量精力维护或任何人都不会阅读的文档。