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

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

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

Скачать шаблон пошагового руководства

Бесплатно, редактируемо, без водяного знака. Сначала стоит использовать Excel: он особенно полезен, потому что именно этап определения объема определяет, будет ли руководство работать.

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

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

Перейдите в раздел «Templates» из главного меню.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• Экономить часы на написании: пропускайте пустую страницу — структура уже создана под контент пошагового руководства.

• Улучшить SEO: хорошо структурированные пошаговые руководства лучше ранжируются в результатах поиска.

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

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

• Добавлять видеоразборы: встраивайте видео для шагов, которые сложно объяснить текстом.

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

Руководство или статья?

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

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

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

Определите начальное и конечное состояние

Прежде чем писать что-либо, точно ответьте на два вопроса.

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

Чем он заканчивает? Не «он понимает систему», а что-то наблюдаемое. «Он может оформить возврат от начала до конца, включая исключения» — это конечное состояние. «Он знаком с модулем возвратов» — нет.

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

Определение объема руководства

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

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

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

Последовательность

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

• Сначала — предпосылки и доступ. Никто не сможет следовать инструкциям, пока не сможет войти в систему.

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

• Затем — распространенные варианты, опираясь на то, что они уже знают.

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

• Справочные материалы — в конце, а не разбросаны по всему документу.

Инстинкт объяснить все до того, как кто-то начнет что-либо делать, — самая частая ошибка в последовательности. Читатели лучше запоминают, когда сначала уже что-то сделали.

Структура руководства

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

Анатомия раздела

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

Название раздела. Задача так, как ее описал бы читатель.

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

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

Что вы должны увидеть. Ожидаемый результат.

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

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

Пример подробного плана

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

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

Как писать шаги

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

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

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

Скриншоты и визуальные материалы

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

• Обрезайте плотно и делайте пометки аккуратно, один блок или стрелка.

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

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

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

Где руководству следует остановиться

Три естественные границы.

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

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

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

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

Руководство, мануал, SOP или рабочая инструкция

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

Для остальных: шаблон учебного мануала, шаблон SOP, шаблоны рабочих инструкций.

Форматы

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

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

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

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

Excel — для инвентаризации задач перед написанием.

Проверка руководства

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

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

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

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

Поддержание в актуальном состоянии

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

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

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

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

Лучшие практики

• Определяйте начальное и конечное состояния до написания.

• Определяйте объем через инвентаризацию задач, фиксируя, почему каждая задача включена или исключена.

• Сначала — самая простая завершенная задача, исключения — в конце.

• Варианты охватывают только то, что отличается от основного пути.

• Страница с оглавлением — всегда.

• Единая структура между разделами.

• Справочные материалы — в конце, а не разбросаны.

• Останавливайтесь на границах роли, частоты и справки.

• Тестируйте с человеком, который действительно соответствует начальному состоянию.

• Один владелец, один цикл проверки, версия зафиксирована.

Частые ошибки

• Нет определенного конечного состояния — поэтому у руководства нет естественной точки остановки.

• Включено все — получается документ, который никто не читает.

• Вся теория до того, как кто-то начнет делать.

• Каждый вариант расписан полностью — длина увеличивается втрое.

• Нет страницы с оглавлением — поэтому документ нельзя использовать как справку после прочтения.

• Таблицы справки разбросаны по разделам.

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

• Тестирование только людьми, которые уже знают задачу.

• Скриншоты везде, а затем их никогда не обновляют.

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

• Нет назначенного владельца — поэтому документ тихо устаревает.

Зафиксируйте работу один раз и получите руководство из нее

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

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

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

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

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

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

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

Да. Word — основной формат: оглавление, структура разделов и разметка шагов уже настроены. Бесплатная загрузка, без регистрации, без водяного знака.

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

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

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

Да, в Word, PDF, PowerPoint и Excel. Если вам нужна только одна задача, а не полноценное руководство, шаблон статьи с пошаговыми инструкциями — более короткий вариант.

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

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

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

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

Есть ли бесплатный шаблон пошагового руководства в PPT или PowerPoint?

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

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

Да, хотя Excel хранит инвентаризацию задач, а не само руководство. Вы перечисляете все задачи в области, отмечаете каждую как включить, связать или исключить и фиксируете причину. Определение объема — это часть, которая определяет, будет ли руководство работать, и если сделать это в таблице до написания, вы сэкономите время на переделки позже.

Могу ли я скачать бесплатный шаблон пошагового руководства?

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

Что такое пошаговое руководство?

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

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

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

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

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

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

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

В чем разница между руководством и мануалом?

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

В чем разница между пошаговым руководством и SOP?

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

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

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

Как часто нужно обновлять пошаговое руководство?

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

Могу ли я настроить этот шаблон пошагового руководства?

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

Похожие шаблоны

• Шаблон статьи с пошаговыми инструкциями

• Шаблон учебного мануала

• Шаблон SOP

• Шаблоны рабочих инструкций

• Шаблон подсказки для работы

• Шаблон технической документации

• Шаблон базы знаний

• Шаблон документации процесса

• Шаблон руководства для онбординга новых сотрудников