Шаблон руководства пользователя web-сервиса
Шаблон руководства пользователя — это способ сэкономить время на старте, особенно при создании первичной структуры проекта. Содержание разделов в новом проекте уже частично заполнено текстовым и графическим контентом, предлагая пользователю сразу приступить к наполнению контента конкретной специфической информацией о web-сервисе.
Шаблон руководств пользователя для web-сервиса в программе Dr.Explain создан на основе обобщенного многолетнего опыта работы нашей компании в области технической коммуникации. Структура и содержание разделов в шаблоне не стандартизируются. Вы можете свободно модифицировать структуру шаблона под специфику вашего проекта — web-сервиса.
Такая концепция позволяет создавать документацию на основе шаблонов Dr.Explain в различных проектах — от IT-сферы и науки, до образования, медицины, финансов и сферы услуг.
Основываясь на своем многолетнем опыте и анализе проектов наших клиентов мы создали шаблоны документации для наиболее распространенных кейсов, возникающих в работе IT-компаний при работе разработке пользовательской документации к технологическим проектам и платформам. Надеемся, что шаблоны поставляющиеся с Dr.Explain, будут полезны и в ваших проектах.
Если вы считаете, что в программе не хватает дополнительного шаблона, который может быть полезен вам и большинству пользователей, пожалуйста, пришлите нам свои предложения. Мы готовы разработать новый шаблон и включить его в дистрибутив программы. Ждем ваших предложений: help@drexplain.com.
Как создать шаблон руководства пользователя web-сервиса в Dr.Explain?
Шаг 1. Создайте проект по шаблону
- Запустите Dr.Explain.
- Создайте локальный проект по шаблону "Руководство пользователя Web-сервиса".
Шаг 2. Добавьте контент
- Добавьте текст и форматируйте его с помощью панели инструментов редактора.
- Добавляйте аннотированные скриншоты, аннотации будут пронумерованы автоматически.
Шаг 3. Экспортируйте документ
- Проверьте результат в окне предпросмотра.
- Настройте внешний вид документа.
- Выберите формат экспорта HTML.
Примеры пользовательских документаций, созданных в Dr.Explain
Простота и удобство программы позволяет создавать проекты даже новичкам, а опытные специалисты смогут с ее помощью реализовать более сложные решения. Вот некоторые примеры реальных руководств пользователя, написанные в программе Dr.Explain:
Какие преимущества вы получите с Dr.Explain?
Шаблон руководства пользователя web-сервиса — это частично заполненное решение, которое можно адаптировать под индивидуальные потребности в различных проектах и отраслях.
Адаптивный дизайн. Онлайн-документация будет адаптирована для использования на мобильных устройствах.
Навигация. Элементы навигации и поиск по документу будут в экспортированном документе по умолчанию.
Автоматизация. При написании пользовательских руководств приходится выполнять много ручной работы. Dr.Explain возьмет рутину на себя, а вы сосредоточитесь на контенте.
Для кого подходит Dr.Explain?
Dr.Explain подходит как для неподготовленных авторов, так и для экспертов. Программа ускоряет создание справочных систем и облегчает их дальнейшую поддержку. Множество инструментов, избавляющих от рутинной работы, делают ее незаменимым помощником. Вот ситуации, когда вам не обойтись без Dr.Explain:
- вы запускаете веб-сервис и для него нужно быстро сделать онлайн-документацию;
- документация должна быть частью сайта;
- важно, чтобы онлайн-справка выглядела современно на всех устройствах.
Пользователи о шаблоне руководства пользователя web-сервиса в Dr.Explain
"Мы легко вписали онлайн-справку, созданную Dr.Explain, в основной сайт нашего проекта, подобрав его стиль. Это всегда очень важно для удобства использования сайта и восприятия бренда".
Дмитрий Лашхиа, руководитель отдела поддержки и развития бизнес-процессов медиагруппы Актион-МЦФЭР
Интервью с Дмитрием
"Dr.Explain показался наиболее простым и интуитивно понятным в использовании. Кроме того, с ним публикация документа в интернете — это очень простой процесс".
Самули Пирккама, основатель компании Data-Bond
Интервью с Самули
"Считаю, что Dr.Explain лучше подходит для нашей отрасли и обеспечивает “ощущение книги” в онлайн-формате, что хорошо подходит нашим клиентам, которые не являются техническими специалистами".
Дэррил Уиндер, управляющий директор и совладелец проекта SmartFees
Интервью с Дэррилом
Часто задаваемые вопросы
Можно ли создать документацию в формате HTML без знания кода?
Можно. Программа автоматические генерирует код, специальных знаний от вас не требуется.
Верстка HTML-шаблона адаптивная?
Адаптивная. Все шаблоны имеют профессиональный внешний вид и выполнены с учетом современных тенденций в дизайне.
Можно ли в HTML-шаблон вставлять JavaScript?
Можно. Вы можете добавлять на страницу сторонний код.
Можно ли установить бесплатную версию Dr.Explain?
Можно установить и пользоваться ей без ограничений по времени.
Можно ли использовать свои CSS-стили?
Можно. Есть возможность встраивать сторонние динамические виджеты.
У вас есть аккаунт на Youtube с обучением работе с программой?
Есть. Видео-ролики вы найдете в нашем профиле на Youtube.