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

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

Из новой статьи вы узнаете, как:
✅ сэкономить на техподдержке;
✅ сэкономить на страховке сотрудников;
✅ использовать правильный инструмент для создания качественных пользовательских справок в промышленных масштабах.

https://www.drexplain.ru/articles/razrabotka_dokumentatsii_dlya_priborov_i_promyshlennogo_oborudovaniya_osobennosti_instrumenty_spetsi/

Доверие профессионалов: создатели программы для защиты информации выбрали Dr.Explain

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

Applicando Srl — консалтинговая компания, соответствующая Общему регламенту Европейского союза по защите данных. Компания создает систему по контролю за соблюдением правил конфиденциальности.

Ее глава, Джузеппе Ицциноза, рассказывает, почему он выбрал для написания руководства Dr.Explain:

https://www.drexplain.ru/cases/applicando-razrabatyvaet-udobnuyu-sistemu-upravleniya-s-dr-explain/

Radiant Technologies перешла с RoboHelp на Dr.Explain и ускорила работу почти на 100%

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

https://www.drexplain.ru/cases/radiant-technologies-pereshla-s-robohelp-na-dr-explain-i-uskorila-rabotu-pochti-na-100/

Fermagri использует Dr.Explain для эффективного обучения пользователей работе в ERP-системе

Многие авторы не решаются перейти на специализированную программу для создания пользовательских руководств. Они противятся прогрессу и продолжают писать в непредназначенных для этого программах:
— Старый конь борозды не испортит!
— Старый друг лучше новых двух!
— Стерпится — слюбится!

Еще одна причина: что если новая программа окажется слишком сложной?

А вот сеньор Дэвид Роман из Эквадора оказался не из робкого десятка. Намучившись с несовершенством старого софта, в котором писалась пользовательская документация, он принял единственно правильное решение…

https://www.drexplain.ru/cases/fermagri-ispolzuet-dr-explain-dlya-effektivnogo-obucheniya-polzovateley-rabote-v-erp-sisteme/

Dr.Explain облегчает освоение программы MigrisX без подготовительных курсов

Компания MigrisX рассказала, как им удается удачно совмещать справочную документацию в Dr.Explain и ролики на YouTube, в которых демонстрируются различные рабочие процессы и способы их выполнения.

https://www.drexplain.ru/cases/dr-explain-oblegchaet-osvoenie-programmy-migrisx-bez-podgotovitelnykh-kursov/

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

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

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

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

https://www.drexplain.ru/cases/testview-organizovali-sovmestnuyu-rabotu-nad-polzovatelskoy-dokumentatsiey-v-dr-explain/

Altuity пишет в Dr. Explain инструкции для работы с ERP-системами

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

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

https://www.drexplain.ru/cases/altuity-pishet-v-dr-explain-instruktsii-dlya-raboty-so-slozhnym-po/

🔧 Создавайте пользовательскую документацию быстрее с Dr.Explain! 🚀
Создание документации с нуля может быть сложной и трудоемкой задачей. Используйте готовые шаблоны и создавайте профессиональную документацию в несколько кликов.
📋 Почему это удобно?
1. Экономия времени: начните с шаблона и сосредоточьтесь на содержании, а не на структуре.
2. Нет проблемы чистого листа: шаблоны помогают начать работу над документом, даже если у вас нет опыта.
3. Легкость использования: Dr.Explain позволяет быстро адаптировать шаблон под ваши нужды.
#DrExplain #Документация #Шаблоны #Продуктивность #ТехническоеПисьмо

Dr.Explain помог увеличить поисковый трафик

Structured Solutions Inc. перешли на Dr.Explain, и больше им не приходится дублировать контент: печатное руководство пользователя и его онлайн-версию с удобной навигацией и интерактивными элементами они получают из одного исходника “в два клика”.

А еще онлайн-руководство улучшило видимость их сайта в поисковых системах.

Вот как они внедрили Dr.Explain в свои бизнес-процессы:

https://www.drexplain.ru/cases/dr-explain-pomog-ssi-uvelichit-trafik-iz-poiskovykh-sistem-i-snizit-nagruzku-na-sluzhbu-podderzhki/

#DrExpain #SEO #СЕО #софт #soft

