Использовать этот шаблон
How-to статьи — один из самых востребованных форматов контента в интернете. С Trupeer вы можете сэкономить часы на написании how-to контента, начав с бесплатного шаблона статьи how-to, настроив его с помощью ваших бренд-гайдлайнов и превратив каждую статью в увлекательный видеоурок, который дает читателям второй способ научиться.
У статьи how-to есть читатель в очень конкретном состоянии. Он уже находится на середине процесса, что-то не работает, и он уже потратил больше времени, чем хотел. Он не читает — он сканирует в поисках фрагмента, который снимет блокировку.
Почти все правила написания таких материалов следуют из этого.
Скачать шаблон статьи how-to
Формат | Лучше всего для |
|---|---|
Word (.docx) | Подготовка и проверка до публикации в вашем help centre |
Печатные руководства, onboarding-пакеты, офлайн-справка | |
PowerPoint (.pptx) | Превращение how-to в обучающую презентацию или слайды с пошаговым разбором |
Google Docs | Подготовка вместе с человеком, который действительно выполняет задачу |
Excel (.xlsx) | Инвентаризация статей: заголовок, владелец, последняя проверка, источник |
Бесплатно, редактируемо, без водяного знака.
Три способа, как статья how-to может не сработать
Каждая неудача — из этих, и для каждой нужны разные исправления.
«Ворота» | Вопрос читателя | Что это исправляет |
|---|---|---|
Найти | Существует ли статья по этой теме? | Заголовок и то, где он индексируется |
Подтвердить | Это правильная статья для моей ситуации? | Вступительный блок и предварительные требования |
Дойти до конца | Я реально смогу добраться до финала? | Качество шагов, скриншоты, устранение неполадок |
Большинство советов по написанию затрагивают третьи «ворота». Большинство статей не проходят первые две.
«Ворота» первые: заголовок
Если заголовок не совпадает со словами, которые использовал бы читатель, то для него статьи как будто не существует.
Пишите задачу, а не функцию. «Как экспортировать отчет в CSV» лучше, чем «Использование модуля экспорта». Люди ищут то, что пытаются сделать.
Используйте их лексику. Внутреннее название функции — не то, как ее называют клиенты. Возьмите формулировки из тикетов поддержки и поиска по сайту.
Начинайте с глагола. «Как сбросить пароль» читается быстрее, чем «Сброс пароля: руководство».
Будьте достаточно конкретными, чтобы исключить двусмысленность. «Как добавить пользователя» неоднозначно, если у вас есть три типа пользователей. «Как добавить пользователя-администратора в рабочую область» — нет.
Одна задача на один заголовок. Если в заголовке есть «и», у вас две статьи.
«Ворота» вторые: вступление
Читатель уже пришел. У него есть примерно пять секунд, чтобы решить, это ли нужная страница.
Вступительный блок отвечает на три вопроса до того, как начнутся шаги.
Что делает эта статья. Одно предложение. «Эта статья покажет, как подключить вашу бухгалтерскую систему, чтобы счета синхронизировались автоматически».
Для кого она. Любая роль, требование к правам или плану. «Чтобы сделать это, вам нужен доступ администратора».
Что нужно сначала. Предварительные требования — до первого шага, а не то, что выясняется на четвертом.
Последнее предотвращает самую частую фрустрацию в технической документации: когда вы успеваете сделать три шага, а потом выясняется, что вам нужно что-то, чего у вас нет. Предварительные требования должны быть вверху — всегда.
Добавьте ожидаемое время, если оно больше пары минут. «Это займет около 15 минут» позволяет человеку решить, начать сейчас или вернуться позже.
«Ворота» третьи: шаги
Тут читатель либо заканчивает, либо сдается.
Один шаг — одно действие. Если шаг содержит «а затем», разделите его.
Начинайте каждый шаг с глагола. «Нажмите «Настройки»», а не «Сначала нажмите «Настройки»».
Сначала укажите где, потом что. «В правом верхнем углу нажмите «Экспорт»» подсказывает, куда смотреть в первую очередь.
Назовите то, что они увидят. Точные подписи кнопок, в точной капитализации. Если кнопка говорит «Сохранить и закрыть», пишите так.
Пронумеруйте. Маркеры подразумевают, что порядок не важен.
По возможности — до десяти шагов. Длинные задачи разбивайте на этапы с подзаголовками.
Покажите результат. После последнего шага скажите, что теперь должно быть верно. «Синхронизация выполняется каждый час. Вы увидите время последней синхронизации на странице интеграций».
Не объясняйте «почему» в середине задачи. Читатель выполняет действия, а не учится. Логику добавьте в заметку или в отдельную концептуальную статью.
Как настроить этот шаблон в Trupeer
Шаг 1: Откройте раздел Templates
Перейдите в раздел Templates из главного меню навигации.
Шаг 2: Выберите и откройте шаблон
Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.
Шаг 3: Разверните просмотр шаблона
При необходимости разверните просмотр шаблона, чтобы четко увидеть полную раскладку и детали.
Шаг 4: Отредактируйте шаблон
Нажмите Edit, чтобы начать изменять выбранный шаблон.
В редакторе вы можете:
Добавлять новые разделы
Задавать или обновлять правила форматирования
Добавить логотип и настроить его положение и связанные параметры
Шаг 5: Сохраните ваш настроенный шаблон
После внесения всех необходимых изменений нажмите Save, чтобы сохранить обновленный шаблон как ваш собственный.
Шаг 6: Предпросмотр и точная настройка шаблона
Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте Preview.
На экране предпросмотра при необходимости вы можете продолжить вносить изменения напрямую, чтобы шаблон отображался ровно так, как вам нужно.
С шаблоном статьи how-to вы можете:
Экономить часы на написании: пропускайте пустую страницу со структурой, созданной для how-to контента.
Занимать позиции в поиске: хорошо структурированные how-to с разметкой HowTo хорошо ранжируются в Google.
Оставаться в фирменном стиле: применяйте логотип, шрифты и цвета с помощью бренд-набора Trupeer.
Снижать нагрузку на поддержку: понятные статьи how-to помогают пользователям решать вопросы самостоятельно.
Добавлять видеоуроки: встраивайте видеоинструкции для шагов, которые сложно объяснить текстом.
Достигать глобальной аудитории: переводите статьи how-to на 65+ языков одним кликом.
Шаблон статьи how-to
Раздел | Содержание |
|---|---|
Заголовок | Задача в основе, сначала глагол, одна задача |
Краткое описание | Одно предложение о том, что это дает |
Для кого это | Роль, права, план |
Прежде чем начать | Предварительные требования, доступ, нужная информация |
Требуемое время | Там, где это больше пары минут |
Шаги | Нумерованные, одно действие на каждый, со скриншотами |
Результат | Что должно быть верно после этого |
Устранение неполадок | Три или четыре вещи, которые чаще всего идут не так |
Похожие статьи | Следующая вероятная задача и концептуальная статья, если она есть |
Метаданные | Владелец, последняя проверка, версия продукта |
Десять разделов, из которых четыре короткие. Основная часть — это шаги и устранение неполадок.
Скриншоты
Разница между удобной статьей how-to и стеной инструкций.
Один скриншот на шаг, когда интерфейс неочевиден. Не на каждом шаге, иначе статья перестает читаться «по диагонали».
Обрезайте до нужной области. Полноэкранная запись заставляет читателя искать то, что вы имели в виду.
Добавляйте пометки аккуратно. Один блок или стрелка. Несколько пометок конкурируют друг с другом.
Показывайте состояние, а не только расположение. Если на шаге что-то меняется, «до и после» ценнее одного изображения.
Избегайте персональных данных или данных клиентов. Используйте демо-аккаунт и проверьте вкладки браузера и уведомления в углу вашего скриншота.
Учитывайте стоимость поддержки. Скриншоты устаревают при каждом изменении интерфейса, а устаревшие скриншоты подрывают доверие ко всей статье. Это самый сильный аргумент в пользу записи, а не захвата.
Устранение неполадок
Раздел, который отделяет компетентную статью от действительно полезной, и тот, который чаще всего пропускают.
Перечислите три или четыре вещи, которые реально идут не так, словами читателя, и укажите исправление.
После шага 4 ничего не появляется. Обычно это значит, что соединение еще не завершило авторизацию. Подождите минуту и обновите страницу. Если все равно пусто, возможно, у аккаунта нет нужных прав.
Кнопка неактивна (серого цвета). Для этого нужен доступ администратора. Попросите того, кто настраивал вашу рабочую область.
Работало, но данные выглядят неправильно. Проверьте фильтр диапазона дат — по умолчанию он установлен на текущий месяц.
Источник берите в тикетах поддержки, а не в воображении. Если четверо связались с вами с одной и той же проблемой после того, как следовали статье, значит эта проблема должна быть в статье.
Слабое и лучше
Слабое: Пользователи могут настроить параметры экспорта через модуль отчетности, чтобы получать данные в различных форматах по мере необходимости.
Лучше: Чтобы экспортировать отчет в CSV: 1. Откройте отчет. 2. В правом верхнем углу нажмите Export. 3. Выберите CSV и нажмите Download. Файл появится в папке загрузок и будет включать все столбцы, которые сейчас видны в отчете.
Слабое: Шаг 3: соответствующим образом настройте параметры интеграции и сохраните изменения.
Лучше: 3. Введите API-ключ из вашей бухгалтерской системы. 4. Установите частоту синхронизации на «Ежечасно». 5. Нажмите Save & test. Вы должны увидеть зеленую метку Connected.
Первая версия — это один шаг, который делает три вещи, и нет способа понять, сработало ли. Вторая — три шага с проверяемым результатом.
Слабый заголовок: Руководство по настройке интеграции
Лучший заголовок: Как подключить вашу бухгалтерскую систему
Слабое вступление: Эта статья дает обзор функциональности экспорта, доступной в платформе.
Лучшее вступление: Здесь показано, как экспортировать отчет в CSV, Excel или PDF. Вам нужен доступ для просмотра отчета. Займет около минуты.
Типы статей документации
How-to — один из четырех типов, и смешивание их — самая распространенная структурная ошибка в документации.
Тип | Ответы | Состояние читателя | Формат |
|---|---|---|---|
How-to | Как мне выполнить эту конкретную задачу? | Застрял, в процессе, нетерпелив | Нумерованные шаги |
Концепция | Что это и почему работает именно так? | Обучение, есть время | Проза с примерами |
Справка | Какие точные значения и варианты? | Нужно найти одну вещь | Таблицы и списки |
Урок | Научи меня с нуля | Новичок, готов следовать | Пошаговая последовательность с разобранным примером |
Ошибка — объяснять концепции внутри how-to. Читатель выполняет действия и не хочет фоновой информации. Вместо этого дайте ссылку на концептуальную статью и держите шаги чистыми.
Обратная ошибка — концептуальная статья, где три шага спрятаны в середине, и никто не найдет их, когда они понадобятся.
Длина статьи
Короче, чем подсказывает интуиция. How-to статья должна охватывать одну задачу и останавливаться.
Если она выходит за пределы десяти шагов, ищите естественное разделение. «Как настроить X» часто на самом деле «Как создать X», «Как настроить X» и «Как пригласить людей в X» — это три статьи, которые можно найти независимо и связать в последовательность.
Длинные статьи также не проходят первые «ворота», потому что одна статья, охватывающая шесть задач, может иметь только один заголовок, а значит пять задач внутри нее не найти.
Форматы
Word — для подготовки и проверки, потому что отслеживаемые изменения и комментарии делают цикл ревью управляемым. Именно здесь большинство статей должно быть написано до того, как они хоть как-то приблизятся к системе публикации.
PDF — для всего, что печатается, раздается на обучении или нужно офлайн. Также это правильный формат для руководства, которое вы прикрепляете к письму для клиента.
PowerPoint, когда how-to превращается в обучение. Один шаг на слайд, скриншот на каждом — хорошо подходит для сессии с демонстрацией.
Ваш help centre или база знаний — для всего, что нужно клиентам и должно быть доступно для поиска и просмотра, а это большинство случаев. Word и PDF — форматы для подготовки и распространения, а не для публикации.
Поддержка статей
Документация незаметно устаревает, а устаревшая документация хуже, чем отсутствие, потому что люди следуют ей и она не работает.
Назначьте владельца для каждой статьи. Укажите версию продукта, под которую она была написана. Проверяйте после каждого релиза, который влияет на функцию, а в остальных случаях — по фиксированному циклу.
Самый надежный сигнал поддержки — тикет о чем-то, что покрывает статья. Это означает либо что статья неверна, либо что она верна, но ее невозможно найти. И то и другое стоит исправить, и оба варианта невидимы, пока кто-то не следит за этим.
Скриншоты — элемент с самой высокой стоимостью поддержки, и это стоит учитывать при том, сколько их вы используете и как вы их создаете.
Как измерить, работает ли это
Просмотры, которые показывают, можно ли найти материал.
Тикеты поддержки по той же теме после публикации. Должны снижаться. Если нет — статья не работает или ее невозможно найти.
Поисковые запросы без результатов, которые показывают, каких статей не хватает.
Время на странице, интерпретируйте аккуратно. Долго может означать «внимательно и подробно» или «непонятно и запутанно».
Обратная связь по статье, если в вашем help centre она предусмотрена, хотя обычно отклика мало.
Дефлекция, то есть люди посмотрели статью и затем не обратились в поддержку.
Самое полезное число — объем обращений по теме до и после публикации. Все остальное — прокси.
Как написать статью how-to
Узнайте, что люди реально спрашивают, из тикетов поддержки и поиска по сайту. Не угадывайте тему.
Сначала напишите заголовок, как задачу в словах читателя. Если вы не можете — значит, область неясна.
Выполните задачу сами во время написания или посмотрите, как ее выполняет кто-то другой. Статьи, написанные по памяти, пропускают шаги.
Список предварительных требований фиксируйте по мере того, как они встречаются.
Пишите по одному действию на шаг, сначала глагол, с точными подписями интерфейса.
Фиксируйте или записывайте по ходу, а не потом по памяти.
Укажите ожидаемый результат.
Добавьте устранение неполадок из реальных тикетов.
Пусть кто-то, кто не знаком с темой, пройдет ее без помощи. Любой вопрос, который они задают, — это дефект.
Опубликуйте, а затем посмотрите объем обращений по этой теме.
Девятый шаг — единственная настоящая проверка. Статья, которую проверил человек, уже знающий задачу, всегда будет читаться «нормально».
Лучшие практики
Заголовки на языке читателя, основанные на задаче.
Предварительные требования перед первым шагом — всегда.
Один шаг — одно действие, сначала глагол.
Точные подписи интерфейса, точная капитализация.
Скриншоты обрезаны и слегка подписаны.
Ожидаемый результат указан после последнего шага.
Устранение неполадок взято из реальных тикетов.
Одна задача на статью, до десяти шагов.
Концепции связаны ссылками, а не встроены.
Проверено человеком, который не выполнял задачу.
Частые ошибки
Заголовки названы по функциям, а не по задачам.
Предварительные требования обнаруживаются на четвертом шаге.
Шаги содержат по три действия каждый.
Неясные инструкции вроде «настройте параметры соответствующим образом».
Подписи интерфейса перефразированы, а не процитированы.
Полноэкранные скриншоты без обрезки.
В скриншоте видны данные клиентов.
Нет ожидаемого результата, поэтому читатель не может понять, сработало ли.
Нет раздела с устранением неполадок.
Концепции объясняются внутри шагов.
Шесть задач в одной статье, пять из них не найти.
Написано по памяти, а не после выполнения задачи.
Проверено только теми, кто уже знает, как это делать.
Скриншоты никогда не обновляются после изменения интерфейса.
Записывайте задачу вместо того, чтобы писать по памяти
Откройте шаблон в Trupeer AI, примените ваш бренд-набор, чтобы статьи соответствовали вашей документации, и отредактируйте любой раздел напрямую. Настройка находится в руководстве по настройке шаблона.
Две вещи делают статьи how-to дорогими. Написание по памяти пропускает шаги, которые вы выполняете автоматически — именно там читатели чаще всего застревают. А скриншоты долго готовить, и они устаревают при каждом изменении интерфейса, поэтому так много статей показывают версию продукта, которой уже нет.
Запись решает обе проблемы. Выполните задачу один раз — и Trupeer AI создаст письменную статью с шагами в том порядке, в котором они реально происходили, и со скриншотами, которые будут захвачены автоматически, плюс озвученный видеоразбор из того же прохода. Когда интерфейс меняется, записывайте заново, а не делайте новые скриншоты.
Переведите на 65+ языков и храните набор в вашем хранилище знаний, где читатели смогут его найти.
Запишите. Оформите в бренде. Переведите. Trupeer it.
Часто задаваемые вопросы
Есть ли бесплатный шаблон статьи how-to в Word?
Да. Word — основной формат и правильное место для черновика, потому что проверка с отслеживаемыми изменениями там проще, чем в системе публикации. Он включает полную структуру с подсказками в каждом разделе. Бесплатная загрузка, без регистрации, без водяного знака.
Есть ли шаблон статьи в Word, который можно бесплатно скачать?
Да, и он подходит для любых инструктивных статей, не только пошаговых. Структура сохраняется для концептуальных, справочных и статей по устранению неполадок с небольшими корректировками.
Есть ли бесплатный шаблон статьи how-to в PDF?
Да, в формате печатного руководства, подходящего для раздаточных материалов на обучении, onboarding-пакетов и всего, что нужно клиенту офлайн.
Есть ли шаблон статьи в PDF?
Да: есть и пустая версия, и готовый пример, чтобы вы могли увидеть завершенную статью how-to до того, как напишете свою.
Есть ли бесплатный шаблон статьи how-to в PPT или PowerPoint?
Да. Версия PowerPoint превращает how-to в обучающий walkthrough: один шаг на слайд, и на каждом есть место для скриншота. Отлично подходит для живой сессии и хуже — как справочный материал после нее, поэтому большинству команд нужна еще и версия Word.
Могу ли я скачать бесплатный шаблон статьи how-to?
Да, каждый формат можно бесплатно скачать без необходимости аккаунта и без указания авторства.
Какой лучший бесплатный шаблон статьи how-to?
Тот, который включает предварительные требования и устранение неполадок. Большинство шаблонов дают вам заголовок и нумерованные шаги — это простая часть. Читатели сдаются, потому что на четвертом шаге обнаруживают отсутствующее предварительное требование или сталкиваются с проблемой, о которой статья не упоминает, а именно эти два раздела и предотвращают это.
Что такое статья how-to?
Это короткая инструктивная статья, которая охватывает одну конкретную задачу и написана для человека, который пытается сделать это прямо сейчас. Она отличается от урока (tutorial), который учит с нуля, и от концептуальной статьи, которая объясняет, как что-то работает.
Что должна включать статья how-to?
Заголовок на основе задачи, краткое описание в одно предложение, для кого она (с учетом любых нужных прав), предварительные требования до первого шага, требуемое время, нумерованные шаги с одним действием на каждый, ожидаемый результат, устранение неполадок для трех или четырех типичных проблем, связанные статьи и метаданные с указанием владельца и даты последней проверки.
Как написать хорошую статью how-to?
Напишите заголовок как задачу в словах читателя, выполняйте задачу сами во время написания, а не полагайтесь на память, перечисляйте предварительные требования по мере того, как они встречаются, используйте по одному действию на шаг с точными подписями интерфейса, укажите, что должно быть верно в конце, и добавьте устранение неполадок из реальных тикетов поддержки. Затем пусть кто-то, кто не знаком с темой, пройдет ее без помощи.
Какой должна быть длина статьи how-to?
Одна задача — идеально до десяти шагов. Если выходит дольше, обычно это несколько задач, которые можно было бы найти лучше как отдельные статьи, связанные в последовательность. Длинные статьи также не работают, потому что у них может быть только один заголовок, из-за чего остальные задачи внутри становятся невидимыми для поиска.
В чем разница между how-to и tutorial?
How-to помогает тому, кто уже знает, что хочет, и нуждается в конкретных шагах. Tutorial обучает новичка — обычно с разобранным примером и большим количеством объяснений. Разница в состоянии читателя: читатель how-to нетерпелив и находится в процессе, а читатель tutorial выделил время, чтобы учиться.
Нужно ли включать скриншоты в статьи how-to?
Да, для всего, где интерфейс неочевиден: обрезайте до нужной области и добавляйте легкие пометки. Не на каждом шаге — иначе статья перестает читаться «по диагонали». Помните, что скриншоты — самый затратный элемент документации и они устаревают при каждом изменении интерфейса; это стоит взвесить, прежде чем добавлять двенадцать из них.
Как часто нужно пересматривать статьи how-to?
После каждого релиза, который влияет на функцию, а в остальных случаях — по фиксированному циклу, обычно каждые шесть–двенадцать месяцев. Самый полезный триггер — тикет поддержки по тому, что статья уже покрывает: это значит, что она либо неверна, либо ее невозможно найти.
Могу ли я настроить этот шаблон статьи how-to?
Да, каждая версия полностью редактируемая. Приведите разделы в соответствие вашим стандартам документации, но предварительные требования и устранение неполадок — это два пункта, которые стоит сохранять в любом случае, потому что они закрывают те два места, где читатели чаще всего бросают статью.
