Как написать инструкцию, которую поймут с первого раза

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

1. Одна задача — одна инструкция

«Как настроить аккаунт» — слишком широко. «Как сменить пароль» и «Как добавить участника команды» — две отдельные инструкции. Читатель ищет одну задачу, находит её, выполняет и уходит.

2. Начните с результата и того, что понадобится

В первых двух строках скажите, чего добьётся читатель и что ему нужно до начала: права доступа, файл, пароль, десять минут времени. Ничто так не раздражает, как обнаружить на шаге 7, что что-то было нужно с самого начала.

3. Нумерованные шаги, по одному действию

Каждый шаг — одно действие, и начинается он с глагола: «Откройте Настройки», «Нажмите Сохранить». Если в шаге есть «а затем», это два шага. Номера помогают читателю не сбиться, а поддержке — сказать «см. шаг 4».

4. Слова читателя, а не ваши

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

5. Покажите, что должно произойти

После важного шага опишите результат: «Появится зелёное сообщение: Сохранено». Читатель понимает, что всё идёт правильно, и сразу замечает, если что-то пошло не так.

6. Предупреждения до шага, а не после

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

7. Проверьте на новичке

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

Картинки и структура

• Скриншоты для шагов на экране, с отмеченной нужной кнопкой; обновляйте их, когда меняется интерфейс.
• Заголовки для длинных процедур, чтобы читатель мог сразу перейти к нужной части.
• Раздел «Что делать, если» в конце для частых проблем: «Если письмо не пришло, проверьте папку со спамом».

Коротко

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