Автоматическое назначение Help Context ID идентификаторов разделам
Dr.Explain позволяет назначать числовые идентификаторы (Help Context ID) и текстовые псевдонимы (алиасы) каждому разделу, чтобы создать контекстно-зависимый файл справки для вашего программного приложения. Если у вас есть готовый проект справки, но без Help Context ID, Dr.Explain может автоматически присвоить значения Help Context ID всем темам. Все, что вам нужно сделать, это просто указать правило назначения, а Dr.Explain сделает все остальное.
Контекстный файл-справки удобен для пользователя, ведь ему не придется вбивать в поисковую строку ключевые слова, чтобы найти необходимую информацию.
Как это работает? Разберем на примере программы Dr.Explain. Допустим, что пользователь столкнулся с проблемой при экспорте проекта в HTML-формат, находясь в соответствующем диалоговом окне программы. Вызывая справку из этого диалога, пользователь увидит, что руководство открылось именно на странице, где рассказывается о работе этого диалога и о сценариях экспорта проекта в формат онлайн-документации.
А для разработчика документации инструмент автоматического назначения Help Context ID — отличная возможность сэкономить свои силы, ведь ему не придется вручную прописывать идентификаторы всем разделам документации.
Так выглядит окно контекстной справки:
Как автоматически назначить Help Context ID разделам в Dr.Explain?
Чтобы изменить настройки управления Help Context ID при экспорте в CHM для текущего проекта, используйте один из описанных ниже способов:
- перейдите в меню "Настройки" и выберите команду "Настройки проекта";
- или нажмите иконку шестеренки на панели инструментов программы.
Перейдите в раздел "CHM экспорт" / "Управление Help Context ID". Откроется диалоговое окно:
Подробнее об элементах управления в этом окне читайте в этом разделе документации.
Примеры пользовательских документаций, созданных в Dr.Explain
На нашем сайте вы можете найти не только ссылки на реальные документации, созданные в Dr.Explain, но и почитать интервью с авторами, которые создали и успешно внедрили свои справочные системы в рабочие процессы. Предлагаем оценить скриншоты некоторых проектов ниже. Это проекты в разных форматах и для самых разных отраслей:
Какие преимущества дает автоматическое назначение Help Context ID?
- Экономия времени. Dr.Explain автоматизирует присвоении идентификаторов.
- Исключение ошибок. Автоматическое назначение гарантирует, что у каждого раздела будет уникальный ID, и исключает опечатки, неизбежные при ручном вводе.
- Мгновенная готовность к интеграции. После автоматического назначения ID вы можете сразу экспортировать проект в CHM вместе с map-файлом для разработчика.
- Гибкость настройки. Вы сами задаете правило или диапазон для генерации ID, что позволяет вписать справку в существующую систему идентификаторов вашего приложения.
- Прозрачность процесса. Вы всегда можете увидеть назначенные ID в свойствах разделов и при необходимости отредактировать их.
Кому подходит Dr.Explain?
Dr.Explain подходит авторам, которые нацелены на быстрый и качественный результат. Программа позволяет создавать профессиональные справочные системы, в которых обучающий материал представлен наглядным, хорошо структурированным и визуально привлекательным документом. Это ваш выбор, если:
- Разработчикам, которые интегрируют контекстную справку в свое приложение. Dr.Explain позволяет быстро подготовить документацию с корректными ID без необходимости делать это вручную.
- Техническим писателям, работающим над большими проектами CHM-справки. Если у вас сотни страниц, автоматизация решает эту проблему.
- Всем, кто ценит время и хочет избежать ошибок. Автоматизация монотонной работы — это всегда выигрыш в качестве и скорости.
Пользователи о работе с Help-ID в Dr.Explain
"Dr.Explain пришел на помощь, упростив и упорядочив процесс создания и поддержки пользовательской документации. Теперь мы можем сосредоточиться на контенте, а программное обеспечение поможет в остальном. При необходимости мы можем экспортировать один и тот же документ на различные носители и в готовые для печати форматы".
Али Атайя, генеральный директор и владелец программы Crystaltrack компании Evolusys
Интервью с Али
Часто задаваемые вопросы
У программы есть вечная лицензия?
Есть. Подробнее на этой странице.
В Dr.Explain есть шаблоны ГОСТ?
Есть шаблон пользовательской документации ГОСТ 34.
Можно редактировать готовые шаблоны?
Можно. Есть возможность добавлять код сторонних виджетов, редактировать HTML, CSS.
Есть веб-версия справки по вашей программе?
Мы создали руководство пользователя Dr.Explain при помощи Dr.Explain, которое доступно по этой ссылке.