Разработка файлов-справок для программного обеспечения

Что позволяет пользователю получить базовую информацию по регулировке и применению программы? Конечно, справочная система, а точнее, Help-справка. Справка представляет собой файл, по назначению схожий с руководством пользователя. Различие состоит в возможности вызова справки из самой программы.

Файл-справка может быть встроена в веб-сайт компании. В таком случае справка представляет собой маркетинговый материал, который обладает SEO-эффектом. При размещении справочной системы в сети Интернет компания разгружает работу технической поддержки.

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

Файлы-справки для приложений, работающих на операционной системе Windows, создаются в формате CHM (Microsoft Compiled HTML Help). Для просмотра CHM-файлов, как правило, используют средство – hh.exe, которое входит в любую версию Windows. Для размещения в сети Интернет разработчики справок используют формат HTML, а для мобильных платформ (iOS, Android) прибегают к формату ePUB.

Справочные системы содержат:

• разделы программы;
• перекрестные ссылки;
• оглавление;
• навигацию.

В Help-справку, как правило, включают следующую информацию:

• назначение и применение программы;
• использование диалоговых панелей и меню;
• рекомендации по выполнению функций и процедур с примерами;
• глоссарий;
• иллюстрации.

В процессе создания справочной системы необходимо учитывать требования от заказчика к структуре справок и используемым графическим элементам. Следует изначально определить необходимый формат справки и степень подробности описания. Немаловажно принимать во внимание корпоративный стиль компании. Кроме того, справочная система должна быть удобна для будущих пользователей.

Для создания Help-справки применяют ряд специальных программ: Microsoft HTML Help Workshop, KEL CHM Creator, HelpNDoc, Help&Manual, Dr. Explain, Adobe RoboHelp и др.

Microsoft HTML Help Workshop ориентирован на разработчиков. Платформа является бесплатной, что рождает высокий спрос у широкого круга пользователей. Программа не имеет русскоязычного интерфейса, что может стать весомой помехой для освоения.

Еще одной бесплатной программой для создания справок является KEL CHM Creator. Программу можно установить на любую версию Windows. Платформа корректно работает с кириллицей. Минус платформы – ограниченные настройки CHM.

HelpNDoc – бесплатное средство для разработки Help-справки. Средство корректно работает с кириллицей. Для освоения платформы потребуется знание английского языка, т.к. все инструкции к ПО представлены на нем. Программа поддерживает следующие выходные форматы: CHM, PDF, DOCX, HTML, ePUB, Markdown, Qt, Kindle.

Help&Manual позволяет создавать справочные системы в различных форматах (CHM, HLP, HXS, HTML, PDF, RTF, EXE, XML). Интерфейс программы очень напоминает интерфейс MS Word. Справку можно создать на одном из 106 языков мира. Help&Manual – платная платформа.

Dr. Explain – российская разработка для создания пользовательской документации. Программа позволяет осуществлять мгновенный просмотр CHM и HTML. К недостаткам Dr. Explain относят отсутствие многопользовательского редактирования.

Программа Adobe RoboHelp долгое время была единственным инструментом для создания Help-справок. Платформа поддерживает многопользовательское редактирование. При помощи Adobe RoboHelp можно создать следующие типы файлов: CHM, XML, ePUB, DOCX, WinHelp, PDF и др. Главный недостаток платформы – высокая цена.

На данный момент многие программы, в связи с событиями на мировой арене, недоступны на территории РФ. Тем не менее, появился инструмент для миграции из популярных платформ – «Документерра», поддерживающий форматы CHM, PDF, DOCX, HTML и др.