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

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

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

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

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

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

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

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

Вот действенная и бездействующая версии сообщения об ошибке, которым отвечает приложение 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`.

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

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

Недействительная ошибка

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

Enter the correct date format.

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

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

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

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

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

Какое сообщение об ошибке является действенным?

Прежде чем я смогу запланировать встречу, вы должны войти в систему, набрав /signin . Чтобы узнать больше, введите /help .

Это сообщение об ошибке является действенным, поскольку в нем говорится следующее:

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

Вы должны пройти аутентификацию.

Это сообщение об ошибке недействительно, поскольку в нем не указано, как пройти аутентификацию.

Войти.

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

Не могу запланировать встречу.

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