Меню

Интерактивные электронные руководства

Интерактивные электронные руководства

service_img

PowerGuide — программное обеспечение для создания и использования интерактивных 3D инструкций по сборке, эксплуатации, техническому обслуживанию и ремонту.
В отличие от бумажных руководств POWERGUIDE включает в себя интерактивные 3D-модели и реалистичные анимации. Все данные связаны между собой, что позволяет мгновенно находить всю связанную документацию и получать полное представление о технологических процессах в нужный момент.

Области применения PowerGuide

Традиционные руководства

Цифровые руководства PowerGuide

Текстовые документы, 2D-чертежи

Текстовое описание, 2D-чертежи, 3D-модели, анимация техпроцесса, фото/аудио/видео и другие

ПК, планшет, смартфон, промышленный киоск, шлем виртуальной реальности

Требуют много времени на поиск и сопоставление документов, создание копий и печать

Поиск информации в базе данных мгновенно отобразит техпроцесс, эскизы, схемы, нормы времени и расхода материалов, оснастку и другие связанные данные

Отслеживание актуальной версии

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

Лучшие практики вносятся в электронную базу – вы не потеряете наработанный опыт с уходом опытных сотрудников

Пользователь может взаимодействовать с информацией – выделять детали на 3D-модели, подгружать любые связанные документы, добавленные в систему

Сложный процесс внесения изменений
и контроля доставки и актуальности инструкций на рабочих местах

Регистрируйте изменение только один раз – все связанные данные изменятся автоматически

Интерфейс

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

Интерактивная взаимосвязь 3D-модели и справочной информации

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

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

Редактор

PowerGuide снабжен собственным редактором, который позволяет эффективно работать с:

Интеграция с VR|AR

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

Благодаря цифровому двойнику изделия в виртуальной реальности обучение можно ускорить. Обучающие материалы POWERGUIDE это:

максимальное погружающее обучение;

интерактивный процесс изучения информации;

практика сборки до выхода в реальные условия цеха;

увеличение вовлеченности благодаря геймификации;

высокая скорость усвоения информации за счет реалистичности подачи материала по сравнению с традиционными методами;

дает полное представление реального масштаба, зон видимости;
и доступа к узлам и агрегатам реального изделия.

Понятные и удобные руководства – инструмент повышения эффективности работы цеха

Интерактивные инструкции позволят:

сократить количество ошибок за счет информационной поддержки работников цеха при выполнении сложных технологических операций;

ускорить разработку и согласование новых техпроцессов;

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

создать единый источник данных всех технологических и эксплуатационных процессов предприятия;

управлять изменениями и актуализировать данные;

ускорить обучение с помощью наглядных и интерактивных учебных материалов;

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

Источник



Интерактивный что означает это слово?

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

Что означает слово «интерактивный» в общем?

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

Интерактивность – это способность устройства, с которым взаимодействует человек, задействовать искусственный интеллект, подстроиться под потребности пользователя.

Чтобы понять лучше, что такое интерактивный, лучше рассмотреть несколько конкретных примеров, в совокупности с которыми мы наиболее часто встречаем употребление этого термина.

Интерактивное ТВ – что это?

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

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

Чтобы пользоваться таким телевидением понадобится купить современный телевизор с функцией смарт или специальную IPTV приставку.

Интерактивный урок – что это?

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

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

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

Интерактивная доска – что это?

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

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

Еще более интересным и увлекательным сделать обучающий процесс способно устройство интерактивный пол-стена Master Touch. Это особый проектор, который может проецировать изображение, как на стену, так и на пол. Его используют при обучении детей младшего возраста. Устройство позволяет проводить обучающий процесс, а также отдыхать детям, взаимодействуя с изображением на полу или стене.

Интерактивный класс – что это?

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

Оборудование, которое используется для оснащения таких классов и аудиторий, это:

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

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

Интерактивная игра – что это?

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

Читайте также:  Table tr td style line height 1em ИНЦИДИН ЭКСТРА Н td tr table

Инструментом для проведения таких игр выступают все те же интерактивные доски, пол.

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

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

Интерактивные игрушки

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

Что можно отнести к таким игрушкам? Любые устройства, взаимодействующие с малышом, реагирующие тем или иным образом на его действия.

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

Нравится мальчикам и девочкам играть с разными зверушками (котятами, щенками, птичками и т. д), роботами. Радости вашего сына или дочери не будет предела, если вы купите им Собаку робота WOWWEE Chip или забавного зверька Ферби.

