Создание онлайн-руководств без программирования

Dr.Explain экспортирует проект пользовательской документации в готовый к публикации набор HTML-страниц. Без специальных знаний вы получаете адаптивное онлайн-руководство пользователя с поиском и навигацией.

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

Как создать онлайн-руководство в Dr.Explain?

Ниже кратко описан процесс создания веб-версии пользовательской документации. Узнать об этом подробнее вы можете в руководстве пользователя Dr.Explain.

Шаг 1. Создание проекта

• Выберите готовый шаблон пользовательской документации или создайте новый проект. Вы также можете импортировать в Dr.Explain свою старую пользовательскую документацию, например, в формате DOCX.
• Выберите цветовую схему документа, если хотите изменить тему, установленную по умолчанию. Для более тонкой настройки оформления можно использовать код CSS и JavaScript.

Шаг 2. Добавление контента в проект

• Добавьте в разделы контент: текст, видео, таблицы, специальные объекты, перекрестные ссылки, аннотированные скриншоты. Автоматическое аннотирование скриншотов — одна из ключевых особенностей Dr.Explain.
• Проверьте внесенные правки в режиме предпросмотра.

Шаг 3. Экспорт проекта

• Добавьте код инструментов веб-аналитики, если это необходимо.
• Экспортируйте документ. Настройки экспорта можно использовать в других проектах Dr.Explain. Экспортированный документ имеет интерактивные элементы и адаптивный дизайн.

Ниже представлено видео, демонстрирующее процесс экспорта проекта в формат HTML:

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

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

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

Профессиональная программа для создания пользовательских онлайн-документаций Dr.Explain предлагает:

Адаптивный дизайн. Без знания кода вы создадите онлайн-версию руководства пользователя, адаптированного для использования на мобильных устройствах.

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

Интеграция стороннего кода. Возможность встраивать виджеты сделает пользовательскую документацию более наглядной и интерактивной.

Почему десктоп, а не SaaS (облако)?

Десктопное приложение Dr.Explain предпочтительнее по нескольким причинам:

• Безопасность данных. В случае с SaaS-платформой данные могут выходить за пределы контроля пользователя. Их безопасность зависит от провайдера, от браузера, от политики защиты информации облачного сервиса. В случае с Dr.Explain данные находятся под полным контролем пользователя.
• Стабильность работы. Выбирая Dr.Explain для разработки онлайн-документации, вы не зависите от качества интернет-соединения.
• Автоматизация аннотирования скриншотов. В случае с облачной платформой эта функциональность может быть ограничена.
• Форматы экспорта. Облачный сервис предлагает преимущественно HTML, иногда PDF. Dr.Explain обеспечивает экспорт пользовательской документации не только в формат HTML, но и в CHM, DOCX, PDF.

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

Кто выбирает Dr.Explain для создания онлайн-руководств?

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

Пользователи о создании онлайн-руководств в Dr.Explain

"Dr.Explain отлично работает, и мы уже перевели наш большой проект онлайн-справки в нужный формат."

Джим, сотрудник компании CNCSimulator

Интервью с Джимом

"Однако я считаю, что Dr.Explain лучше подходит для нашей отрасли и обеспечивает “ощущение книги” в онлайн-формате, что хорошо подходит нашим клиентам, которые не являются техническими специалистами".

Дэррил Уиндер, управляющий директор и совладелец проекта SmartFees

Интервью с Дэррилом

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

Аре Тёммерос, старший геолог компании Migris

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

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

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

• Создавайте документацию в различных форматах
• Создание PDF и DOCX из одного проекта документации
• Создание файлов справки CHM