WebHelp можно назвать форматом весьма условно. По сути это разновидность справочной системы, реализованной в виде автономного сайта, для работы которого не требуется веб-сервер. Для обозначения WebHelp часто используется термин-синоним: веб-справка или browser-based help (справка для просмотра в браузере).
Справочная система WebHelp может быть развернута на локальном компьютере, в локальной сети, в сети Интернет, либо быть комбинированной — использовать локальные и сетевые ресурсы (как, например, система справки в Windows XP). Для просмотра WebHelp необходим современный веб-браузер. Поэтому веб-справка совместима со всеми платформами, в том числе с Windows, Linux, Mac OS X, Unix и другими.
Термин WebHelp был придуман в 1994 г. По данным опроса, проведенного WritersUA среди технических писателей в 2014 г., WebHelp занимал 2 место (73%) по популярности после формата PDF (77%).
Применение WebHelp
Справочная система WebHelp может быть использована в следующих случаях:
- справка для веб-приложений;
- справка для CRM- и BMS-систем;
- справка для кроссплатформенных приложений;
- справка для приложений на .NET;
- руководство пользователя / интерактивное руководство, к которым требуется организовать онлайн-доступ;
- ответы на вопросы / база знаний службы технической поддержки;
- база знаний компании;
- должностные инструкции, регламенты, внутренняя документация компании, которые должны быть доступны в локальной сети;
- электронная книга / методический материал, используемые для онлайн-обучения.
Как выглядит WebHelp
Благодаря возможностям HTML, CSS и JavaScript, внешний вид веб-справки может быть совершенно разным. Его можно практически полностью адаптировать под требования заказчика (реализовать дизайн-макет, учесть требования фирменного стиля и т.д.). При создании WebHelp используется кроссбраузерная верстка, благодаря чему WebHelp практически одинаково отображается и работает во всех современных веб-браузерах. Использование адаптивных шаблонов позволяет оптимизировать WebHelp для просмотра с экранов мобильных устройств. Внешний вид WebHelp меняется автоматически в зависимости от разрешения экрана. Вот несколько примеров WebHelp:
Как работает WebHelp
WebHelp представляет собой набор файлов в какой-либо папке (веб-сайт):
- веб-страницы в формате HTML или HTM;
- рисунки в форматах JPEG, PNG, GIF и др.
- таблицы стилей CSS;
- скрипты JS;
- другие файлы, необходимые для работы сайта.
В папке с файлами могут быть вложенные папки (например, для организации таблиц стилей и скриптов). Для запуска веб-справки, как правило, используется расположенный в корне сайта файл index.html или default.html.
По функционалу WebHelp соответствует формату HTML Help, либо превосходит его. Современная справочная система WebHelp представляет собой сложное веб-приложение. В нем есть и динамическое оглавление, и указатель, и полнотекстовый поиск. В WebHelp можно интегрировать мультимедиа-контент: аудио- и видеофайлы. В самом простом варианте WebHelp может быть сайтом со статическим оглавлением и набором веб-страниц с текстом.
Как создать WebHelp
Самый простой WebHelp можно реализовать следующим образом: подобрать бесплатный HTML-шаблон и наполнить его контентом при помощи визуального HTML-редактора (платного или бесплатного). Для этого необходимы базовые знания HTML и CSS. Чтобы создать WebHelp профессионального уровня таким способом, потребуются глубокие знания HTML, CSS, JavaScript и т.д. Основной плюс — данный способ не требует вложений (только знания и время). Основной минус этого способа — высокая трудоемкость создания, поддержки и обновления справочной системы.
Справочную систему WebHelp профессионального уровня с динамическим оглавлением, ключевыми словами и поиском можно также создать при помощи специализированных программ для разработки справки. Эти программы также позволяют максимально эффективно поддерживать справку в актуальном состоянии. Самыми популярными являются Adobe RoboHelp и Help & Manual. Есть также и другие платные, условно бесплатные и бесплатные программные средства, обладающие более скромными возможностями.
