Интегрируйте Help-файл в ваше приложение

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

Что такое help-файл?

Help-файл — это руководство пользователя в формате CHM со структурированной информацией о приложении. CHM — это специальный формат в ОС Windows для создания контекстной помощи в приложениях.

Некоторые преимущества формата:

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

Dr.Explain превращает создание и интеграцию help-файла в простой и предсказуемый процесс. Вы сосредотачиваетесь на содержании, а программа берёт на себя техническую часть: от вёрстки до совместимости с вашим приложением. Это не только ускоряет выпуск документации, но и делает её максимально полезной для конечных пользователей.

Пример окна help-файла, созданного в программе Dr.Explain:

Что такое интеграция help-файла?

Интеграция help-файла означает, что вы сможете связать документацию с программой, и в результате при работе с вашим приложением пользователь будет вызывать контекстно-зависимую помощь с ответами на возникшие вопросы прямо в программе.

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

Как работает механизм интеграции в Dr.Explain?

Dr.Explain поддерживает механизм автоматического назначения Help ID идентификаторов разделам. Если у вас есть готовый проект справки, но без Help ID, Dr.Explain может автоматически присвоить значения Help ID всем разделам.

Что это дает пользователю?

Контекстная помощь ускоряет и облегчает получение нужной информации. Пример работы контекстной справки можно видеть в Word: если вы находитесь в конкретном разделе или диалоговом окне Word, нажмите F1 — откроется справка, связанная с текущим контекстом.

Что это дает разработчику?

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

Примеры help-файлов, созданных в Dr.Explain

Несмотря на широкое распространение SaaS-платформ, help-файлы остаются популярным форматом. Об особенностях облачных сервисов и десктопных приложений мы писали в этой статье. Вот некоторые примеры контекстной помощи для приложений, созданных в Dr.Explain.

Какие преимущества вы получите?

Экономия времени. Без специальных навыков при помощи автоматизированных инструментов вы создадите и интегрируете help-файл в свое приложение.

Удобство для пользователя. Помощь и ответы на возникающие вопросы пользователи смогут найти в самом приложении с интегрированным в него help-файлом.

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

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

Для кого подходит Dr.Explain?

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

• нужно написать один документ и экспортировать его в несколько разных форматов;
• нужна программа, похожая на текстовый редактор Word, но с гораздо большим функционалом;
• нужна уверенность, что программа не новичок на рынке, и ее поддержка не прекратится, поскольку разработчики занимаются развитием своего проекта уже много лет;
• нужна десктопная программа, а не SaaS-платформа;
• нужна гибкая ценовая политика покупки лицензий, в том числе бесплатная пробная версия;
• нужна возможность совместной работы;
• нужна программа с русскоязычной службой поддержки.

Пользователи об инструментах интеграции в Dr.Exlain

"Мы очень довольны нашей текущей справочной документацией и интеграцией с нашими инструментами. Теперь в любом диалоге или панели программы мы можем нажать на “Справка” и открыть соответствующую страницу в документации. Думаю, в дальнейшем мы будем уделять основное внимание созданию большего количества видеороликов и встраиванию их непосредственно в документацию".

Аре Тёммерос, старший геолог компании Migris

Интервью с Аре

"При оценке и сравнении современных альтернатив для создания CHM-файлов Dr Explain показал отличные результаты. Софт сочетает в себе разумную стоимость и полный набор функций".

Джо Эванс, компания Radiant Technologies

Интервью с Джо

"Используя Dr.Explain, мы не только создали контекстно-зависимую справочную систему, но и сделали ее ориентированной на пользователя. Таким образом, мы как бы предоставляем разные справочные системы в зависимости от привилегий пользователя".

Роберт Сибильски, генеральный директор и главный программист компании Siborsoft

Интервью с Робертом

Часто задаваемые вопросы