Принцип объединения (ТРИЗ) в пользовательской документации

Методология ТРИЗ (Теория Решения Изобретательских Задач) разработана для систематического подхода к решению задач. Но ее принципы можно использовать и при написании пользовательской документации.

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

Допустим, нужно обучить пользователя работе в САПР, а именно объяснить процесс создания объектов.

Обычно дерево разделов выглядит примерно так:
-Основы моделирования
-Базовые элементы
-Навигация
-Связи
-…

-Архитектурно-строительные конструкции
-Стены
-Балки
-…

-Экспорт
-Настройки экспорта
-Экспорт атрибутов
-…

Можно объединить три шага создания объекта “создание - модификация - экспорт” в один раздел:
-Создание объекта
-Базовые элементы
-Балки
-Настройки экспорта

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

Database Software с помощью Dr.Explain получили конкурентное преимущество

Разработка ERP-систем — конкурентная среда. Как выделить свой продукт? Чем привлечь пользователей?

Алекс Мьюир, управляющий директор компании Database Software Solutions Ltd, вот уже 20 лет имеет дело с системами бухгалтерского учета и автоматизации бизнес-процессов. Кажется, он нашел ответ:

https://www.drexplain.ru/cases/rukovodstvo-polzovatelya-dlya-erp-sistemy-snizilo-nagruzku-na-tekhpodderzhku-na-40/

C-A-Solutions выигрывает от использования Dr.Explain

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

Это наиболее удобный и доступный инструмент из всего, что он видел. А видел не немало. Боб Гримшоу, основатель компании C-A-Solutions, рассказывает, почему написание пользовательской документации в Microsoft Word — не лучшее решение:

https://www.drexplain.ru/cases/c-a-solutions-smenila-ms-word-na-dr-explain-i-snizila-nagruzku-na-sluzhbu-podderzhki/

Dr.Explain помогает вносить вклад в международные исследовательские проекты

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

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

Сделать сложный софт понятным представителям настолько разных отраслей непросто.

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

https://www.drexplain.ru/cases/dr-explain-pomogaet-sozdavat-effektivnye-fayly-pomoshchi-dlya-po-v-oblasti-bioinformatiki/

Hensoldt: создание руководств в Dr.Explain — сплошное удовольствие

Знаете, почему многие авторы продолжают писать пользовательские руководства в непредназначенных для этого программах?

Дело в том, что зачастую программное обеспечение для решения какой-либо задачи само требует немало времени на освоение.

Винни Скосана — технический писатель из компании Hensoldt. Она нашла софт, который не потребовал от нее длительного изучения, и буквально с первых минут убедил ее в правильности выбора.

Вот ее рассказ:

https://www.drexplain.ru/cases/dlya-hensoldt-sozdanie-rukovodstv-s-dr-explain-sploshnoe-udovolstvie/

Kumulsoft: иногда один инструмент меняет всё!

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

Предлагаем вашему вниманию интервью с руководителем стартапа из Новой Гвинеи.

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

https://www.drexplain.ru/cases/dr-explain-ekonomit-resursy-kompanii-kumulsoft/

Создавайте в Dr.Explain пользовательские документации в форматах:

✅ HTML (с адаптивным дизайном);
✅ CHM;
✅ PDF;
✅ DOCX.

Используйте готовые шаблоны или измените оформление в соответствии со стилистикой вашего бренда.

Знаний кода не требуется.

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

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

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

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

https://www.drexplain.ru/cases/kompaniya-damselfly-sozdala-v-dr-explain-spravochnuyu-sistemu-dlya-net-prilozheniy/

Ala Data System упростила создание руководств с помощью Dr.Explain

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

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

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

Господин Калмо из компании Ala Data System занимается написанием софта, в том числе и для бухгалтерских фирм. Он рассказал нам, чем его так привлек Dr.Explain:

https://www.drexplain.ru/cases/ala-data-system-uprostila-sozdanie-rukovodstv-pri-pomoshchi-dr-explain/

Пример пользовательской документации: база знаний сервиса Cflow

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

Сегодня рассмотрим справочную базу Cflow — платформы для автоматизации рабочих процессов.

https://www.drexplain.ru/articles/obzor_bazy_znaniy_platformy_cflow/