как использовать Dokuwiki для создания общего руководства пользователя

Question

Я пытаюсь использовать Dokuwiki для создания руководства пользователя программного обеспечения, учитывая, что мне нужно создать 3 руководства пользователя для одного и того же продукта на разных платформах, и изменений намного меньше.Есть ли способ в Dokuwiki создать общее руководство пользователя, которое можно использовать для разных продуктов?

Answer 1

Для специфики DokuWiki я бы порекомендовал плагин site export (в первую очередь потому, что я его сделал, и мы используем его также и для нашей документации).

Вы можете создавать главы своей книги, как обычные страницы в вашей вики. Когда дело доходит до объединения их в разные книги, создайте страницу под названием «toc» в другом пространстве имен. Там есть следующий синтаксис (подробности см. На странице github):

  * [[namespace:chapter1]]
    * [[namespace:chapter1.1]]
    * [[namespace:chapter1.2]]
  * [[namespace:chapter2]]
    * [[namespace:chapter2.1]]
    * [[namespace:chapter2.2]]

Теперь вы можете экспортировать это пространство имен с включенной опцией roc - и объединить в один документ. Теперь вы также можете использовать экспорт PDF с пользовательскими книжными стилями (это то, что мы делаем в первую очередь).

Answer 2

Этот ответ относится к любому вики-движку, а не только к DokuWiki.

По сути, вам нужно выделить общую часть документации на отдельные страницы, которые могут быть включены в страницы, относящиеся к конкретному продукту.Для DokuWiki это требует подключаемый модуль ( www.dokuwiki.org / plugin: include ), хотя transclusion часто является основной функциональностью вики.Я бы предложил начать писать документацию для наиболее распространенного продукта, а затем вернуться, чтобы посмотреть, какие части можно извлечь для использования в общей документации.