Dr explain что это за программа

Dr.Explain

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

Для ускорения процесса разработки документации в версии 6.5. реализована поддержка текстовых блоков – специально оформленных фрагментов контента с уникальным оформлением и логикой экспорта.

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

Основы работы с Dr.Explain. — Ч.9 — Создание файла справки для Windows-приложения в формате CHM

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

2021: Dr.Explain 6

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

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

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

Данная версия Dr.Explain предлагает пользователям готовые шаблоны документации, экономя их время на составление плана и структуры документа. Помимо этого, программа поддерживает экспорт одного проекта в наиболее востребованные форматы документации: HTML, CHM, PDF, MS Word, — позволяя избежать затрат на дополнительные инструменты. Для компаний, которые сотрудничают с государственными организациями и крупными предприятиями, существует автоматическая поддержка требований ГОСТ 19 и ГОСТ 34.

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

2018: Dr.Explain версия 5.5

Компания «Индиго Байт» выпустила в начале 2018 года версию приложения Dr.Explain 5.5, которая позволяет создавать пользовательскую и справочную документацию к ПО или автоматизированным системам в соответствии требованиям государственных стандартов РФ серии ГОСТ 34 и ГОСТ 19.

Основы работы с Dr.Explain. — Ч.1 — Обзор основных возможностей программы

Данная функциональность облегчает работу IT-компаний, которым требуется сопровождать свои разработки руководством пользователя по ГОСТ 34 или руководством оператора по ГОСТ 19. Такое требование возникает при сотрудничестве с государственными организациями и крупными производствами, при разработке ПО по тендерам и госзаказам или при необходимости включения программного продукта в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)» Минкомсвязи РФ.

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

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

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

Русскоязычная поддержка, полная локализация, понимание задач и бизнес-процессов отечественных IT-проектов, включение программы в Реестр отечественного ПО Минкомсвязи РФ – все это делает продукт Dr.Explain предпочтительным инструментом для множества отечественных IT-компаний.

2011: Dr.Explain версия 4.2

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

Также, в новой версии появился ряд новых технических возможностей, таких как функция подсветки результатов поиска в онлайн-справке, импорт файлов в формате Microsoft Word DOC / DOCX, а также ряд новых функций редактора. Расширены возможности по управлению стилями текста, усовершенствованы функции импорта из HTML, CHM, RTF, оптимизирована работа JavaScript в онлайн-справке.

Продукт стал инструментом для десятков тысяч разработчиков программного обеспечения – начиная от технологических стартапов и заканчивая подразделениями корпораций из списка Fortune 1000, таких как Hewlett-Packard, Lockheed Martin, NEC, Fujitsu, Bosch и Michelin. Также пользователями программы являются технические писатели, бюро и независимые специалисты в области технических коммуникаций, оказывающие услуги по созданию документации для ПО. Теперь эта популярная программа стала более доступна и в России, предлагая полноценную поддержку русскоязычным пользователям.

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

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

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

2005: Выпуск первой версии Dr.Explain

Первая версия Dr.Explain была выпущена на зарубежный рынок в 2005 году.

Источник: www.tadviser.ru

Dr.Explain

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

Какие форматы поддерживает?

Dr.Explain поддерживает вывод документации в такие форматы, как HTML (on-line руководства), CHM (файлы справки для ОС MS Windows®), RTF, и PDF. И все это на основе единого проекта-источника.

Плюсы

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

Интегрированная утилита захвата и анализа программных окон и экранов (скриншотов), помогающая быстро создавать технические иллюстрации для ваших программ.

Поддержка идентификаторов Help ID для создания контекстной помощи в приложениях.

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

Визуальный контроль за состоянием проекта с использованием механизма статусов.
Поддержка мультибайтовых кодировок и языков с обратным написанием (RTL).

Возможность добавлять функции поиска и индексации в on-line справки без использования программирования (PHP, ASP, и т.д.) или баз данных на стороне сервера.

Создание пользовательской документации из единого источника в различных форматах: файлы справки CHM, on-line руководства в формате HTML, RTF, и PDF с оглавлением и ссылками.

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

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

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

Минусы

• Программа платная

Поддержка

• Техническая поддержка на русском языке.

Источник: techwriters.ru

Cоздание справочной системы или руководства пользователя в Dr.Explain

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

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

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

Dr.Explain vs. Help and Manual

