Какую систему документации использовать для руководства пользователя
В настоящее время я пытаюсь найти систему документации (руководство пользователя), которая будет иметь следующие функции:
- файлы документации в текстовом режиме (чтобы svn мог их разложить / объединить)
- возможность использования изображений, таблицы, перекрестных ссылок и оглавления
- экспорт в pdf (или.doc/.odt), который будет поддерживать перекрестные ссылки
Я пробовал уценку для исходных файлов документации и pandoc для экспорта в PDF, но уценка не поддерживает таблицы.
Я действительно ценю любую помощь, которую вы можете оказать.
3 ответа
Мы используем Sphinx для этого сценария.
Он может генерировать HTML, PDF и некоторые другие форматы из файлов ReStructuredText.
И посмотрите на список-таблицу, когда вы хотите добавить сложные таблицы.
Вероятно, наиболее часто используемым решением для документации является XML в Docbook или DITA. Вы, безусловно, можете управлять ими в SVN, а также выполнять сравнения. Они оба предоставляют инструментальные средства обработки со многими типами вывода, включая PDF через XSL FO.
Я использую TeX для электронной и печатной документации