Как написать понятное сообщение об ошибке

Спойлер: ответить всего на три вопроса
Как и любой другой текст в интерфейсе, сообщение об ошибке должно помочь пользователю решить его проблему. Это непростая задача, особенно для нелингвиста — сообщения часто пишут сами разработчики. Легко свалиться в описание очевидного: «отчет не отправлен», «нет подключения». Или наоборот попытаться вписать все важные мысли в ограниченное пространство окна.
Чтобы написать полезное сообщение, ответьте на вопросы:
1
Что и где случилось?
Расскажите, в чем проблема. Четко и по делу. Описание ошибки не должно быть абстрактным.
2
Почему это произошло?
Укажите источник проблемы.
3
Как все исправить?
Напишите, что делать пользователю в этой ситуации, а в конце добавьте побуждение к действию.
Рассмотрим пример. Разработчик пишет сообщение. Если прочесть его пару раз, можно догадаться, в чем проблема. Но в таком виде оно станет поводом позвонить в техподдержку. Особенно пользователь по давней русской традиции отправляет письмо в последний день:
«Внимание! Согласно Приказу ФНС России N ММВ-7-6/535@ от 9 ноября 2010 г. общий размер отправляемого документа не должен превышать 72 Мб. При отправке будет сформирован документ общим размером 100 Мб.»
Слово «Внимание» должно добавить сообщению важности, но ценной информации оно не несет. Избавляемся.
Со ссылкой на нормативный акт сложнее — очень часто клиенты хотят видеть не только то, что запрет существует, но и откуда он появился. Особенно это актуально для технических ограничений вроде 72 Мб. Добавляем ссылку на приказ ФНС — казенный номер и дату приказа любопытные увидят в Консультанте.
Упрощаем сообщение, переносим описание проблемы вперед, формулируем причину и предлагаем решение:
«Вы прикрепили к письму 100 Мб вложенных файлов, поэтому оно не было отправлено. ФНС принимает письма с вложениями не больше 72 Мб. Уменьшите размер файлов или отправьте их несколькими письмами.»
Что делать если причина ошибки неизвестна? Все равно написать пользователю, что делать.
«Письмо не отправлено. Мы уже разбираемся в проблеме. Повторите отправку через час.»
Made on
Tilda