В данном разделе мы публикуем статьи, посвященные эффективной работе в программе Dr.Explain, а также полезные материалы по разработке документации, техническому писательству и сопровождению программного обеспечения.
Что общего между автором, населяющим кошмары клоунами-убийцами, ожившими автомобилями, и техническим писателем, который методично описывает инструкции? На первый взгляд — ничего. Но если заглянуть в саму суть писательского ремесла...
Книга Кена Косиенды, бывшего инженера Apple, об истории создания знаковых продуктов. Что можно почерпнуть из нее техническому писателю?
Следующая справочная система интересна не только находками в виде интерактивных элементов, но и примерами того, что может испортить онлайн документацию: неудачная верстка, не адаптивный текст, ограниченные возможности навигации и поиска.
Рассматриваем пример пользовательской документации BPA-платформы Process Maker: реализация поиска, навигации, структура контента, наглядность.
Насколько легко пользователям находить ответы в вашей справочной системе? Удобна ли она для них? Ответы на эти вопросы помогут вам улучшить руководство, выявив его слабые места. Один из способов узнать мнение пользователей — шкала Лайкерта.
Рассмотрим пользовательскую документацию сервиса Cflow — платформы для автоматизации рабочих процессов. Cflow использует в написании сценарный подход: информация строится вокруг конкретных задач пользователя, а не функций продукта.
Рассказываем, как сделать аннотации в Word и показываем, как сделать это еще быстрее в специальной бесплатной программе.
Цифровизация охватила многие сферы бизнеса, а в тех отраслях, где точность имеет критически важное значение, без специализированного софта теперь вовсе не обойтись. Новые технологии оптимизируют затраты и сводят вероятность ошибок к минимуму. Это особенно актуально в производстве промышленного оборудования.
Обычные текстовые инструкции не способны в полной мере объяснить преимущества и раскрыть потенциал сложной системы автоматизации бизнес-процессов. Если пользователь не понимает выгод от ее применения, он будет считать её лишней и бесполезной.
Сложные программы должны сопровождаться четкой, наглядной инструкцией и справочной базой, но как их написать? К счастью, есть инструменты, позволяющие без особых временных затрат создавать профессиональные пользовательские инструкции к бухгалтерскому ПО и системам учета. Об этом в нашей новой статье.
Иногда предприятие внедряет ERP-систему, а нужного эффекта нет. Все дело в сложности, которая отталкивает сотрудников. Приводим примеры эффективных пользовательских документаций и инструменты для их написания.
Написание пользовательской документации для САПР и BIM-систем отличается высокой сложностью. Как создать понятную и полезную документацию и какие для этого существуют инструменты? Рассматриваем рекомендации и приводим реальные примеры успешной реализации пользовательских справок.
Рассказываем об особенностях интерфейса в технической документации, рассматриваем распространенные ошибки в его проектировании, приводим удачные примеры реализации.
Как теория разбитых окон применяется в написании документации? Как поддерживать проект в актуальном состоянии и избежать его устаревания?
Разбираем преимущества и недостатки двух подходов в написании технической документации: SaaS и десктопное ПО.
Импортозамещение: обзор иностранных программных продуктов, аналогом которых может стать Dr.Explain - инструмент для создания пользовательской, справочной и технической документации, инструкций, баз знаний с возможностью многопользовательской работы над проектами.
Какой должна быть пользовательская документация, чтобы программа попала в Реестр отечественного ПО
Готовые к использованию примеры и образцы пользовательской документации от разработчиков Dr.Explain - инструмента для быстрого создания руководств пользователя, файлов помощи, онлайн-справки.
В этой статье с примерами кода рассматривается вопрос создания файла справки в формате CHM с помощью программы Dr.Explain, а также его интеграция в .NET-приложение.
Статья с примерами кода посвящена созданию файла справки в программе Dr.Explain и его интеграции в приложение Visual Basic (VBA.NET).
Статья с примерами кода посвящена созданию файла справки в формате CHM и его последующей интеграции в книгу Microsoft Excel
В инструкции с примерами кода описан процесс создания в программе Dr. Explain файла справки для Microsoft Access приложения и его последующая интеграция в формы базы данных.
В статье с примерами кода описан процесс создания в программе Dr. Explain файла контекстной справки для Delphi приложения и его последующая интеграция в программу.
Гороскоп технических писателей: Характеристики технических писателей по знакам Зодиака
Сегодня, даже если вы полностью перешли на online-документацию, эти эмпирические правила остаются хорошим подспорьем при оценки качества документации.
Пользователи читают документацию. Во многих проектах она очень востребована, а в некоторых является критически важным компонентом предлагаемого продукта или сервиса. Однако, документацией к продукту иногда, действительно, не пользуются. В основном, это происходит по нескольким причинам.
Очевидным выбором для публикации онлайн-справки кажется традиционный HTML, а точнее DHTML (Dynamic HTML). Документация представлена набором HTML файлов, изображений, а также JavaScript-файлов, которые отвечают за всю динамику.
Использование программы Dr.Explain - один из самых простых способов создать онлайн-справку профессионального уровня с поддержкой мобильных устройств.
Разработка и написание хорошей документации - это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов.
Программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ 19 и ГОСТ 34 в проектах. Это облегчит жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями ГОСТ.