Интерактивность в онлайн-руководствах

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

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

Как добавить интерактивность в Dr.Explain?

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

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

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

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

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

• Полноценная навигация без программирования. Дерево разделов, меню, хлебные крошки, кнопки "Следующая страница/Предыдущая страница" и окно поиска генерируются автоматически. Вам не нужно писать для этого ни строчки кода.
• Удобство для пользователя. Посетители вашей онлайн-документации могут мгновенно находить ответы через полнотекстовый поиск, видеть свой путь и перемещаться между разделами.
• Гибкость для разработчика. Вы можете встраивать в страницы собственный JavaScript, HTML и CSS, добавляя интерактивные примеры и любые сторонние виджеты.
• Аналитика поведения пользователей. Подключайте счетчики, чтобы понимать, какие разделы читают чаще всего, и улучшать документацию на основе реальных данных.
• Ускорение работы. Все интерактивные элементы создаются автоматически при экспорте — вам не нужно тратить время на их ручную разработку и поддержку.

Кто создает интерактивные пользовательские руководства в Dr.Explain?

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

Пользователи об интерактивности в Dr.Explain

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

Майк Маклафлин, разработчик Champion Software

Интервью с Майком

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

Рики Мато Пайсип Наревек, аналитик по качеству и технический писатель Kumulsoft

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

"После тестирования нескольких приложений для создания руководства пользователя, которые оказались сложными и трудоемкими, я наткнулся на Dr.Explain. И вот оно, чудо — за три дня я написал основное содержание руководства и добавил большинство скриншотов. Затем я добавил несколько пояснений, ссылки на мои примеры видео и внутренние ссылки. Это было так просто!"

Паскаль Берингер, основатель проекта Hyphen

Интервью с Паскалем

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

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

• Настраивайте визуальный стиль вашего онлайн-руководства и файла-справки
• Настройка стиля страниц документации с использованием CSS
• HTML шаблоны