Создание файлов справки CHM

Файл справки или файл помощи в формате CHM (Compiled HTML Help) — это набор веб-страниц, сжатых и скомпилированных в единый файл. Сейчас одним из самых популярных форматов файлов справки для приложений является именно CHM.

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

Файлы справки в формате CHM являются самым подходящим средством для быстрого создания контекстной помощи для вашего приложения. Практически все современные языки программирования и среды разработки содержат встроенные методы для связи компонентов вашей программы с созданным файлом справки в формате CHM. Эти методы основываются на HtmlHelp API компании Microsoft, которое позволяет открывать конкретные разделы или выполнять поиск по конкретной фразе в созданном файле справки прямо из вашего приложения.

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

Как создать файл справки CHM в Dr.Explain?

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

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

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

После экспорта останется только связать файл с программой и добавить в инсталляционный пакет. Dr.Explain поддерживает механизм Help ID и создаёт из вашего проекта полноценную систему контекстно-зависимой справки.

Интеграция

В Dr.Explain вы создадите справочную документацию в формате CHM, готовую для интеграции в приложение Windows. Без знаний кода и привлечения специалиста.

Рассмотрим пример интеграции CHM-файла в .NET-приложение.

У каждого раздела в Dr.Explain в панели свойств есть поле "Имя файла", значение которого вы можете изменить на свое усмотрение. В примере ниже это значение "knopka_sokhranit".

Откройте приложение в редакторе кода и у элемента интерфейса, который должен вызывать соответствующий раздел документации (раздел "Кнопка Сохранить"), пропишите значение раздела: knopka_sokhranit:

private void HlpButton_Click(object sender, EventArgs e) { Help.ShowHelp(this, "knopka_sokhranit.chm"); }

Так мы привязываем элементы интерфейса к разделам пользовательской документации.

Примеры руководств пользователя в формате CHM, созданных в Dr.Explain

Ниже представлены примеры реальных контекстных справок, созданных в программе Dr.Explain.

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

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

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

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

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

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

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

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

Пользователи о создании файлов справки CHM в Dr.Explain

"Dr.Explain привлек нас простотой в управлении и работе со скриншотами. Мы решили построить нашу систему на основе мастера создания скриншотов, создавая пояснения, направляющие пользователя. Работа с элементами управления на каждом скриншоте, а также возможность создания CHM- и HTML-файлов стали ключевыми моментами при выборе вашего продукта".

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

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

"Нам впервые потребовалось создать файл справки для проекта. Я провел небольшое исследование и сравнил различные инструменты для создания CHM-файлов справки, и Dr. Explain показался мне подходящим и очень простым в применении".

Рик Сзаш, программист из Damselfly Solutions Inc

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

"Дал людям возможность сравнить сгенерированный CHM в Dr.Explain с другими файлами справки. Разница оказалась огромной! Комментарии, которые я получил о версии Dr.Explain, были абсолютно положительными, а о CHM-файлах, созданных в IDE, — отрицательными... CHM, созданный Dr.Explain, выглядит идеально, что повышает ценность всего проекта. Мы видим, насколько он серьезен".

Мишель Гарсия, основатель и генеральный директор компании IIM Services Agency

Интервью с Мишелем

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

Смотрите также

• Интегрируйте Help-файл в ваше ПО
• Dr.Explain создаёт map-файл Help ID
• Поддержка изображений, специальных объектов, ссылок, шрифтов