TOPZNANIE

Цифровая практика без сложностей

Выберите город
MET Norway · CC BY 4.0
← На главную

· Инструкции

Как оформить в инструкции место, где нужно ввести данные, и что делать с чужими примерами

Образец в инструкции должен быть визуально отличим от значения, которое нужно ввести: пометьте его словом «например», поставьте в скобки или вынесите отдельной строкой под полем. Рядом опишите формат и обязательность поля. Тогда исполнитель поймёт, что «+7 912 345-67-89» — это ориентир, а не номер, который надо вписать буквально.

Почему пример без пометки принимают за готовое значение

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

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

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

Как пометить образец, чтобы его не спутали с реальными данными

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

Если пример длинный, вынесите его отдельной строкой под полем и начните со слова «Например:». Скобки подходят для коротких значений внутри строки: «Введите город (например, Казань)». Курсив или цвет допустимы, но только как дополнение к словесной пометке: цвет не виден при копировании текста и в распечатке.

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

Как описать формат данных: что именно вводить и в каком виде

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

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

Для полей с ограничением длины или строгим форматом дайте допустимый и недопустимый вариант рядом. Это снимает догадки лучше, чем общее указание «заполните корректно».

Поле «Телефон». Плохо: рядом стоит «+7 900 000-00-00» без пометки — человек может ввести этот номер. Хорошо: подпись «Введите свой номер в формате +7 XXX XXX-XX-XX, например +7 912 345-67-89». Здесь формат задан, образец помечен словом «например», а обязательность поля указана отдельно.

Как проверить инструкцию на живом человеке

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

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

  • У каждого образца есть словесная пометка рядом с ним.
  • Формат ввода описан: допустимые символы и разделители.
  • Обязательные и необязательные поля помечены по-разному.
  • Значение по умолчанию подписано отдельно от примера.
  • Проверяющий человек вписал свои данные, а не текст образца.

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