Background

Статьи об использовании продукта Dr.Explain

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


Разработка документации для систем автоматизации производственных и бизнеc-процессов

Обычные текстовые инструкции не способны в полной мере объяснить преимущества и раскрыть потенциал сложной системы автоматизации бизнес-процессов. Если пользователь не понимает выгод от ее применения, он будет считать её лишней и бесполезной.

Разработка пользовательской документации для бухгалтерского ПО и систем учета: особенности, инструменты, специальные приемы

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

Разработка пользовательской документации для ERP-систем: особенности, инструменты, специальные приемы

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

Разработка документации для САПР и BIM-систем: особенности, специальные приемы и инструменты

Написание пользовательской документации для САПР и BIM-систем отличается высокой сложностью. Как создать понятную и полезную документацию и какие для этого существуют инструменты? Рассматриваем рекомендации и приводим реальные примеры успешной реализации пользовательских справок.

"Понятный" интерфейс в программах для создания пользовательской документации

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

Применение теории разбитых окон в написании документации

Как теория разбитых окон применяется в написании документации? Как поддерживать проект в актуальном состоянии и избежать его устаревания?

Как выбрать программу для написания пользовательской документации: SaaS или десктопное ПО?

Разбираем преимущества и недостатки двух подходов в написании технической документации: SaaS и десктопное ПО.

Dr.Explain как аналог иностранного программного обеспечения в условиях санкций и концепции импортозамещения

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

Разработка пользовательской документации для включения программного продукта в Реестр отечественных программ Минцифра России

Какой должна быть пользовательская документация, чтобы программа попала в Реестр отечественного ПО

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

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

Создание файла помощи - файла справки - в формате CHM для .NET Windows-приложения - с примерами

В этой статье с примерами кода рассматривается вопрос создания файла справки в формате CHM с помощью программы Dr.Explain, а также его интеграция в .NET-приложение.

Создание help-файла (справки) в формате CHM для Visual Basic (VB.NET)-приложения для Windows при помощи Dr.Explain

Статья с примерами кода посвящена созданию файла справки в программе Dr.Explain и его интеграции в приложение Visual Basic (VBA.NET).

Создание help-файла (справки) в формате CHM для MS Excel-приложения для Windows при помощи Dr.Explain

Статья с примерами кода посвящена созданию файла справки в формате CHM и его последующей интеграции в книгу Microsoft Excel

Создание help-файла (справки) в формате CHM для MS Access-приложения для Windows в Dr.Explain

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

Создание help-файла (справки) в формате CHM для Delphi-приложения для Windows в Dr.Explain

В статье с примерами кода описан процесс создания в программе Dr. Explain файла контекстной справки для Delphi приложения и его последующая интеграция в программу.

Зодиак технических писателей: особенности характера и предрасположенности в работе

Гороскоп технических писателей: Характеристики технических писателей по знакам Зодиака

10 эвристик для оценки удобства использования (юзабилити) вашей документации

Сегодня, даже если вы полностью перешли на online-документацию, эти эмпирические правила остаются хорошим подспорьем при оценки качества документации.

16 причин, почему ваши пользователи не читают документацию

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

Делайте правильно! Публикуем онлайн-документацию на сайте проекта

Очевидным выбором для публикации онлайн-справки кажется традиционный HTML, а точнее DHTML (Dynamic HTML). Документация представлена набором HTML файлов, изображений, а также JavaScript-файлов, которые отвечают за всю динамику.

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

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