用于记录软件库的DITA

Question

虽然这不是一个关于DITA“编程”的问题，但我还是想在堆栈溢出社区中问这个问题，在这个社区中，大多数用户都是开发人员。

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

我的问题是:我是否应该开始使用DITA来记录软件库？我花了好几个小时与DITA和DITA-OT一起工作，我认为这是一个很好的解决方案，可以记录最终用户直接与之交互的软件组件(例如。命令行工具)。但是，我不太确定DITA是否是文档软件库的一个很好的解决方案。经过相当多的研究，DITA似乎没有被软件(库)开发人员广泛使用。DITA提供了专门化，允许为此目的设置自定义主题，但是由于web上似乎没有其他人这样做，我想知道使用DITA用于这个目的是否有根本问题。

Answer 1

DITA可能是一个很好的匹配，并提供了您需要或可能需要的所有功能。也许像阅读文档或Swagger这样的工具也是合适的，但这取决于您想要创建的文档，因此如果不知道库和内容，就很难回答。DITA具有重用性和灵活性的优点。您可以使用外部代码片段，在概念性主题和任务主题中重用参考文档的部分内容，从而使您能够实现您可以想象的任何事情。