Текст сообщения об ошибках - наилучшая практика

Question

Мы меняем текст на наши старые, плохо написанные сообщения об ошибках. Каковы некоторые ресурсы для наилучшей практики написания хороших сообщений об ошибках (в частности, для Windows XP/Vista).

Answer 1

С точки зрения формулировки ваши сообщения об ошибках, я рекомендую со ссылкой на следующие руководств по стилю для приложений Windows:

• Windows user experience guidelines, а именно в разделе о сообщениях об ошибках here.
• Microsoft Manual of Style

Answer 2

Всегда включайте предложения по устранению ошибки.

Answer 3

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

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

Answer 4

Попытайтесь выяснить способ написания программного обеспечения, чтобы он исправил проблему для них.

Answer 5

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

Answer 6

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

Answer 7

Для любого ввода пользователем (строки, имена файлов, значения и т. Д.) Всегда отображают ошибочное значение с разделителями вокруг него (кавычки, скобки и т. Д.). например

Имя файла вы ввели не может быть найден: «somefile.txt»

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

Answer 8

сообщение хорошая ошибка А должно:

• Будьте ненавязчивы (не синий экран или желтый экран смерти)
• Дайте направление пользователя, чтобы исправить эту проблему (сами по себе, если это возможно, или кто обратиться за помощью)
• Скрыть бесполезный, эзотерический программист ерунда (не говорите, «исключение нулевой ссылки произошло в строке 45»)
• Будьте описательным, не являясь подробным. Достаточно информации, чтобы сообщить пользователю, что им нужно знать, и ничего более.

Одна вещь, которую я начал делать, - это создать уникальный номер, отображаемый в сообщении об ошибке, и записать в файл журнала, чтобы я мог найти ошибку в журнале, когда пользователь отправил мне скриншот или звонит и говорит: «Я получил сообщение об ошибке». Он говорит, что мой ссылочный номер 0988-7634 «

Answer 9

1. Избегайте появления одинаковых сообщений об ошибках из разных мест; parametrize с файлом: если это возможно, или использовать другой контекст, который позволяет разработчику однозначно идентифицировать, где произошла ошибка.
2. Создайте механизм, обеспечивающий легкую локализацию, особенно если это коммерческий продукт.
3. Если сообщения об ошибках являются видимыми для пользователя, сделайте их полными, содержательными предложениями, которые не предполагают глубокого знания кода; помните, что вы всегда слишком близки к проблеме - пользователь - нет.Если возможно, дайте руководство пользователя о том, как действовать, кто должен связаться и т. Д.
4. Каждая ошибка должна содержать сообщение, если это возможно; если нет, попробуйте и убедитесь, что все пути устранения ошибок в конечном итоге доходят до сообщения об ошибке, которое проливает свет на то, что произошло.
   
   Я уверен, что будут и другие хорошие ответы здесь ...

Answer 10

Более короткие сообщения могут фактически быть прочитан.

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

Лучшее сообщение об исключении - это тот, который вам никогда не нужно отображать.

Answer 11

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

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

Я также являюсь большим поклонником централизованного регистрации ошибок. Убедитесь, что журнал проверен человеком и компьютером. Пользователи не всегда дают вам знать, какие проблемы у них возникают, особенно если их можно «обходить», поэтому журнал может помочь вам понять, что нужно сделать.

Если вы можете легко управлять диалоговым окном с ошибкой, наличие диалога, в котором отображается хорошее, читаемое сообщение с кнопкой «Сведения», чтобы показать номер ошибки, трассировку и т. Д., Может стать большой помощью для решения задач в режиме реального времени также.

Answer 12

Из соображений безопасности не предоставляйте внутреннюю системную информацию, которая пользователю не нужна.
Тривиальный пример: при невозможности входа в систему не сообщать пользователю, является ли неправильное имя пользователя или неверен пароль; это только поможет злоумышленнику переборщить систему. Вместо этого просто скажите, что «комбинация имени пользователя/пароля недействительна» или что-то в этом роде.