Рабочий процесс для превращения контента Wiki в системное руководство - PullRequest
4 голосов
/ 06 марта 2009

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

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

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

Ответы [ 6 ]

4 голосов
/ 06 марта 2009

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

1 голос
/ 06 марта 2009

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

1 голос
/ 06 марта 2009

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

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

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

Кроме того, в следующих публикациях Stackoverflow обсуждаются различные системы для ведения документации.

0 голосов
/ 09 марта 2009

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

0 голосов
/ 06 марта 2009

Я перешел по ссылкам на Node и наткнулся на несколько страниц в медиа-вики, которые, на мой взгляд, заслуживают внимания.

0 голосов
/ 06 марта 2009

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

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

...