Как оформлять инструкции, которые можно повторить
Повторяемая инструкция: исходные условия, одно действие на шаг, ожидаемый результат и проверка ошибки. Как проверить гайд на новом пользователе.
Повторяемая инструкция описывает начальное состояние, последовательность действий и признаки успешного результата. Нумерация нужна там, где порядок важен. Скриншоты дополняют шаги, но не заменяют названия элементов и объяснение того, что должно измениться после действия.
- Формат
- Практический гайд
- Тема
- SEO и GEO
Укажите, что понадобится до старта
Перечислите нужные доступы, файлы, версию инструмента и ограничения. Если читателю требуется право администратора, сообщите это до первого шага. Для потенциально необратимого действия объясните, какую копию сохранить и как вернуться к исходному состоянию.
Свяжите действие с проверкой
Пишите «откройте настройки домена и найдите запись A», а не «настройте домен правильно». Рядом укажите, что читатель должен увидеть после сохранения. Два независимых действия лучше разделить; длинная цепочка в одном пункте усложняет поиск места ошибки.
Пройдите путь без своих привычных доступов
Попросите человека, который не писал текст, выполнить инструкцию с чистого начала. Запишите, где он остановился, какие слова не понял и какие предварительные настройки оказались скрыты. Исправьте эти места и добавьте короткий сценарий восстановления после наиболее вероятной ошибки.
Самая полезная проверка инструкции — прохождение другим человеком, который не знает ваш привычный порядок действий.
Вопросы и ответы
Сколько шагов должно быть в инструкции?
Столько, сколько нужно для безопасного повторения. Не объединяйте действия только ради красивого числа в заголовке.
Как часто обновлять скриншоты?
Когда меняются интерфейс или последовательность действий. Незначительное отличие оформления не всегда требует замены всего материала.