Итак, Dr.Explain позволяет создавать help-файлы в формате CHM для поставки вместе с приложением, справочные системы в HTML для размещения на сайте продукта, а также руководства пользователя в RTF и в PDF с оглавлениями и ссылками. Справочная система генерируется в разных форматах из единого источника, что позволяет быстро обновлять документацию при выходе новых версий ПО. В этом плане Dr.Explain ничем не отличается от Help and Manual, которой я давно пользуюсь.

Интерфейс состоит из двух областей. Первая – это панель навигации с древовидной структурой содержания проекта. А вторая – редактор страниц.

В дереве задается вся структура help-файла, включая заголовки папок и страниц. Редактор страниц состоит из стандартных инструментов для написания и форматирования текста, а также имеются инструменты для вставки гиперссылок, картинок, таблиц и переменных. Все это есть и в Help and Manual, но панель инструментов в Dr.Explain скомпонована, на мой взгляд, более продуманно.

Рисунок 1. Панель инструментов Dr.Explain

Рисунок 2. Панель инструментов Help and Manual

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

Кроме того, к выноскам можно добавить и более подробные пояснения. Для всех выносок программа автоматически сгенерирует симпатичную на вид табличку, которая будет размещаться ниже скриншота с выносками и может включать в себя все эти подробные пояснения.

Такое полуавтоматическое документирование интерфейса значительно ускоряет и облегчает создание справочной системы, т.к. разработчику остается всего лишь добавить свои описания в выноски. В Help and Manual я все это тоже могу сделать – правда, придется делать это вручную. Обычно я делаю снимки окон в Snagit, обрабатываю края снимка, добавляю тень, рисую стрелки. А для документирования элементов окна вручную создаю табличку, нарезаю снимки кнопок и контролов, обрабатываю их края и вставляю в проект, а затем пишу описания каждой выноски. На это тратится уйма времени и усилий.

Кое-что еще…

В Dr.Explain есть и другие полезные возможности, которых, к сожалению, нет в Help and Manual. Например, есть удобный режим просмотра проекта – одним кликом по соответствующей кнопке можно быстро посмотреть, как будет выглядеть справка в формате CHM или HTML после компиляции. Превью открывается прямо в окне редактора. Поверьте, это очень удобно. Однако нет PDF-превью – это минус.

В Help and Manual чтобы посмотреть, как выглядит справка, нужно постоянно компилировать проект.

Также в программе есть возможность интегрировать контекстно-зависимую справку прямо в приложение (F1), управление деревом навигации, набор шаблонов оформления, поддержка CSS, возможность быстрого обновления документации при выходе новой версии программы путем замены иллюстраций, но с сохранением выносок, аннотаций, описаний; функция поиска и индексации в онлайн-справке без программирования (PHP, ASP) или баз данных на стороне сервера.

Резюме

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

• создание документации
• справка пользователя
• справочная система
• help
• drexplain
• help and manuals

Источник: habr.com

Dr.Explain — отечественная программа для разработки справки

За почти 30-летнюю историю существования RoboHelp и HelpManual и самое дешевое средство разработки справки. На дату написания статьи лицензия на одного пользователя стоит 16 000 руб., и 22 000 руб. с возможностью совместной работы (доступ к платформе TiWri.com).

Автоматическое документирование

Ключевая особенность программы Dr.Explain — это так называемая функция автоматического документирования. Согласно встроенному в программу справочнику, «Dr.Explain захватывает окна запущенных приложений или загруженных сайтов и автоматически распознает контролы. Программа автоматически создает аннотированные скриншоты с нумерованными выносками и метками». Это на 100% подтверждается как личным опытом, так и справкой, встроенной в версию 6.3. По факту получается документация, похожая на комикс: снимки окон, выноски с названиями элементов управления и их описанием.

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

Визуальный редактор

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

Он, как будто, обрезан со всех сторон Прокрустом. Мне не хватало отображения непечатных символов, вставки специальных символов, логических условий вывода контента и т.д. (этот список можно долго продолжать).

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

Со спелл-чекером также нестыковка. По умолчанию проверка орфографии выключена, а к спелл-чекеру подключен только английский словарь. Даже в проекте на русском языке… Русский словарь, как и проверку орфографии нужно включать отдельно. Хорошо, что русский словарь есть в комплекте!

Нельзя не сказать и о положительных моментах Dr.Explain. На мой взгляд, в первую очередь стоит отметить вкладки предварительного просмотра для форматов CHM, HTML и PDF. Это действительно удобно — посмотреть результат без сборки и при необходимости настроить ту или иную область отображения контента.

