用于记录软件库的 DITA

DITA for documenting software libraries

虽然这不是关于 DITA 的问题 "programming" 我仍然想在大多数用户恰好是开发人员的 Whosebug 社区中提问。

我们公司使用 Doxygen 和 MediaWiki 的组合来记录软件库(例如 QSchematic)。我们觉得 MediaWiki 不是记录软件库的好方法。

我的问题:我应该开始使用 DITA 来记录软件库吗?我已经花了好几个小时使用 DITA 和 DITA-OT,我认为这是一个很好的解决方案,可以记录最终用户直接与之交互的软件组件(例如命令行工具)。但是,我不太确定 DITA 是否是一个很好的文档软件库解决方案。经过大量研究,DITA 似乎并未被软件(库)开发人员广泛使用。 DITA 提供专业化,允许为此目的设置自定义主题,但网络上似乎没有其他人这样做,我想知道将 DITA 用于此目的是否存在根本性错误。

DITA 可能是一个不错的选择,它提供了您需要或将来可能需要的所有功能。也许像 read-the-docs 或 Swagger 这样的工具也适合,但这取决于您要创建的文档,因此在不了解您的库和内容的情况下很难回答。 DITA 具有可重用性和灵活性的优点。您可以使用外部代码片段,在概念主题和任务主题中重复使用部分参考文档,让您有能力实现任何您可以想象的事情。