DITA для документирования библиотек программного обеспечения

Question

Хотя это не вопрос о «программировании» DITA, я все же хотел бы задать его в сообществе stackoverflow, где большинство пользователей оказались разработчиками.

Наша компания использует комбинацию Doxygen и MediaWikiдля документирования библиотек программного обеспечения (таких как QSchematic ).Мы считаем, что MediaWiki не является хорошим способом документирования библиотек программного обеспечения.

Мой вопрос: мне следует начать использовать DITA для документирования библиотек программного обеспечения?Я провел довольно много часов, работая с DITA и DITA-OT, и я думаю, что это хорошее решение для документирования программных компонентов, с которыми напрямую взаимодействуют конечные пользователи (например, инструменты командной строки).Однако я не совсем уверен, является ли DITA хорошим решением для документирования программных библиотек.После большого количества исследований кажется, что DITA не широко используется разработчиками программного обеспечения (библиотеки).DITA предоставляет специализацию, которая позволила бы создавать собственные темы для этой цели, но, как кажется, никто в Интернете этого не делает, мне интересно, есть ли что-то принципиально неправильное в использовании DITA для этой цели.

Answer 1

DITA может подойти и предоставляет все функции, которые вам нужны или могут понадобиться в будущем. Может быть, подойдет такой инструмент, как read-the-docs или Swagger, но это зависит от документов, которые вы хотите создать, поэтому сложно ответить, не зная ваших библиотек и контента. DITA имеет преимущество повторного использования и гибкости. Вы можете использовать внешние фрагменты кода, повторно использовать части своих справочных документов в концептуальных темах и задачах, что дает вам возможность достичь всего, что вы только можете себе представить.