代码之家 › 专栏 › 技术社区 › bhadra

软件设计和体系结构文档[已关闭]

documentation architecture

bhadra · 技术社区 · 17 年前

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

我想到的一个工具是 Enterprise Architect . 这是一个好的选择吗?

1 回复 | 直到 12 年前

Peter Howe 17 年前

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

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

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

推荐文章

Ruben P. Grady · 每种架构都有单独的构建,但生成的APK文件是相同的吗?

1 年前

Emanoel Aleixo · 关于使用GetX的Flutter MVVM体系结构

2 年前

newbieitTech · GET、LIST、…的单一实现。。。独立原型文件的端点

2 年前

Rubem Pacelli · 指针的存储内存地址的增加不应该取决于系统的体系结构吗?

2 年前

Benjamin · 如何解决运行时模型与运行时无关表示之间的不一致

3 年前

Community wiki · Javascript体系结构/应用程序结构最佳实践?

3 年前

Community wiki · 什么时候去Redis?何时使用MongoDB?[已关闭]

3 年前

Ed Barbu · 一个相对较大的开源代码库/应用程序的示例,它是用过程式风格而不是OOP风格编写的

3 年前

crackanddie · 如何使用Prism UnityContainer制作预览窗口?

3 年前

Kazi · 如何让两个用户同时登录Laravel应用程序

8 年前