Обзор возможностей программы Dr.Explain :: быстрое создание пользовательской и справочной документации

Создавайте многоформатную документацию

Dr.Explain поможет вам создать по-настоящему пользовательскую документацию.

Основной функцией Dr.Explain является возможность создания пользовательской документации в популярных форматах: CHM, HTML, PDF, MS Word.

Вы сможете:

  • Быстро создать файл справки (CHM) для вашего программного продукта и интегрировать его в ваше приложение, чтобы пользователи всегда имели под рукой help-файл при работе в программе.
  • Без программирования создать веб-версию справки (HTML) с навигацией и поиском и опубликовать ее на сайте прямо из программы.
  • Экспортировать ваш проект в форматы PDF или MS Word, которые легко можно открыть на любом устройстве, переслать или распечатать.

Подробнее

Создание CHM-файлов …   Создание online-руководств …   Создание печатной документации (PDF и MS Word) …

Документируйте автоматически

Пишите документацию быстро!

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

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

Подробнее

Автоматическое аннотирование …   Редактор снимков экрана …   Импорт документации из внешних файлов …

Управляйте контентом

Dr.Explain предоставляет широкие возможности для редактирования контента. Редактор поддерживает текст с различными начертаниями и стилями шрифтов, аннотированными изображениями, видео, таблицами, нумерованными и произвольными списками, гиперссылками, макропеременными и специальными объектами. А встроенная проверка орфографии с национальными словарями поможет вам избавить текст от опечаток и ошибок.

Подробнее

Макропеременные …   Поддержка изображений, шрифтов, ссылок …   Проверка орфографии с национальными словарями …

Управляйте структурой проекта

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

Подробнее

Навигация по проекту …   Статусы разделов …   Блокировка разделов …

Интегрируйте Help-файл в ваше приложение

Хотите поставлять руководство с программным обеспечением и сделать контекстно-зависимую помощь?
Вы можете легко связать документацию с программой с помощью Dr.Explain, чтобы создать контекстную справку.
Dr.Explain поддерживает механизм Help ID, автоматически присваивает и импортирует идентификатор справки, а также генерирует map файлы идентификаторов справки.
Задумайтесь над содержанием CHM файла, а об интеграции позаботится Dr.Explain.

Подробнее

Поддержка идентификаторов контекстной справки …   Автоматическое назначение идентификаторов разделам …  

Создание map-файлов Help ID …

Настраивайте визуальный стиль вашего онлайн-руководства и файла-справки

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

Инструмент разработки пользовательской документации Dr.Explain позволяет настраивать внешний вид страниц справки с помощью коллекции визуальных шаблонов или CSS-кода.

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

Подробнее

HTML - шаблоны …   Настройка стиля страницы с CSS …   Интерактивность …

Работайте вместе


Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами. По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.


Готовые шаблоны руководств

Даже самый удобный инструмент для разработки документации, не освобождает писателей от самой сложной, трудоемкой и рутинной части проекта - непосредственной разработки и написания этой самой документации.

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

Подробнее

Корпоративная база знаний …   Руководство пользователя Web-сервиса …   Руководство пользователя ПО …