Search code examples
dita

DITA for documenting software libraries


While this is not a question about DITA "programming" I'd still like to ask it within the stackoverflow community where most users would happen to be developers.

Our company uses a combination of Doxygen & MediaWiki to document software libraries (such as QSchematic). We feel like MediaWiki is not a good way of documenting software libraries.

My question: Should I start using DITA to document software libraries? I've spend quite a few hours working with DITA and DITA-OT and I think it's a good solution for documenting software components that the end users directly interacts with (eg. command line tools). However, I'm not quite sure whether DITA is a nice solution to document software libraries. After quite a lot of research it seems like DITA is not widely used by software (library) developers. DITA provides specialization that would allow setting up custom topics for this purpose but as nobody else on the web seems to be doing that I'm wondering whether there's anything fundamentally wrong with using DITA for this purpose.


Solution

  • DITA could be a good fit and provides all features you need or could need in the future. Maybe a tool like read-the-docs or Swagger would also fit, but that depends on the documents you want to create, so is difficult to answer without knowing your libraries and content. DITA has the benefit of reuse and flexibility. You can use external code fragments, reuse parts of your reference docs in conceptual topics and task topics giving you the power to achieve anything you could imagine.