Текст сообщения об ошибках - рекомендации

Ответ 1

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

• Руководства пользователя для пользователей Windows и, в частности, раздел об ошибках .
• Руководство по стилю в Microsoft

Ответ 2

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

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

Ответ 3

Хорошее сообщение об ошибке должно:

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

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

Ответ 4

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

Ответ 5

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

Ответ 6

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

Ответ 7

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

Не удалось найти имя файла: "somefile.txt"

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

Ответ 8

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

Ответ 9

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

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

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

Ответ 10

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

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

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

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

Ответ 11

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

Ответ 12

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