Во-вторых, это принцип работы с ключевыми словами. Удобно видеть все ключевые слова проекта в форме списка. Здесь либо назначаешь существующее ключевое слово для раздела, либо вводишь новое. Экономит время во время проверки падежных окончаний ключевых слов. Но мне было бы удобнее, если бы вкладки Свойства и Ключевые слова были бы справа от редактора.

Выводы

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

Вы скажете, я предъявляю слишком высокие требования? У меня слишком высокие ожидания? Смотрите: первая версия RoboHelp вышла в 1992 г., Helphttps://help-spravka.ru/blog/13-hat-programs/49-dr-explain-otechestvennaya-programma-dlya-razrabotki-spravki» target=»_blank»]help-spravka.ru[/mask_link]

Dr explain что это за программа

24.02.2014

Введение

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

Занимаются разработкой и ведением технической документации т. н. технические писатели — как правило, универсальные специалисты, способные не только разобраться в технических аспектах работы, но и грамотно их описать. В процессе работы над документацией остро возникает необходимость в удобном инструментарии, позволяющем выполнять типовые операции с минимальными затратами. Ведь техническому писателю нужно максимально быстро и просто изложить основные принципы работы устройства или программного обеспечения. Немаловажную роль в этом играют программы для создания справочных материалов в широко распространённых форматах — CHM, HTML, PDF. Одним из примеров подобных программ является продукт компании Indigo Byte Systems, LLC — Dr.Explain, о которой и пойдёт речь в данном обзоре.

Что собой представляет Dr.Explain?

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

Начало работы с Dr.Explain

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

В рабочем поле проекта присутствует две части: левая и правая, при этом левая часть делится ещё на две части (рис.1,2).

Рис.1 Создание структуры проекта

Рис.2 Информация о странице

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

По умолчанию проект в Dr.Explain имеет три страницы:

Начальная страница содержит наименование проекта и указание на то, чем является файл (по умолчанию отображается значение «Руководство пользователя»). В оглавлении отражена структура справочной документации. Страница представляет собой шаблон для первой темы проекта, в рамках которого и идёт создание всей документации. Например, можно поменять название данной страницы на «Глава 1» и создать в ней параграфы и новые главы.

В левой нижней части главного окна Dr.Explain отражается информация о выделенной странице, в том числе её имя, наименование сопутствующего файла, который получается при экспорте документации, статус и многое другое. В правой части главного окна Dr.Explain, собственно, создаётся сама документация с возможностью предварительного просмотра в нескольких форматах данных. К редактированию проекта можно легко вернуться, нажав на кнопку Редактор. Типовой интерфейс проекта представлен на рисунке 3:

Рис.3 Интерфейс проекта

Функциональные возможности Dr.Explain

Среди основных возможностей Dr.Explain можно выделить:

• Возможность экспорта проекта в основные форматы справочной документации;
• В Dr.Explain присутствует уникальная возможность – захват выбранной вами области экрана либо экрана целиком для последующего использования в документации. Подобная операция легко осуществляется нажатием нескольких кнопок, и результат сразу оказывается в тексте проекта;
• При создании CHM справки может возникнуть необходимость в индексированном поиске, а для этого придётся использовать ключевые слова, которые можно легко задать;
• Также можно указать статус для раздела документации. Всего существует четыре статуса:

• Не начато – активен по умолчанию, ничем не выделяется;
• В работе – выделяется жёлтым цветом, можно использовать для того, чтобы отметить редактируемый раздел;
• Закончено – выделяется зелёным цветом, для выделения уже законченных разделов документации;
• Ожидается – выделяется красным цветом, для выделения тех разделов, которые планируется редактировать.

Ключевые особенности Dr.Explain

Dr.Explain имеет несколько отличительных особенностей:

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

Рис.4 Панель инструментов Редактирование

• Также во вкладке Инструменты можно проверить проект на ошибки, в результате чего можно выявить:

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

Рис.5 Вкладка Инструменты

• Если на рабочем месте нет Adobe Reader или MS HTML Help Workshop, то, к сожалению, будет отсутствовать возможность экспорта в PDF и CHM формат соответственно. Тем не менее, не нужно разочаровываться, поскольку Dr.Explain предлагает ссылки на скачивание данных продуктов, являющихся бесплатными, с официальных сайтов.

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

Официальный сайт программы: www.drexplain.ru

Вам понравился продукт Dr.Explain? Вы можете приобрести его в нашем магазине программного обеспечения для технических писателей!

Источник: protext.su