Текст, изображения или видео в вашем техническом сообщении?

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

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

В этом посте я дам вам 15 вопросов, которые помогут вам выбрать правильный носитель.

15 вопросов, которые нужно задать себе, чтобы выбрать правильный носитель

1. Запрещено ли законом использование изображений или видео?

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

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

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

Также в Европейском союзе правила безопасности продукции требуют четких инструкций. Например, в Директиве по низковольтному оборудованию 2014/35/ЕС говорится: «Такие инструкции и информация о безопасности, а также любая маркировка должны быть четкими, понятными и разборчивыми».

Как производитель вы будете нести ответственность в случае непредупреждения покупателей.

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

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

2. Есть ли у вашего пользователя доступ к Интернету?

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

Пользователь проверит YouTube на наличие видео «Как сделать», когда у него или у нее будет время и когда будет доступен Интернет. Потребность в информации в этом случае менее актуальна, чем когда, например, поезд застревает в туннеле. В этом случае вы определенно хотели бы, чтобы информация была доступна в автономном режиме! Лучше всего использовать текст (поддерживаемый изображениями), когда информация доступна в автономном режиме.

3. Регулярно ли обновляется контент?

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

4. Могут ли изображения поддерживать, заменять или дополнять текст?

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

Установку продукта можно легко объяснить с помощью иллюстраций. Иллюстрации могут поддерживать текст или даже полностью его заменять.

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

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

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

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

5. Может ли использование изображений или видео сэкономить на затратах на локализацию?

Хотя основной причиной использования визуальных элементов должно быть улучшение понимания для пользователя, в некоторых случаях решение об использовании изображений может основываться на затратах. Например, в руководствах по установке ИКЕА в основном не используется текст. Это существенно экономит затраты на перевод, поскольку ИКЕА продает свою продукцию в 28 странах (на 17 разных языках).

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

6. Как выглядит процесс локализации вашей помощи пользователям?

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

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

Вам нужен текст в ваших иллюстрациях? Вы доставляете в 28 стран?

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

Несмотря на наличие расширенных функций/инструментов для локализации текста в изображениях (например, с помощью функции перевода в Snagit), вам не следует редактировать все ваши файлы Illustrator на 28 различных языках.

Как правило, просто использовать текст проще для перевода, чем сочетание текста и изображений.

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

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

7. Есть ли у вас ресурсы для создания изображений или видео?

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

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

А плохо сделанное изображение или видео, скорее всего, не достигнет своей цели.

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

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

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

8. Нужно ли мне что-то демонстрировать?

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

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

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

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

9. Нужно ли демонстрировать движение?

Помощь пользователю часто включает движение.

Это может быть движение мыши при использовании Photoshop Polygonal Lasso Tool, вращение вентиля, заправляющего нитку в швейную машину или взламывающего замок.

Движение трудно объяснить только текстом или фотографиями.

Используйте видео, когда хотите продемонстрировать движение.

10. Нужно ли мне демонстрировать состояние?

Состояние чего-либо сложно передать изображениями, фотографиями или текстом сами по себе.

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

Добавление видео поможет вам объяснить, как должно выглядеть состояние чего-либо.

11. Нужно ли мне демонстрировать силу?

Кроме того, как применять силы, трудно объяснить на фотографиях или в тексте.

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

Когда вам нужно продемонстрировать, сколько силы нужно использовать, видео — это ваше решение.

12. Сколько людей я хочу охватить?

Единственное, что людям нравится больше, чем картинка, — это движущаяся картинка.

И люди тянутся к обучающим видео.

При поиске «как сделать» на YouTube вы получите 439 миллионов просмотров! Учебник на YouTube о том, как сложить футболку, был просмотрен почти 9 миллионов раз!

Вероятность того, что кто-то посмотрит видео, на 75% выше, чем чтение текста (источник). Видеоуроки смотрят; текст пропускается.

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

13. Нужна ли моему пользователю очень конкретная информация?

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

Вы не хотите смотреть 20-минутное видео, когда вас интересует только поиск определенного винта. Листать страницы руководства пользователя или просто использовать ctrl +f в электронной версии работает лучше.

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

Вы можете сделать свои видео более удобными для сканирования, сделав их короткими, добавив титры или субтитры и сделав текст доступным для поиска.

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

14. Каков мой бюджет?

Деньги! Профессионально сделанные видео и изображения могут стоить дорого. Когда они не сделаны профессионально, они могут выглядеть ужасно.

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

Большую часть программного обеспечения можно объяснить недорогими скринкастами.

15. Важно ли пользователю помнить

информация на более позднем этапе?

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

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

Когда пользователям необходимо запомнить и воспроизвести информацию на более позднем этапе, видео будет подходящим средством.

Вывод

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

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

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

• Когда нужно что-то продемонстрировать
• Когда эффективность обучения играет важную роль
• Когда вы ориентируетесь только на пользователей мобильных устройств и ваша аудитория всегда имеет доступ к Интернету
• Когда у вас есть ресурсы для создания качественного видео
• Когда вы хотите охватить большую аудиторию

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

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

Это ваша ответственность доставить это!

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

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

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

Вы можете добиться этого!

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