Dr.Explain

Dr.Explain — это не продукт Microsoft. Это самостоятельная программа от российской компании Indigo Byte Systems, LLC. Вероятно, возникла путаница, так как инструмент часто используется разработчиками, пишущими софт для Windows, но сама компания Microsoft к его созданию отношения не имеет.

Dr.Explain — это мощный инструмент для создания технической документации (Help Authoring Tool, или HAT). Его главная задача — автоматизировать написание руководств пользователя, справок (файлы .chm, .hxs) и онлайн-баз знаний.

Ключевые возможности:

• Автоматический захват и аннотация интерфейса. Программа умеет делать снимки экрана вашего приложения и сама расставлять на них нумерацию, стрелки и рамки вокруг кнопок и полей. Это экономит огромное количество времени: не нужно вручную рисовать стрелки в графическом редакторе.
• Единый источник (Single-sourcing). Вы пишете текст один раз, а программа сама собирает из него разные форматы: онлайн-справку (HTML/JavaScript), PDF-файл, документ Word или классическую справку Windows (.chm).
• WYSIWYG-редактор. Интерфейс напоминает Microsoft Word, что упрощает работу для тех, кто не знаком с разметкой Markdown или HTML.
• Совместная работа. Поддерживает экспорт и импорт в форматах, удобных для переводчиков и технических писателей.
• Лицензирование. Существует бесплатная версия с ограничением на размер проекта и водяными знаками на изображениях. Платная (коммерческая) лицензия убирает ограничения и водяные знаки.

В чем разница между Dr.Explain и Markdown в VSCode?

Это инструменты для разных задач, хотя оба работают с текстом и кодом:

Параметр	Markdown в VSCode	Dr.Explain
Суть	Формат текстового файла и редактор.	Отдельная программа (GUI-приложение).
Для чего лучше всего	Описание архитектуры, планов, задач, README.md файлов, ведение документации прямо в коде (ADR).	Написание официальной «Пользовательской документации» (User Manual) с сотнями скриншотов.
Работа со скриншотами	Вставляются вручную как ссылки на файлы. Их нужно обрабатывать в сторонних редакторах.	Автоматический захват экрана, автоматическое добавление теней, номеров и стрелок.
Сложность вхождения	Очень низкая. Нужно знать только синтаксис решетки # и кавычек ```	Выше. Требуется установка ПО и изучение его интерфейса.
Итоговый продукт	Текстовый файл, который легко читать в GitHub/GitLab, или простой сайт.	Профессиональный файл справки (.chm), интерактивный сайт или сверстанный PDF.

Когда что выбирать:

• Если вы пишете внутреннюю документацию для разработчиков (как в вашем примере с архитектурой Gateway, контрактами и этапами эволюции) — оставайтесь в Markdown в VSCode. Это быстрее, текст находится прямо в репозитории, и его удобно ревьювить через Pull Request.
• Если вы пишете руководство для конечного пользователя (например, «Как нажать кнопку "Купить" в торговом терминале»), где на каждой странице нужен скриншот с обведенной кнопкой — здесь Dr.Explain будет в разы эффективнее ручного написания Markdown.