Background
Возможности программы Dr.Explain
← Назад к обзору возможностей

Автоматическое назначение Help ID идентификаторов разделам

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

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

Как это работает? Разберем на примере программы Dr.Explain. Допустим, что пользователь столкнулся с проблемой при экспорте проекта в HTML-формат, находясь в соответствующем диалоговом окне программы. Вызывая справку из этого диалога, пользователь увидит, что руководство открылось именно на странице, где рассказывается о работе этого диалога и о сценариях экспорта проекта в формат онлайн-документации.

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

назначение Help-ID идентификатора в пользовательской документации

Так выглядит окно контекстной справки:

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

Как автоматически назначить Help ID разделам в Dr.Explain?

Чтобы изменить настройки управления Help ID при экспорте в CHM для текущего проекта, используйте один из описанных ниже способов:

  • перейдите в меню "Настройки" и выберите команду "Настройки проекта";
  • или нажмите иконку шестеренки на панели инструментов программы.

Перейдите в раздел "CHM экспорт" / "Управление Help ID". Откроется диалоговое окно:

как назначить Help ID в пользовательской документации

Подробнее об элементах управления в этом окне читайте в этом разделе документации.

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

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

справочная документация в формате PDF как писать

как создать документацию пользователя для систем учета

программа для создания документации с аннотациями

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

как сделать аннотации и подписи на скриншотах

как нумеровать разделы в руководстве пользователя

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

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

Автоматизация рутинных процессов. Монотонная ручная работа — это не только трата времени, но и множество ошибок. Доверьте самую скучную часть разработки программе и получите точный результат без ошибок и опечаток.

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

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

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

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

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

Пользователи о работе с Help-ID в Dr.Explain

Али Атайя, генеральный директор и владелец программы Crystaltrack компании Evolusys
"Dr.Explain пришел на помощь, упростив и упорядочив процесс создания и поддержки пользовательской документации. Теперь мы можем сосредоточиться на контенте, а программное обеспечение поможет в остальном. При необходимости мы можем экспортировать один и тот же документ на различные носители и в готовые для печати форматы".

Али Атайя, генеральный директор и владелец программы Crystaltrack компании Evolusys

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

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

У программы есть вечная лицензия?

Есть. Подробнее на этой странице.

В Dr.Explain есть шаблоны ГОСТ?

Есть шаблон пользовательской документации ГОСТ 34.

Можно редактировать готовые шаблоны?

Можно. Есть возможность добавлять код сторонних виджетов, редактировать HTML, CSS.

Есть видеоуроки по вашей программе?

На этой странице есть видео-обзор Dr.Explain, также рекомендуем посетить наш профиль на YouTube.

Есть веб-версия справки по вашей программе?

Мы создали руководство пользователя Dr.Explain при помощи Dr.Explain, которое доступно по этой ссылке.

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