Для самых маленьких создатели игрушек придумали всевозможные гаджеты (детские мобильные телефоны, планшеты, компьютеры), которые взаимодействуют с ребенком, откликаются на его команды и действия.

Интерактивная карта – что это?

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

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

Интерактивная ставка – что это?

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

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

К чему еще применимо слово интерактивный?

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

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

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

Источник

Гайды: 8 советов по написанию инструкций

8 советов по написанию инструкций

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

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

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

Содержание статьи:

Чем полезны инструкции

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

«Для завершения установки обновлений перезагрузите смартфон».

  • требуемое действие — нажать на кнопку перезагрузки;
  • желаемый результат — установка обновлений прошла успешно.

Хороший гайд отличается двумя ключевыми характеристиками:

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

2. Ее результат конкретный. Пользователь придерживается рекомендаций и достигает желаемой цели (готовит торт, настраивает роутер или создает свой интернет-магазин на бесплатном движке).

Если результат в инструкции не описан, практическая польза от нее отсутствует.

Для чего еще нужна инструкция:

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

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

Разновидности инструкций

8 советов по написанию инструкций

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

Выделяют следующую классификацию инструкций:

1. По сборке предметов или по строительству каких-либо объектов.
2. По применению чего-либо.
3. Медицинские инструкции к препаратам.
4. Инструкции формата «Как сделать …».
5. Гайды по приготовлению пищи (рецепты).

Руководство может быть полным — это описание процесса полностью от начала и до конца (например, создание сайта с нуля или канала на Ютубе). Короткое «Как руководство» дает конкретный ответ лишь на один вопрос: как сменить лампочку, как работать с презентацией или как вывести пятно с ткани.

Что учесть в процессе создания гайда

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

Уровень знаний читателя

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

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

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

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

Читайте также:  Пошаговый план открытия магазина

Писать по делу и не лить воду

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

Пример плохого вступительного абзаца:

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

Лучше заменить текст на:

«Представляем 3 простых способа замены фона на фотографии, с которыми справятся даже новички. Применить их можно в версии Photoshop CC 2015 и выше».

Это тоже вступление, которое подскажет читателю, о чем пойдет речь в руководстве, но в нем нет воды.

Длинное вступление можно существенно сократить без потери смысла

Учитесь искать компромисс между подробным описанием и лаконичностью. Нет оптимального размера гайда, все зависит от вашей аудитории. В идеале, чем короче и лаконичней руководство — тем лучше. Главное, чтобы содержания было достаточно для решения проблемы пользователя.

Стиль текста

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

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

Без иллюстраций никуда

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

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

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

Если требуется описать пошагово работу с программой на телефоне или ПК, делайте скриншоты каждого шага в процессе. Проще удалить лишнее при написании инструкции, чем поздно понять, что важных картинок не хватает. Упростить работу со скриншотами помогут специализированные сервисы: LightShot, Joxi, «Яндекс.Скриншот». Функционал этих программ позволяет делать захват всего экрана или только определенной области. Здесь же можно добавлять на рисунок надписи, рамки или стрелки для наглядности.

Интерфейс программы «Яндекс.Скриншот»

В некоторых случаях даже с помощью изображений сложно что-то объяснить. Например, как выполнить упражнение или перетянуть иконку с места на место. Решением проблемы станет Gif-анимация. Не добавляйте изображения в инструкцию просто «чтобы было». В гайде неуместны картинки с котиками или мемы, оставьте это для простых статей. Не перебарщивайте с картинками!

Экспертность важна

Требования к контенту:

1. Полезный, решает проблемы ЦА.
2. Подробный, раскрывает нюансы и описывает этапы.
3. Наглядный, в нем достаточно инфографики, чек-листов и изображений.
4. Структурированный и легкий для восприятия.
5. Экспертный — автор должен хорошо понимать, о чем идет речь или писать на основании своего опыта.

Источник

Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.

Традиционно в России для поддержки эксплуатации сложных промышленных изделий применяют бумажную документацию. Но, в связи со стремительным ростом сегмента IT-технологий все чаще находит применение интерактивная техническая документации в электронном виде. Такие электронные документы, содержащие в себе сведения об изделии, его составе, устройстве, принципе работы, составе ЗИП, процедурах технического обслуживания, анимацию или видео по сборке/разборке/обслуживанию принято сокращенно называть ИЭТР.

