Рабочий процесс для превращения контента Wiki в системное руководство
Мы находимся в процессе развертывания новой системы программного обеспечения для множества пользователей во многих местах (более 200 пользователей в 8 странах). В прошлом мы писали руководство для пользователей, а затем обновляли его время от времени. Это работает нормально, так как все пользователи имеют одно и то же руководство, и оно охватывает основные вещи, но у него есть свои проблемы, так как оно не обновляется так часто, мы иногда пропускаем обновления, и у некоторых пользователей будут старые копии.
Мы говорили об использовании вики на этапах тестирования и развертывания для создания базы знаний о системе. В идеале нам бы хотелось каким-то образом преобразовать это в какую-то форму для электронного документа, которую мы могли бы затем "симпатизировать" и разослать в качестве официального руководства, а также позволить пользователям использовать и обновлять вики.
Кто-нибудь еще делал что-нибудь подобное? Любые предложения для вики-систем, рабочих процессов, форматов документов и т. Д.?
6 ответов
Большинство вики поддерживают экспорт через PDF, например:
Вы можете написать что-то, что генерирует LaTeX из вики и выводит руководство в PDF. С такими пакетами, как hyperref, вы можете сохранять перекрестные ссылки в виде гиперссылок.
Кроме того, вы можете интегрировать контент из нескольких источников, таких как словарь данных, в документ LaTeX, который можно смешивать и сопоставлять с вики-контентом. Вы также можете настроить архитектуру, чтобы она могла поддерживать перекрестные ссылки, которые идут в любом случае.
Framemaker также может поддерживать это, используя сгенерированные MIF- файлы, и вы также можете использовать Lout аналогичным образом или конвертировать свой вики-контент в docbook, что позволит вам использовать любой из многих параметров рендеринга, доступных для этого формата.
Кроме того, в следующих публикациях Stackru обсуждаются различные системы поддержки документации.
Madcap Flare - это инструмент для создания справки и руководства, который использует HTML в качестве источника для каждой темы. Вы можете довольно легко выполнить массовый импорт страниц Wiki. Затем потребуется некоторая очистка, но после этого у вас будет хорошая система с одним источником, которая может выводить CHM, веб-справку, PDF, DOC/DOCX и т. Д.
Я дал предыдущий ответ, который может быть полезен для части "wiki to PDF" - посмотрите на использование открытого кода или функциональности PediaPress. Вы также можете получить ODF-файлы, хотя их PDF-файлы уже довольно красивые (но, возможно, вы захотите переименовать их и изменить стиль для своей компании).
Как вы храните источник справки в данный момент? Это файлы MS Word, MS Help, LaTeX?
Если вы поместите исходные файлы справки под контроль версий, то вы получите все преимущества вики, не переходя на новую систему - люди могут легко вносить изменения в файлы справки - эти изменения можно отслеживать, отменять и т. Д., И вы получить предварительно проверенные руководства, как и раньше.
Я перешел по ссылкам Node и наткнулся на некоторые страницы вики-медиа, которые, на мой взгляд, заслуживают внимания.