Блог технического писателя Ильи Жукова

Формат WebHelp

WebHelp можно назвать форматом весьма условно. По сути это разновидность справочной системы, реализованной в виде автономного сайта, для работы которого не требуется веб-сервер. Для обозначения WebHelp часто используется термин-синоним: browser-based help (справка для просмотра в браузере).

Справочная система WebHelp может быть развернута на локальном компьютере, в локальной сети, в сети Интернет, либо быть комбинированной — использовать локальные и сетевые ресурсы (как, например, система справки в Windows XP). Для просмотра WebHelp необходим современный веб-браузер. Поэтому WebHelp совместим со всеми платформами, в том числе с Windows, Linux, Mac OS X, Unix и другими.

Если верить Википедии, термин WebHelp был придуман в 1994 г. По данным опроса, проведенного WritersUA среди технических писателей в 2014 г., WebHelp занимал 2 место (73%) по популярности после формата PDF (77%).

 

 

Как выглядит WebHelp

Благодаря возможностям HTML, CSS и JavaScript, внешний вид WebHelp может быть совершенно разным. Его можно практически полностью адаптировать под требования заказчика (реализовать дизайн-макет, учесть требования фирменного стиля и т.д.). При создании WebHelp используется кроссбраузерная верстка, благодаря чему WebHelp практически одинаково отображается и работает во всех современных веб-браузерах. Использование адаптивных шаблонов позволяет оптимизировать WebHelp для просмотра с экранов мобильных устройств. Внешний вид WebHelp меняется автоматически в зависимости от разрешения экрана. Вот несколько примеров WebHelp:

 

Как работает WebHelp

WebHelp представляет собой набор файлов в какой-либо папке (веб-сайт):

  • веб-страницы в формате HTML или HTM;
  • рисунки в форматах JPEG, PNG, GIF и др.
  • таблицы стилей CSS;
  • скрипты JS;
  • другие файлы, необходимые для работы сайта.

В папке с файлами могут быть вложенные папки (например, для организации таблиц стилей и скриптов). Для запуска WebHelp, как правило, используется расположенный в корне сайта файл 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. Есть также и другие платные, условно бесплатные и бесплатные программные средства, обладающие более скромными возможностями.

 

Источники и дополнительная информация

Статья в Википедии “WebHelp”

Skills and Technologies Survey 2014, by WritersUA

 

Добавить комментарий

Последние статьи

Что нового в Help+Manual 8

10 февраля 2020 года вышла 8-я версия Help+Manual. Любой желающий может бесплатно скачать пробную версию с сайта компании-разработчика и оценить ее потенциал. В течени...

Читать полностью...

Работа со стилями в Help and Manual 7

Чтобы внешний вид нового CHM-файла соответствовал оригиналу, необходимо создать стили, применить их к проекту и очистить встроенное форматирование. Это позволит обеспе...

Читать полностью...

Форматы справки для ОС Linux

В рамках замещения импортного программного обеспечения все больше государственных структур переходят на отечественные сборки Linux. Прежде всего, это Alt Linux и Astra...

Читать полностью...

Сборка CHM-файла в Help and Manual

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

Читать полностью...

Основные настройки проекта в Help and Ma…

Если для сборки справки не используется шаблон (skin-file), внешний вид и основной функционал CHM-справки берется из настроек проекта. В этой статье я расскажу о том, ...

Читать полностью...

Импорт CHM в Help and Manual

Программный комплекс Help and Manual позволяет импортировать документацию из ряда форматов, в том числе, из HTML и CHM. Готовую документацию можно загрузить как в суще...

Читать полностью...

Как отредактировать CHM в Help and Manua…

Если вам нужно внести несколько небольших правок в CHM-файл, такую задачу можно успешно решить при помощи бесплатных программ HTML Help Workshop и Notepad++. Серьезная...

Читать полностью...

Как сделать качественные скриншоты

Равно как звук считается одним из основных показателей качества обучающих видеороликов, пользовательская и техническая документация не может быть признана качественной...

Читать полностью...

Внесение изменений и сборка нового CHM-ф…

Перед тем, как приступить непосредственно к редактированию содержимого CHM-файла, подытожим выполненные заранее подготовительные работы. Определившись с бесплатными пр...

Читать полностью...

Создание и настройка проекта в HTML Help…

Установив необходимые бесплатные программы, мы разобрали исходный файл api.chm и получили 64 файла (подробнее смотрите материал Декомпиляция CHM-файла). Это основная ч...

Читать полностью...

Декомпиляция CHM-файла

Файл в формате CHM представляет собой скомпилированный HTML. В него могут входить HTML-страницы, рисунки, таблицы стилей, скрипты и другие файлы. Подробное описание со...

Читать полностью...

Редактирование CHM бесплатными программа…

Если заказчику или работодателю не принципиально, какое программное обеспечение использовать, я предпочитаю редактировать CHM в Help+Manual 7. Но как показывает практи...

Читать полностью...

Как отредактировать CHM-файл

Пользовательская документация для приложений, работающих в ОС Windows, чаще всего поставляется в формате CHM как встроенная в программу справка. Технические писатели, ...

Читать полностью...

Как создать справку в формате CHM

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для про...

Читать полностью...

Бесплатный локальный сервер HM2GO для We…

Одна из моих предыдущих статей была посвящена особенностям работы WebHelp на локальных компьютерах. Некоторые популярные браузеры, в том числе Google Chrome, Opera и Я...

Читать полностью...

Дата в полном формате с месяцем в родите…

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

Читать полностью...

Все о справке и документации для пользователей!

Следить за новыми статьями:

© Илья Жуков, 2019. Охраняется законом об авторском праве.