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

Интерактивность

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

как добавить интерактивность в справочную документацию

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

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

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

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

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

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

как сделать аннотированный скриншот

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

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

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

аннотации в PDF документации

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

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

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

Экономия времени. Функциональность программы позволяет создавать профессиональную документацию с минимальными временными затратами.

Улучшение поисковой выдачи. Страницы веб-версии документации индексируются поисковыми системами, улучшая видимость сайта.

Анализ статистики. Добавьте в документацию счетчики веб-аналитики, чтобы иметь полную картину о взаимодействии пользователей с вашей документацией. Это позволит выявить слабые места и исправить недочеты.

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

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

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

  • документация разрастается, нужно облегчить поиск информации в ворохе контента;
  • нужно автоматическое создание ссылок для навигации внутри документа ("Наверх", "Предыдущая страница", "Следующая страница" и т.д.);
  • нужна автоматическая нумерация разделов;
  • нужна возможность встраивать сторонний код;
  • нужна возможность быстрого просмотра изменений;
  • нужна производительность, не зависящая от интернет-соединения;
  • нужна возможность подключать счетчики веб-аналитики.

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

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

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

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

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

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

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

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

Где можно посмотреть видео-уроки Dr.Explain?

Смотрите наши видео на Youtube.

Онлайн-руководство будет адаптировано под мобильные? Что нужно для этого сделать?

Ваш проект онлайн-руководства будет иметь адаптивный дизайн. Ничего дополнительно для этого делать не требуется. Программа сделает все сама.

Можно встраивать в документацию JavaScript?

Можно.

Можно работать над одним проектом нескольким авторам?

Есть возможность совместной работы посредством бесплатного онлайн-сервиса TiWri. Подробнее в этом разделе руководства.

Можно перемещать разделы перетаскиванием?

Можно. Изменяйте структуру проекта при помощи драг-н-дроп.

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

Можно.

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