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

При создании руководства к программному продукту необходимо чётко представлять себе его содержание, объём работ, а также выбрать инструмент для его создания. Инструменты для разработки справочной документации (Help Authoring Tools - HAT) – это редакторы или конверторы, предназначенные для создания печатных руководств, онлайн-хэлпов, справочных систем.

Для небольших файлов справки будет вполне достаточно текстового редактора и конвертора (HTML, PDF, WinHelp). Но при разработке масштабных справочных систем вам понадобится инструмент, поддерживающий многопользовательское редактирование, технологию единого источника документации, а также импорт и экспорт множества форматов справочной документации (XML, CHM, RodoHelp, RTF …). Также при локализации программного продукта просто необходимо иметь программу с возможностью перевода на различные языки. Ниже представлены наиболее распространённые и функциональные средства разработки справочной документации:

Doc-o-Matic 7 Professional

Профессиональный инструмент для создания справочной документации. Применяется в основном для документирования исходного кода программ, полезен для разработчиков. Можно создавать файлы справки в следующих форматах: PDF, HTML Help, Help 2, Help 3, Web Help/browser based HTML, Windows Help и XML.
Преимущества: поддержка синтаксиса различных языков программирования; поддержка XML Doc и JavaDoc; поставляется с предустановленными шаблонами для широко используемых стандартов документации (MSDN, Visual Studio); поддержка технологии единого источника; имеет компилятор командной строки; есть возможность просмотра отчётов по проекту.
Недостатки: является довольно сложным в использовании; перевод необходимо выполнять в самой программе.
Цена: $199 – 999 http://www.doc-o-matic.com/

Doc-To-Help 2011

Отличительной чертой данной программы является возможность использования нескольких редакторов (даже в одном проекте): внутреннего редактора программы, Microsoft Word и любого HTML редактора. Эта функция очень полезна при обработке данных из нескольких разных источников. Форматы выходных документов: HTML Help, JavaHelp, Doc, PDF, CHM, HTM, MSHC, HLP, Help 2.
Преимущества: поддержка многих языков; встраивается в виде надстройки в Microsoft Word и Adobe Dreamweaver; имеет дружественный интерфейс и удобный пошаговый мастер; в комплекте с программой устанавливаются шаблоны для различных документов (XML, Word, HTML); возможность многопользовательского редактирования; использование стилей CSS.
Недостатки: для создания печатных руководств (или PDF) требуется наличие Microsoft Word; довольно высокая стоимость.
Цена: $100 – 1195 http://www.doctohelp.com/

Dr.Explain 4.5

Простая и надёжная программа, для создания справочной документации в форматах HTML, CHM, RTF, PDF. Идеальный вариант для тех, кто хочет сделать качественную справку, не имея специальных знаний в данной области.
Преимущества: простой и интуитивный интерфейс; встроенный модуль захвата экрана, который самостоятельно делит изображение на области; удобная панель инструментов; полезный редактор изображений, в котором можно расставить стрелки и подписи для объектов; мгновенный просмотр CHM и HTML; модуль проверки правописания.
Недостатки: отсутствие многопользовательского редактирования; поддержка только основных форматов справки.
Цена: $165 – 245 http://www.drexplain.com/

Adobe FrameMaker 10

Программа предназначена в основном для создания и вёрстки больших документов, которые потом будут печататься. Форматы файлов справки: HTM, RTF, PDF, XML, Adobe AIR®, FlashHelp®, EPUB, JavaHelp, Eclipse Help, and Oracle Help.
Преимущества: поддержка технологии DITA; мастер настройки рабочего пространства; поддержка скриптов (Adobe® ExtendScript); удобная работа с текстом (перетаскивание, подсветка, форматирование); возможность вставки 3D-моделей, анимации и SWF; большие возможности для редактирования графики; история действий; поддержка CMS.
Недостатки: программа слишком сложная для обычного пользователя; поддерживает мало языков.
Цена: $999 http://www.adobe.com/products/framemaker.html

Help & Manual 6

Этот продукт имеет отличное соотношение цена-качество и подойдёт как для отдельных авторов, так и для целых компаний. Поддерживает следующие выходные форматы: CHM, HLP, HXS, HTML, PDF, RTF, EXE (e-Book), XML, ePUB.
Преимущества: удобный интерфейс; предпросмотр печати файлов; встроенный редактор изображений Impict; проверка правописания; присутствует модуль захвата экрана; условные выражения для текста в различных форматах; быстрая компиляция файлов; импорт различных форматов файлов, включая RoboHelp; создание документов на 106 языках мира; сохранение проектов в несжатом XML формате, который может быть сразу переведён на иностранные языки с помощью внешних редакторов; возможность декомпиляции файлов HLP; поддержка многопользовательского редактирования.
Недостатки: в дизайнере для печати отсутствует расстановка переносов, форматирование колонок.
Цена: $499 - 1295 http://helpandmanual.com

MadCap Flare v7

Очень мощный и профессиональный инструмент для технического писателя. Является частью пакета программ MadPak. Генерирует документы PDF, XPS, DOCX, XHTML, Web Help, HTML Help, .Net Help, DITA, Mobile help.
Преимущества: удобный пошаговый мастер; разнообразные шаблоны файлов справки; окно динамической помощи; поддержка технологии единого источника; создание PDF без внешнего текстового процессора; большое количество обучающих видео и текстов к программе; использование ведущих страниц (master page); профессиональная технология перевода (MadCap Lingo); работа со сложными текстовыми структурами (выпадающие тексты, списки); эффективная командная разработка и взаимодействие (интеграция Microsoft SharePoint).
Недостатки: высокая цена; настройка и использование будут сложны для среднего пользователя.
Цена: $999 www.madcapsoftware.com

Adobe RoboHelp 9

Долгое время программа RoboHelp была единственным стандартом среди инструментов для разработки справочной документации. Сейчас некоторые конкуренты обогнали RoboHelp по эффективности и удобству. Эта программа создаёт следующие типы файлов: PDF, WebHelp, Adobe AIR®, FlashHelp®, JavaHelp, Microsoft HTML Help, WinHelp, DOCX, XML, CHM, ePub.
Преимущества: возможность многопользовательского редактирования; поддержка общих ресурсов для многократного использования; поддержка скриптов; редактор интерфейса Adobe® AIR® Help Skin Editor; поддержка последних версий браузеров, платформ и устройств; импорт и экспорт в Microsoft Word 2010; поддержка шаблонов страниц; вставка более 20 форматов изображений с помощью Adobe® RoboScreenCapture®; быстрая генерация файлов в формат ePub; предварительный просмотр выходного файла в различных браузерах.
Недостатки: высокая цена; требуется установить Microsoft Word; плохо адаптирован для перевода документов; состоит из 2 программ - RoboHelp HTML и RoboHelp for Word.
Цена: $999 - 1999 http://www.adobe.com/products/robohelp.html

HelpSmith 3.5

Недорогая полезная программа для создания справки, генерирующая файлы в форматах CHM, HTML, PDF, Web Help, RTF.
Преимущества: встроенный текстовый процессор с поддержкой Unicode; проверка правописания с поддержкой многих языков; пользователь не должен обладать знаниями HTML или CSS; отдельное хранилище медиа-информации в проекте; функция слияния проектов для коллективной работы; различные стили и форматирование.
Недостатки: не такой мощный и гибкий инструмент, как его конкуренты; не является многопользовательской средой; отсутствует экспорт для внешнего перевода; отсутствует непосредственный экспорт PDF (только RTF).
Цена: $199 http://www.helpsmith.com