Как создать пошаговые инструкции с помощью визуальных средств

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

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

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

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

Прежде чем приступить к визуализации, подумайте о своей аудитории.

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

Рассмотрим следующее:

• Мои читатели уже являются экспертами? Проделывали ли они этот процесс раньше, если не точно, то в подобных обстоятельствах?
• Являются ли мои читатели внутренними или внешними? Если мои читатели работают в одной компании, какой язык мы используем, чтобы лучше объяснить процесс?
• С каким настроением они будут приходить на мой контент? Я создаю этот контент для тех, кто спешит что-то сделать, или это для более случайного ученика, который просто надеется продолжить свое образование по теме?
• Что самое важное для моих читателей? Что наименее важно?
• Как мои читатели предпочитают учиться? Знаю ли я, что пост в блоге более успешен, чем видео? Есть ли какие-либо аналитические данные, подтверждающие эти утверждения?
• Являются ли мои читатели носителями английского языка? Если я использую идиому, не помешает ли это им научиться завершать процесс?

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

Опишите процесс с таким количеством деталей, которое необходимо

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

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

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

Типы визуалов и когда их использовать

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

• Неподвижные изображения — это идеальное средство для визуализации физического продукта, будь то человек или конкретный объект, например, сковорода. Это могут быть стоковые фотографии или фотографии, сделанные вами.
• Снимок экрана — неподвижное изображение вашего экрана отлично подходит, когда вы говорите о продуктах, которые видны на вашем компьютере, например, о веб-сайте или другом программном обеспечении. Их очень легко брать и редактировать, особенно благодаря Snagit.
• GIF — анимированные изображения идеально подходят для объяснения коротких процессов (менее 8 секунд), которые не так легко сформулировать.
• Диаграмма — гистограммы, круговые диаграммы, линейные диаграммы, так много типов диаграмм! Диаграмма — лучший выбор, когда речь идет о наборе чисел и их сравнении.
• Видео — идеальное визуальное представление, видео отлично подходит для объяснения процесса. Как сделать отличное техническое видео — это форма искусства, которая, безусловно, может помочь в этом процессе, но требует гораздо большего планирования. (К счастью для вас, я многому научился у TechSmith, и им есть что сказать по этому вопросу).

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

Пример схемы

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

Таблица {

граница коллапса: коллапс;

}

стол, тд, й {

граница: 1px сплошная #404040;

отступ: 4px;

}

Если бы у каждого шага было изображение, это было бы немного… неуместно.

Выберите свои визуальные эффекты

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

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

Тестирование с вашей целевой аудиторией

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

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

Немодерируемое тестирование

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

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

Модерируемое тестирование

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

Задавайте вопросы по ходу. Например:

• Вы поняли, какое задание вам нужно было выполнить? Имеет ли смысл это задание?
• Что облегчило бы этот процесс?
• Если был визуал с шагом, помог ли визуал понять, что делать?
• Хотели бы вы, чтобы было больше визуальных эффектов?

Подведение итогов

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

У вас есть другой способ выяснить, когда добавлять наглядные пособия к инструкциям? Поделитесь своими советами в комментариях ниже!

Примечание редактора: этот пост был первоначально опубликован в ноябре 2017 года и был обновлен для обеспечения точности и полноты.