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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Неисправимая ошибка

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

Enter the correct date format.

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

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

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

Попробуйте это

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

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

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