0

我们必须开发一个协议作为不同公司不同系统之间的接口描述。这些实现将由每家公司的开发人员以不同的语言（未知）进行。

但是，我们希望共同开发基于文本描述的协议。我将拥有当前版本的基本副本，并希望将其发送给所有人以征求意见。

什么是这样做的好工具？

目前我们使用 MS Word 会导致几个问题：

  • 我们需要很多时间来格式化文本。
  • 无法在方法描述中引用数据类型。
  • 不同章节（不同作者）的措辞不同，难以统一。

完美的是：

  • 具有词汇表和自动完成功能的工具。
  • 对具有活动链接的其他项目（方法、数据类型等）的引用。
  • 自动生成人类可读 (PDF-) 文档。

你知道这样的工具吗？

PS：我没有让 Sparx Systems Enterprise Architect 完成这项工作。也许这也有提示？

4

1 回答 1

1

这是一个非常大的问题，因为您可能（应该）希望在协议规范中记录许多可能的方面。最重要的两个是数据结构和消息序列，然后是错误管理、身份验证、计时等。

UML 当然可以用来描述这些事情，Enterprise Architect 非常能够从模型生成多功能文档——它肯定会帮助您解决参考问题。但首先您必须非常严格地确定如何对协议的各个方面进行建模，然后您需要构建必要的 EA 配置/适配。

为了从 EA 中获得高质量的文档，我建议使用对象模型的 DocumentGenerator 类从加载项生成文档，因为这为您提供了比传统 RTF 生成器更大的灵活性 - 一方面，您还可以访问 Word 的 API到 EA 的，因此对文档所做的工作比单独使用 EA 的 API 所能做的要多得多。

在不知道您的协议的规模或复杂性的情况下，我会说对于在编写 EA 改编方面有经验的人来说，这至少需要几周的工作。但是，如果您的项目范围涉及多家公司，那么投资可能是值得的。

于 2013-10-14T20:32:49.070 回答