Использование wiki для создания онлайн справки

В чем разница между wiki и инструментами для разработки справочной документации (help authoring tool — HAT)? На самом деле между ними есть существенные различия. Wiki по сути представляет собой платформу для совместной деятельности — документы wiki, которые вы выкладываете в сеть или интернет, становятся площадкой для поиска информации, ее обсуждения и обновления.

HAT – это инструмент для создания статического набора документации (даже если вы обновляете документы каждый день, HAT не предусматривает возможности обмена мнениями), имеющий все возможности интегрированной онлайн справки. Большинство HAT приложений имеют следующие ключевые характеристики. Вряд ли можно найти платформу wiki, поддерживающую данные функции на таком же уровне:

• Полностью настраиваемое содержание, в котором вы можете менять порядок тем, настраивать отображение определенных тем или повторно вставлять отдельную тему.
• Интегрированный индекс ключевых слов.
• Интегрированный словарь.
• Инструменты навигации для более простого перемещения по темам, например, инструмент “последовательности просмотра” из RoboHelp.
• Инструменты связывания тем (например, “следующая тема”, “предыдущая тема” или “связанные темы”), встроенные в некоторые HAT.
• Компиляция справки в формат HTML Help (.chm) и WinHelp.
• Поддержка потоков заданий (workflow): черновик, просмотр, публикация.
• Интеграция с приложениями контроля версий, например, VSS или мастер работы с версиями в RoboHelp.
• Автоматическая генерация ID тем, которые вы можете передать разработчикам для встраивания в код, с целью создания контекстных справочных ссылок.
• Сложные шаблоны для тем.

Список характеристик HAT довольно обширный. А что полезного может предложить wiki для организации онлайн справки?

• Wiki страничка – это URL, и вы можете перейти на нее прямо из окна своего приложения.
• Wiki странички постоянно обновляются и совершенствуются техническими писателями, службой поддержки и даже клиентами, которые предлагают свои советы. Такая организация wiki странички позволяет постоянно отображать самую свежую информацию.
• Wiki позволяет добавлять на страничку мультимедийные элементы, например, картинки или ролики Flash.
• Вы можете генерировать PDF, HTML и XML версии ваших страничек wiki.
• Wiki обычно имеет хороший поиск.
• Некоторые wiki имеют контроль версий – все изменения отслеживаются, и вы видите, кто внес каждое изменение, а также можете вернуться к предыдущей версии странички.
• Wiki обычно включает инструменты для динамической интеграции с другими приложениями. Многие wiki позволяют устанавливать плагины или дополнения, которые отображают информацию непосредственно с другой платформы. Например, wiki страничка может отображать список исправленных ошибок, динамически извлекаемых из системы мониторинга задач, такой как JIRA.
• Некоторые wiki платформы позволяют вести блоги. Таким образом, ваша страница документации может включать список последних постов, относящихся к теме страницы. При этом пользователь всегда видит самые свежие посты.
• Ваша платформа wiki также может иметь некоторые интересные средства, которые используются для обхода различных проблем, связанных с использованием wiki.

Направление wiki является достаточно новым и всё время развивается. Одним словом, wiki не обязательно лучше или хуже HAT — это зависит от требований, которые вы предъявляете к своей системе создания документации.