Architecture 软件设计和体系结构文档

Architecture 软件设计和体系结构文档,architecture,documentation,Architecture,Documentation,记录软件设计和体系结构的最佳实践和软件工具是什么 基于Java的PC应用 还是.NET 基于VxWorks或嵌入式Linux或Windows CE的嵌入式应用程序 我想到的一个工具是。这是一个好的选择吗?很大程度上取决于文档的目的。读者群是谁?它是用来推动开发活动,还是用来提供历史记录?制作/使用此文档的团队有多大 在我们的小型开发团队中,我们发现笔/纸和wiki对于大多数架构/设计文档来说都是足够的。一些设计/架构决策也可以合并到代码注释中(但如果要使用文档来驱动开发,这显然没有意义)。我们经

记录软件设计和体系结构的最佳实践和软件工具是什么

  • 基于Java的PC应用 还是.NET

  • 基于VxWorks或嵌入式Linux或Windows CE的嵌入式应用程序


  • 我想到的一个工具是。这是一个好的选择吗?

    很大程度上取决于文档的目的。读者群是谁?它是用来推动开发活动,还是用来提供历史记录?制作/使用此文档的团队有多大

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


    警告:不要制作需要花费大量精力才能维护或任何人都无法阅读的文档。

    您的文档将用于什么用途?对于基于PC的Java和.NET应用程序,我推荐这10个免费工具:如果你能为企业应用程序购买许可证,我认为enterprise Architect和IBM Rational是最好的。它们易于使用,具有良好的用户界面,支持逆向工程和代码生成。