Рабочий процесс для преобразования содержимого Wiki в системное руководство

Question

Мы находимся в середине развертывания новой системы программного обеспечения для пользователей большого количества мест в лотах (более 200 пользователей более чем в 8 странах). В прошлом мы написали руководство для пользователей, а затем обновляем его так часто. Это работает нормально, поскольку все пользователи имеют одно и то же руководство, и оно охватывает основные вещи, но у него есть свои проблемы, например, он не обновляется, часто мы иногда пропускаем обновления, а некоторые пользователи будут иметь старые копии.

Мы говорили об использовании вики на этапах тестирования и развертывания для создания базы знаний о системе. В идеале мы хотели бы каким-то образом преобразовать это в какую-то форму электронного документа, который мы можем тогда «красиво-фи» и отправить в качестве официального руководства, а также позволить пользователям использовать и обновлять wiki.

Кто-нибудь еще сделал что-то подобное? Любые предложения для вики-систем, рабочих процессов, форматов документов и т. Д.?

Answer 1

Большинство вики поддерживает экспорт через PDF .: например

• MediaWiki PDF Export
• DokuWiki PDF Export
• TWiki PDF Export

Answer 2

Как вы складированию источника помощи в данный момент? Это файлы MS Word, MS-помощь, LaTeX?

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

Answer 3

Вы можете написать что-то, что генерирует LaTeX из wiki и предоставляет руководство по PDF. С пакетами, такими как hyperref, вы можете сохранить перекрестные ссылки в виде гиперссылок.

Кроме того, вы можете интегрировать контент из нескольких источников, таких как словарь данных, в документ LaTeX, который можно смешивать и сопоставлять с содержимым вики. Вы также можете настроить архитектуру, чтобы она могла поддерживать перекрестные ссылки, которые идут в любом случае.

Framemaker также может поддерживать это, используя созданные MIF файлов, и вы можете также использовать Lout подобным образом или конвертировать содержимое вики в docbook,, который позволил бы использовать любого из множества вариантов визуализации, доступных для этого формата.

В качестве дополнительной информации, следующие публикации Stackoverflow обсуждают различные системы для ведения документации.

• Application (Not a Markup Language) for Producing a User Manual

• Can LaTeX be used for producing any documentation that accompanies software?

• What tools are used to write documentation?

• What tools does your team use for writing user manuals?

• How best to write documentation (ideally in latex) targeting both the web (html) and paper (pdf)?

• Best tool(s) for working with DocBook XML documents?

• What is the recommended toolchain for formatting XML DocBook?

• Is a successor for TeX/LaTeX in sight?

Answer 4

Я последовал ссылки узла и наткнулся на некоторых Mediawiki страниц, которые я думал, заслуживают внимания.

• Extension:OpenDocument Export
• Extension:PDF Writer
• Category:Data extraction extensions

Answer 5

Madcap Flare является помощь-и-ручной инструмент разработки, который использует HTML для источника каждой темы. Вы можете довольно легко сделать массовый импорт страниц Wiki. Затем потребовалось бы некоторое очищение, но после этого у вас будет хорошая система с одним источником, которая может выводить CHM, с возможностью просмотра через веб-интерфейс, PDF, DOC/DOCX и т. Д.

Answer 6

Я дал previous answer, которые могут быть полезны для "wiki в формате PDF "- посмотрите на код или функциональность PediaPress с открытым исходным кодом. Вы также можете получить ODF от них, хотя их PDF-файлы уже довольно хороши (но вы можете захотеть ребрендинг и рестилировать его для своей компании, я полагаю).