Пишите действенные сообщения об ошибках

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

При взаимодействии пользователя с приложением Google Chat сообщения об ошибках могут вызывать разочарование, особенно если ошибка не позволяет предпринять какие-либо действия. Например, сообщение об ошибке « An error occurred бесполезно, поскольку в нем не объясняется, что пошло не так, как пользователь может исправить проблему или как получить помощь. На этой странице описывается, как структурировать сообщения об ошибках таким образом, чтобы они были полезны пользователям, с примерами, содержащими как действия, так и отказ от них.

Структура сообщения об ошибке

Сообщаемое сообщение об ошибке имеет следующую структуру:

  • Что пошло не так? Объяснение причины, по которой приложение чата не может выполнить запрос, помогает пользователю решить проблему. Пояснение причин ошибки укрепляет доверие.
  • Как пользователь может продвинуться к своей цели. Недостаточно просто сказать, что пошло не так. Расскажите пользователям, как они могут преодолеть ошибку и достичь своей цели.
  • Как получить помощь. Если пользователь по-прежнему не может получить помощь, объясните ему, как он может получить более подробную информацию. Это может быть команда /help или ссылка на документацию вашего чат-приложения.

Пример сообщения об ошибке: неверный формат даты

В этом примере пользователь ввел дату в формате, который приложение «Чат» не ожидало. Он написал November 19, 2021 , но приложение «Чат» ожидает формат «19 ноября 2021-11-19 .

Вот вариант сообщения об ошибке, в котором приложение чата выдает сообщение, требующее и не требующее принятия мер:

Ошибка, требующая принятия мер

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

I don't recognize the date format you entered. Write dates as `yyyy-mm-dd`; for example, `2000-01-31`. For help, type `/help`.

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

Данное сообщение об ошибке требует принятия мер по следующим причинам:

  • Указывается, что пошло не так. Приложение «Чат» не распознает формат даты.
  • Объясняет, как исправить ошибку, указывая пользователю ожидаемый формат даты и приводя пример даты, который помогает понять, что нужно написать.
  • Дополнительная помощь предоставляется с помощью команды /help . Если у пользователей по-прежнему возникают трудности, они знают, как получить более подробную информацию.

Ошибка, не требующая принятия мер

Пользователь просит приложение «Чат» назначить встречу с другим человеком. Приложение «Чат» отвечает бесполезным и неэффективным сообщением об ошибке:

Enter the correct date format.

Пример сообщения об ошибке, не содержащего полезной информации.

Данное сообщение об ошибке не позволяет предпринять никаких действий по следующим причинам:

  • Не указано, была ли встреча запланирована. Пользователь может колебаться, стоит ли переносить встречу, или он может предположить, что встреча уже запланирована.
  • В этом сообщении не указано, как форматировать дату. Вместо того чтобы предполагать, что пользователи знают, как форматировать дату, следует указать, что ожидается формат даты yyyy-mm-dd .
  • Не предлагает дополнительной помощи. Когда пользователи застревают и не знают, как действовать дальше, они могут перестать отправлять сообщения в чате.

Попробуйте!

Теперь, когда вы знаете, как описывать ошибки, требующие принятия мер, можете ли вы в следующем сценарии определить, какая из этих ошибок требует принятия мер:

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

Какое сообщение об ошибке требует принятия мер?
Прежде чем я смогу назначить встречу, вам необходимо войти в систему, набрав /signin . Для получения дополнительной информации наберите /help .
Это сообщение об ошибке требует принятия мер, поскольку в нем говорится следующее:
  • Что пошло не так? Приложение «Чат» требует аутентификации.
  • Как действовать дальше. Введите /signin для аутентификации.
  • Как получить помощь. Если пользователю нужна дополнительная информация, он может ввести /help .
Необходимо пройти аутентификацию.
Это сообщение об ошибке не позволяет предпринять никаких действий, поскольку в нем не указано, как выполнить аутентификацию.
Войти.
Это сообщение об ошибке не позволяет предпринять никаких действий, поскольку в нем не указано, как войти в систему, и вместо того, чтобы четко об этом сообщить, подразумевается, что пользователь вышел из системы, что сбивает с толку.
Не могу назначить встречу.
Это сообщение об ошибке не позволяет предпринять никаких действий, поскольку оно не объясняет пользователю, почему встречу не удается запланировать или как ему следует поступить. Помощь не предоставляется.