← Все статьи
Василий ЕгоровТексты и контент-редакторы

Шаг инструкции должен заканчиваться проверкой

О коллекции

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

«Выполните настройку» не объясняет, как понять, что настройка завершилась. Шагу нужен наблюдаемый результат. Рассмотрим, как добавить его без лишнего текста.

Содержание 10

Крепеж сборки стеллажа

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

На практике

Принтер и версия интерфейса

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

На практике

Уход за кофемашиной

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

На практике

Проверка шага должна быть наблюдаемой

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

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

На практике

Перед тем как передать материал дальше

  • ☐Крепеж каждого шага соответствует комплекту.
  • ☐Интерфейс совпадает с версией модели.
  • ☐Средства и периодичность по производителю.
  • ☐Для «Периодичность неизвестна» явно показать исход: запросить инструкцию.

Работы из этого разбора

Источники

Обсуждение

Задайте вопрос об этой работе, обсудите решение или поделитесь своим опытом.

Обсуждение открыто для всех участников.

Загружаем комментарии…