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

Что такое бесплатный шаблон пошагового руководства?

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

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

Так делают очень немногие.

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

Формат следует за использованием. Шаблон пошагового руководства в Word подходит для руководств, которые просматривают и выпускают. Версия шаблона пошагового руководства для Google Docs подходит для руководств, которые редактируют несколько человек и которые рассылают по ссылке, а не отправляют файлом. Пошаговое руководство в формате PDF — это то, что вы отправляете по кругу, когда важны верстка и уже согласованный контент.

Читатели останавливаются на полпути

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

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

Потом они возвращаются — иногда намного позже — и первый вопрос звучит не «что делать дальше». Первый вопрос — «где я остановился».

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

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

Как настроить этот шаблон в Trupeer

Шаг 1: Откройте раздел «Templates»

Перейдите в раздел Templates из главной навигации.

Шаг 2: Выберите и откройте шаблон

Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.

Шаг 3: Разверните просмотр шаблона

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

Шаг 4: Отредактируйте шаблон

Нажмите Edit, чтобы начать изменять выбранный шаблон.

В редакторе вы можете:

• Добавлять новые разделы

• Задавать или обновлять правила форматирования

• Добавить логотип и настроить его положение и связанные параметры

Шаг 5: Сохраните настроенный шаблон

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

Шаг 6: Предпросмотр и точная настройка шаблона

Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте Preview.

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

С шаблоном пошагового руководства вы можете:

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

• Улучшать удержание: инструкции в формате видео повышают запоминаемость и точность по сравнению с одним только текстом.

• Масштабировать обучение: охватывайте сотни обучающихся одним видео вместо того, чтобы повторять одно и то же — идеально для обучающих видео и customer success.

• Оставаться в фирменном стиле: применяйте логотип, шрифты, цвета и тон с помощью бренд-набора Trupeer.

• Локализовать по всему миру: переводите руководства на 65+ языков одним кликом.

• Оставаться в актуальном состоянии: редактируйте руководство — и Trupeer автоматически регенерирует видео, когда процессы меняются.

Проектирование для возобновления

Четыре изменения — ни одно не стоит дороже одной строки на шаг.

Описывайте состояние после каждого шага, а не только действие. «Нажмите Save» не говорит возвращающемуся читателю ничего. «Нажмите Save. Теперь запись показывает зеленый бейдж Saved и номер ссылки» позволяет ему посмотреть на свой экран и точно понять, где он остановился. Это самое ценное изменение, и именно для него предназначен столбец состояния в шаблоне ниже.

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

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

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

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

Какой должна быть величина шага?

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

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

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

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

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

Что шаблон пошагового руководства должен содержать

Восемь компонентов. Третий и четвертый — то, что чаще всего упускают в большинстве шаблонов.

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

Бесплатный шаблон пошагового руководства: структура для копирования

Заполнено реальным примером, а не плейсхолдерами. Задача — настроить многофакторную аутентификацию в рабочем аккаунте.

Скопируйте отсюда.

Заголовок. Настройте многофакторную аутентификацию в своем рабочем аккаунте.

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

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

Шаги.

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

Версия и последняя проверка. Версия 3: прошла сквозную проверку 12 июня человеком, который делал это впервые.

Скопируйте отсюда.

Пример пошагового руководства: 63 человека оказались заблокированы

Nantwich Building Society, где работает около девятисот сотрудников, внедрила многофакторную аутентификацию с помощью руководства для самостоятельного обслуживания, отправленного всем по электронной почте.

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

Там описывались действия, а не состояния, и не было ничего о том, где можно остановиться.

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

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

Шестьдесят три человека остановились между шагом одиннадцать и шагом четырнадцать.

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

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

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

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

Задача не стала проще. Руководство просто перестало предполагать, что все прочитают его за один присест.

Как создать пошаговое руководство с картинками

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

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

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

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

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

Примеры пошаговых руководств, которые стоит изучить

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

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

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

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

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

Работают ли генераторы пошаговых руководств?

Категория развивается быстро, и стоит понимать, что именно она делает — и чего не делает.

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

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

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

Пошаговое руководство, how-to или рабочая инструкция?

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

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

How-to guide по сути тот же документ в наборе документации — обычно один из многих — и он организован вокруг того, чего читатель пытается достичь.

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

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

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

Что бесплатный шаблон пошагового руководства не может исправить

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

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

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

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

Показывайте шаги, а не описывайте их

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

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

Запишите. Оформите в бренде. Переведите. Trupeer it.

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

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

Материалы лежат в вашем knowledge base и одновременно служат обучением. Согласованность между документами — это вопрос один раз настроить бренд-набор, а настройка описана в руководстве по настройке шаблона документа.

Часто задаваемые вопросы

Есть ли версия шаблона пошагового руководства для Word?

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

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

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

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

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

Есть ли версия шаблона пошагового руководства для Google Docs?

Google Docs подходит для руководств, которые поддерживают несколько человек, и которые распространяют по ссылке, а не как вложения — так устроено большинство внутренних руководств. Файл шаблона пошагового руководства для Google Docs хорошо работает в этом случае.

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

Есть ли формат PDF для пошагового руководства, который стоит использовать?

PDF подходит для руководства, которое уже готово, широко распространяется или печатается. Экспортируйте пошаговое руководство в PDF, когда контент согласован и важна верстка, а версия и дата видны на странице.

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

Какой генератор пошаговых руководств хороший?

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

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

Где можно найти примеры пошаговых руководств?

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

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

Как создать пошаговое руководство с картинками, не растягивая это на дни?

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

Затем действуйте избирательно. Освоить, как правильно создать пошаговое руководство с картинками, — это в основном научиться использовать меньше изображений: в тех точках, где читателю нужно распознать что-то, а не на каждом шаге.

Чем книга пошагового руководства отличается от руководства?

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

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