solidcomposer1.jpg

ИЭТР – это интерактивное электронное техническое руководство.

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

  • ГОСТ 2.051-2013 ЕСКД Электронные документы. Общие положения.
  • ГОСТ 2.601-2013 ЕСКД Эксплуатационные документы – дается понятие об эксплуатационном документе в электронной форме.
  • ГОСТ Р 50.1.029-2001 Информационные технологии поддержки жизненного цикла продукции. Интерактивные электронные технические руководства. Общие требования к содержанию, стилю и оформлению.
  • ГОСТ Р 50.1.030-2001 Информационные технологии поддержки жизненного цикла продукции. Интерактивные электронные технические руководства. Требования к логической структуре базы данных.

Кроме того, существует ряд международных стандартов по разработке ИЭТР, наиболее известный из них: S1000D – спецификация на выпуск технических публикаций с использованием базы данных общего доступа. Спецификация разработана и сопровождается экспертами производителей гражданской и военной техники таких организаций, как: Aerospace and Defence Industries Association of Europe (ASD); Aerospace Industries Association (AIA); ATA e-Business Program

Классы ИЭТР

В ГОСТ Р 50.1.030-2001 по функциональным возможностям выделено четыре основных класса ИЭТР.

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

ИЭТР 2-го класса — линейно-структурированные электронные документы
ИЭТР данного класса представляет собой совокупность текстов в формате SGML. Оглавление ИЭТР содержит ссылки на соответствующие разделы технического руководства. ИЭТР может содержать перекрестные ссылки, таблицы, иллюстрации, ссылки на аудио- и видеоданные. Предусматривается функция поиска данных. ИЭТР может быть просмотрен на экране и распечатан без предварительной обработки.
Примечание — Основным недостатком ИЭТР классов 1 и 2 является дублирование многократно используемой информации.

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

ИЭТР 4-го класса — интегрированные ИЭТР
В добавление к функциям ИЭТР класса 3, ИЭТР данного класса обеспечивает возможность прямого интерфейсного взаимодействия с электронными модулями диагностики изделий. ИЭТР класса 4 позволяет наиболее эффективно проводить операции по поиску неисправностей в изделии, локализации сбоев, подбору запасных частей.

Читайте также:  Видео обзоры u Dimension GLOW 8100SW

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

Разработка ИЭТР в SolidWorks Composer

Разработка интерактивных руководств в нашей компании ведется при помощи программного обеспечения SolidWorks Composer – мощного продукта для создания интерактивных и маркетинговых материалов на базе конструкторских разработок.

Работа начинается с 3D моделей и чертежей, созданных в продуктах SolidWorks, Autodesk Inventor, Creo (Pro Engineer), CATIA, Компас и др. совместимых с форматом .STEP, а также с бумажными чертежами. Информация по эксплуатации для включения в ИЭТР может быть распознана из бумажных документов или разработана нашими специалистами.

Что мы делаем при помощи SolidWorks Composer: разрабатываем ИЭТР и составляющие для него — делаем рендеринг моделей, создаем анимации, видео-ролики по сборке/разборке/обслуживанию изделий, интерактивные чертежи и схемы, электронные справки по работе и устройству изделий.

solidcomposer.jpg

Основные преимущества использования SolidWorks Composer для разработки ИЭТР:

Для просмотра результатов нашей работы не нужно приобретать специальное программное обеспечение – для работы с 3D моделями, анимацией и видео в составе ИЭТР уже есть электронная система отображения (ЭСО) – Composer Player, встроенная в файл ИЭТР.

Сквозной подход к проектированию не потребует разработки ИЭТР заново при изменении модели или чертежа, достаточно обновить модель и модули данных и содержание ИЭТР перестраивается автоматически – меньше затрат на сопровождение и корректировку документации.

SolidWorks Composer – это современный программный продукт от лидера рынка САПР — Dassault Systèmes SOLIDWORKS Corp., полностью поддерживающий технологии сквозного проектирования CAD\CAM\CAE, он не исчезнет с рынка, а будет развиваться, и приносить новые возможности по разработке интерактивной технической документации.

Источник

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

image

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

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

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

Dr.Explain vs. Help and Manual

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

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

image

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

image

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

image

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

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

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

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

Кое-что еще…

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

image

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

Источник