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

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




随着时间的流逝，我们得到越来越多的应用程序。确定一个应用程序是否正在使用另一个应用程序的功能可能很困难。如果我们更改应用程序 A 中的某些内容，应用程序 B 中的某些内容会中断吗？

我们一直在使用 MediaWiki 来编写文档，但很难使数据保持最新。

我认为我们需要的是某种事物的视觉 map 。以及创建某种引用完整性的可能性？有任何想法吗？

Answer 1

我在同一条船上，仍然试图向我的同行推销 Enterprise Architect，一个 CASE 工具。这是一个往返工具 - 代码到图表到代码是可能的。它也是一个以 UML 为中心的——尽管它也支持我不熟悉的其他符号方法......

在选择用于记录设计的工具(无论是系统间通信，还是仅设计单个应用程序的内部结构)时，需要考虑以下几点:

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

熟悉记法。

A. 符号，例如 UML，必须是您的员工能够理解的。如果您尝试使用 UML 工具，而只有少数人了解如何正确使用它，您会遇到很大的困惑，因为有些人错误地记录了事情，而了解 UML 内容的人要么发现错误，要么继续执行并实现错误记录的项目。相反，行家使用的更复杂的符号会使外行人感到困惑。

B. 文档不是/不应该仅供文档制作者专用。因此，阅读文档的人必须了解他们正在阅读的内容。因此，获得具有灵活输出选项的工具始终是一个不错的选择。

成本。有比 Enterprise Architect 更先进的工具。我使用这个工具的理由是，由于缺乏 UML 熟悉和高压计划，除了使用基本结构图之外，几乎没有空间来教育我自己或我的同龄人。这个工具很容易促进这样的使用，并且比 StarUML 更稳定。 (我两者都尝试过，StarUML 死于大量代码的逆向工程——数百万行)对于小型项目，我发现 StarUML 适合家庭使用，直到我安装了 vista。作为开源，它也是免费的。

尽管如此，您将始终必须记录什么使用什么，这意味着维护文档!这项任务是少数公司看到的值(value)，尽管它对那些能够完成它的人具有明显的值(value)。 . .