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

Онлайн-документация — это удобно, но не всегда доступно. Поэтому важно предоставить пользователям возможность скачать документацию в формате PDF или DOCX для печати. Так они будут иметь доступ к справке в любое время и в любом месте.

Если у вас уже есть документация в текстовом формате, вы можете открыть ее в Dr.Explain и экспортировать в PDF или DOCX.

Онлайн-справка — самый распространенный формат пользовательской документации.

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

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

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

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

Это быстрый доступ к нужной информации, удобная навигация и широкие возможности форматирования контента.

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

Для создания уникального дизайна предусмотрен широкий набор инструментов стилизации.

Вместо того, чтобы создавать документацию с нуля, вы можете импортировать уже имеющиеся материалы в Dr.Explain. При этом полностью сохранится структура документа, его навигация и форматирование. Поддерживаются различные форматы файлов, включая CHM, HLP, HTML, XML, DOC/DOCX и TXT.

Если вас есть пользовательская документация, вы можете продолжить работать с ней в Dr.Explain. Импортируйте ее в программу, при этом полностью сохранится структура документа, его навигация и форматирование. Поддерживаются различные форматы файлов, включая CHM, HLP, HTML, XML, DOC/DOCX и TXT.

Импорт — один из мощных инструментов Dr.Explain. Он позволяет импортировать не только контент, но и настройки проектов.

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

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

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

Самую рутинную работу программа берет на себя!

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

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

Постоянно повторяющиеся действия едва ли повышают эффективность и производительность. К счастью, в Dr.Explain многие рутинные действия автоматизированы.

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

Нужно изменить контактные данные? Просто отредактируйте текст в переменной, и информация изменится везде, где вы использовали эту переменную.

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

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

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

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

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

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

Dr.Explain обеспечивает возможность создания контекстно-зависимой справочной системы для вашего приложения. Вы можете присвоить каждой теме справки уникальный Help ID и текстовый алиас. Dr.Explain также генерирует map-файлы, необходимые для интеграции справки в исходный код, в трех распространенных форматах: .h, .vb и .inc.

Dr.Explain предоставляет возможность создавать контекстно-зависимые файлы справки, назначая числовые идентификаторы (Help ID) и текстовые псевдонимы (алиасы) каждому разделу. Более того, если у вас уже есть готовый проект справки, но в нем отсутствуют Help ID, Dr.Explain может автоматически присвоить их всем темам. Вам нужно лишь определить правило назначения, а Dr.Explain выполнит всю работу за вас.

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

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

Вы можете настраивать не только структуру страниц, но и изменять их внешний вид. Если вы обладаете знаниями CSS, вы можете создавать собственные стили, которые будут определять внешний вид и поведение каждого элемента страницы, от заголовков и абзацев до изображений и таблиц. Это позволит вам создать справку с уникальным дизайном.

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

Готовые шаблоны документации экономят время. Вам не нужно создавать структуру проекта с нуля и изучать, как это делается. Шаблоны содержат структурированные разделы с заголовками, вы можете сразу же приступить к описанию своего продукта, не тратя время на оформление.

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

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

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

Шаблон корпоративной базы знаний в Dr.Explain — это экспертная рекомендация, основанная на нашем многолетнем опыте в области управления знаниями и разработки документации. Предложенная структура и наполнение разделов — это лишь пример, который вы можете свободно адаптировать под нужды вашего бизнеса, продуктов и услуг.

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

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

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