Блог

Как писать заголовки шагов и описания, которые читают

Опубликовано 25 октября 2026 г. · инструкции, текст, документация, советы

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

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

Черновик уже готов

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

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

Превратите заголовок в указание

Три привычки:

• Начинайте с глагола. «Нажмите кнопку „Сохранить изменения“», а не «Кнопка сохранения изменений». «Откройте», «Выберите», «Введите», «Подтвердите» понятны; «это», «здесь» и «данный» — нет.
• Оставляйте одно действие. Если в заголовке нужно «и», шаг, вероятно, стоит разделить. Записанные шаги и так небольшие; отредактированные должны остаться такими же.
• Называйте то, что видит читатель. Берите подпись из интерфейса, а не внутреннее название. Если на кнопке написано «Опубликовать», пишите «Опубликовать», даже если в команде её называют «выкатить».

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

Добавляйте причину, а не очевидное

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

Хорошие описания отвечают на один из трёх вопросов:

• Зачем существует этот шаг? («Так изменение не затронет живой каталог».)
• Что меняется после него? («Статус переходит в „Ожидает“ до следующей синхронизации».)
• Что пойдёт не так, если его пропустить? («Изменение сохранится, но так и не опубликуется».)

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

Используйте врезки для предупреждений

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

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

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

Разбивайте длинные шаги на подшаги

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

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

Скрывайте то, что не помогает

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

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

Чек-лист перед экспортом

Частые вопросы

Можно ли редактировать автоматические заголовки шагов?

Да. Щёлкните поле заголовка под холстом и перепишите его. Поле описания под ним принимает форматированный текст, списки и ссылки, а изменения сохраняются вместе с инструкцией.

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

Подшаг — часть нумерованной последовательности (N.1, N.2), и у него обычно есть свой скриншот. Врезка — ненумерованный блок «Совет», «Предупреждение» или «Примечание», который добавляет контекст, не становясь шагом.

Появляются ли скрытые шаги в экспорте?

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

Ещё из блога