Рабочий процесс по превращению содержимого Wiki в системное руководство
https://stackoverflow.com/questions/618508
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Мы находимся в процессе развертывания новой программной системы для большого количества пользователей во многих местах (более 200 пользователей в 8 странах).В прошлом мы писали руководство для пользователей, а затем время от времени обновляли его.Это работает нормально, поскольку у всех пользователей есть одно и то же руководство, и оно охватывает основные моменты, но у него есть свои проблемы, например, оно обновляется не так часто, мы иногда пропускаем обновления, и у некоторых пользователей будут старые копии.
Мы говорили об использовании wiki на этапах тестирования и развертывания для создания базы знаний о системе.В идеале мы хотели бы каким-то образом преобразовать это в некую форму электронного документа, который затем мы могли бы "красиво оформить" и разослать в качестве официального руководства, а также позволить пользователям использовать и обновлять wiki.
Кто - нибудь еще делал что - нибудь подобное ?Есть какие-либо предложения по вики-системам, рабочим процессам, форматам документов и т.д.?
Решение
Большинство вики-сайтов поддерживают экспорт в формате PDF, например:
Другие советы
Вы можете написать что-то, что генерирует Латекс из wiki и переводит руководство в формат PDF.С такими пакетами, как гиперрефлексия вы можете сохранить перекрестные ссылки в виде гиперссылок.
Кроме того, вы можете интегрировать содержимое из нескольких источников, таких как словарь данных, в документ LaTeX, который можно смешивать и сопоставлять с содержимым wiki.Вы также могли бы настроить архитектуру таким образом, чтобы она могла поддерживать перекрестные ссылки, которые идут в любом случае.
Создатель рамок мог бы также поддерживать это, используя сгенерированный МИФ файлы, и вы также могли бы использовать Неотесанный мужлан аналогичным образом или преобразуйте ваш вики-контент в документальная книга, это позволило бы вам использовать любой из множества вариантов рендеринга, доступных для этого формата.
В качестве отступления, в следующих публикациях Stackoverflow обсуждаются различные системы ведения документации.
Madcap Flare - это инструментальное средство для создания справки и руководства, которое использует HTML для Источник каждой темы. Вы можете довольно легко выполнить массовый импорт страниц Wiki. Затем потребуется некоторая очистка, но после этого у вас будет хорошая система с одним источником, которая может выводить CHM, веб-справку, PDF, DOC / DOCX и т. Д.
Как вы храните источник справки в данный момент? Это файлы MS Word, справка MS, LaTeX?
Если вы поместите исходные файлы справки в систему управления версиями, вы получите все преимущества вики без необходимости перехода на новую систему - люди могут легко вносить изменения в файлы справки - эти изменения можно отслеживать, отменять и т. д. и вы получите предварительно проверенные руководства, как и раньше.
Я перешел по ссылкам Node и наткнулся на несколько страниц mediawiki, которые показались мне заслуживающими внимания.
Я дал предыдущий ответ , который может быть полезен для " вики в PDF " часть - посмотрите на использование открытого кода PediaPress или функциональности. Вы также можете получить от него ODF, хотя их PDF-файлы уже довольно симпатичны (но, возможно, вы захотите переименовать его и изменить стиль для вашей компании).
