虽然这不是有关DITA“编程”的问题,但我仍然想在stackoverflow社区中问这个问题,在这里大多数用户都将是开发人员。
我们公司结合使用Doxygen和MediaWiki来记录软件库(例如QSchematic)。我们觉得MediaWiki不是记录软件库的好方法。
我的问题:我应该开始使用DITA来记录软件库吗?我已经花了很多时间使用DITA和DITA-OT,我认为这是记录最终用户直接与之交互的软件组件(例如,命令行工具)的一个很好的解决方案。但是,我不确定DITA是否是用于记录软件库的理想解决方案。经过大量研究,似乎DITA没有被软件(库)开发人员广泛使用。 DITA提供的专业化功能可以为此目的设置自定义主题,但是由于网络上似乎没人在这样做,所以我想知道为此目的使用DITA是否存在根本错误。
答案 0 :(得分:0)
DITA可能非常适合,并提供您需要或将来可能需要的所有功能。也许像read-the-docs或Swagger这样的工具也适用,但这取决于您要创建的文档,因此在不了解您的库和内容的情况下很难回答。 DITA具有重用和灵活性的优势。您可以使用外部代码片段,在概念性主题和任务主题中重用参考文档的某些部分,从而使您能够实现所能想象的一切。