Как правильно сообщить пользователю об ошибке

Для сообщения об ошибке есть 5 основных правил:

1️⃣ Расскажите пользователю, что он сделал или что произошло 2️⃣ Объясните проблему 3️⃣ Объясните как исправить ошибку 4️⃣ Используйте активный, а не пассивный залог 5️⃣ Приведите пример

Об этом рассказывает Сьюзан Уэйншенк в своей книге «100 главных принципов дизайна»

🎯 В 1С:Бухгалтерии одной из ключевых операций является Закрытие месяца. В этом месте пользователь чаще всего сталкивается с ошибками. Причем порой они могут и не знать, почему это неправильно. Важно именно в этом месте рассказать не только об ошибке, но и о том что нужно знать и как это исправить.

💡 На скриншоте часть кода формирующего описание и объяснение ошибки, и он чуть ли не больше, чем код выполняющий эту операцию. Полное описание кода можно посмотреть в КонтрольЗатрат.ОписатьРасходыНеУдалосьРаспределить()

❗ Понятно, что такое описание ошибок не везде. Порой возникает малоинформативное «К сожалению, возникла непредвиденная ошибка». С этим, к сожалению, ничего не поделаешь - так сейчас выводит ошибка платформа. И есть вот инструкции от партнеров как быть в этом случае пользователю. Но если есть возможность обработать ошибки, то лучше придерживаться правил.

📖 Еще полезное видео и его расширфровка про то как сообщать пользовать, если что-то пошло не так