Documentation 如何记录应用程序以及它们如何与其他应用程序集成？

随着时间的推移，我们得到了越来越多的应用。弄清楚一个应用程序是否正在使用另一个应用程序的功能可能很困难。如果我们更改应用程序A中的某些内容，应用程序B中的某些内容是否会中断

我们一直在使用MediaWiki编制文档，但很难保持数据的最新状态

---

我想我们需要的是一张所有东西的视觉地图。以及创造某种参考完整性的可能性？有什么想法吗？

我也有同样的想法，仍在努力向同行推销企业架构师，一种案例工具。这是一个往返工具-从代码到图表再到代码是可能的。它也是以UML为中心的-尽管它还支持我不熟悉的其他表示法

<> P>这里有一些事情要考虑当选择文档设计工具（它们是系统间通信，或者仅仅设计单个应用程序的内部）：

工具的可用性。也就是说，不仅创建而且维护您感兴趣的数据有多容易

熟悉符号

A.符号，如UML，必须是您的员工理解的符号。如果你尝试使用一个UML工具，有几个人理解如何正确地使用它，你会得到一个大的困惑，因为有些人不正确地记录事情，而理解UML所说的实现的人要么发现错误，要么继续实现错误地记录的项。相反，老手使用的更复杂的符号会使外行感到困惑

B.文件编制不/不应仅为文件编制人员专用。因此，那些将要阅读文档的人必须理解他们正在阅读的内容。因此，获得具有灵活输出选项的工具始终是一个不错的选择

成本。有比企业架构师更高级的工具。我使用这一工具的理由是，由于缺乏对UML的熟悉和高压时间表，除了使用基本结构图之外，几乎没有空间教育我自己或我的同事。这个工具很容易促进这种使用，并且比StarUML更稳定。（我尝试了两者，StarUML死于大量代码的逆向工程——数百万行）对于小型项目，我发现StarUML适合家庭使用，直到我安装了vista。作为开源软件，它也是免费的

---

尽管如此，您将始终必须记录什么使用什么，这意味着维护文档！这项任务是少数几家公司看到了它的价值，尽管它对那些能够做到这一点的人有着明显的价值

+1：好提示！但我不确定这个节目是不是我想要的。可能是因为它看起来像是一个非常冗长的应用程序，所以数据库工具非常冗长，但您不需要使用所有方面。在许多公司，维护文档是一种经常被忽视的做法。最后，这是一个平衡行动，努力与付出。问你自己一个问题：如果FeatureX没有“完整”的设计文档，会有人对它有足够的了解，不会在三年内破坏它吗？如果答案是肯定的，那么略过它“相对安全”，而不是忽略它。这意味着你是对的，当需要维护时，你可以省去额外的爬坡。我希望有更多的选择，但这是唯一一个如果有人喜欢尝试一个免费的uml工具，可以使用ArgoUml的感谢接受。我理解你希望事情变得容易的沮丧心情。