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

Формат WebHelp

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

Благодаря возможностям 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. Есть также и другие платные, условно бесплатные и бесплатные программные средства, обладающие более скромными возможностями.

 

 

 

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

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

Поиск в WebHelp находит удаленные раздел…

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

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

Контекстная справка в приложениях Window…

Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...

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

Как поддерживать скриншоты в актуальном …

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

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

Книга «Разработка технической документац…

Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...

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

Перевод выходных документов в Help and M…

Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...

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

Размер и расположение окна CHM при перво…

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

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

Рваные края скриншотов в Help and Manual…

Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...

Читать полностью...
новое в Help and Manual 9

Новое в Help and Manual 9

23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...

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

Создание CHM-справки в бесплатной програ…

KEL CHM Creator — это «новая» хорошо забытая программа, выпущенная в 2012 году, предназначенная для создания и декомпиляции CHM-файлов. Программа не требовательна к ре...

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

KEL CHM Creator — бесплатная программа д…

Если вам нужно создать CHM-файл, и вы больше не хотите пользоваться глючной программой HTML Help Workshop, тогда KEL CHM Creator — это ваш вариант. Программа позволяет...

Читать полностью...
ключевые слова

Ключевые слова в Help+Manual…

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

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

HTML Help Workshop – бесплатная программ…

В 1997 году Microsoft выпустила новый формат справки, HTML Help (CHM), а также бесплатную программу для создания и редактирования справки в этом формате — HTML Help Wo...

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

HelpNDoc — бесплатная альтернатива Help+…

Еще одной альтернативой RoboHelp и Help&Manual является программа HelpNDoc от французского разработчика, компании IBE Software. Это практически полный аналог HelpS...

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

HelpSmith — достойная альтернатива Help+…

Продолжая тему средств разработки справки и пользовательской документации, нельзя не рассказать о программе HelpSmith. Она работает по принципу единого источника и под...

Читать полностью...
отечественная программа для разработки справки

Dr.Explain — отечественная программа для…

За почти 30-летнюю историю существования RoboHelp и Help&Manual стали стандартом средств разработки справки и пользовательской документации в среде Windows. Сегодн...

Читать полностью...
вычитка текста

Как вычитать свой текст: инструкция для …

В идеале любой технический текст кроме автора должен прочитать хотя бы один редактор и хотя бы один корректор. На практике дело ограничивается одним нормоконтролером и...

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

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

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

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