Что делает сообщение об ошибке хорошим.
Плохое сообщение об ошибке – это:
•сообщение, которое не говорит ни о чем («Это не работает»), не имеет смысла или не даёт достаточной информации;
•сообщение, которое даёт неправильную информацию.
•сообщение о проблемах, которые оборачиваются чужими ошибками (дефектом в другой программе, ошибками пользователя, сбоями сети).
Научитесь писать ясные, точные и информативные сообщения.
Постарайтесь четко определить, что является реальными фактами («Я был за компьютером и это случилось»), а что — предположениями («Я думаю, что проблема может быть в этом»). Опустите предположения, если хотите, но не опускайте факты.
Первая задача сообщения об ошибке — позволить разработчику увидеть сбой собственными глазами. Если вы не можете быть с ним, чтобы воспроизвести сбой, дайте ему детальные инструкции, чтобы он смог воспроизвести сбой самостоятельно.
Опишите, что произошло. Опишите точно, что вы увидели. Опишите, почему вы думаете, что то, что вы увидели неправильно; еще лучше опишите точно, что вы ожидали увидеть.
•Будьте конкретны. Если вы можете сделать что-то двумя способами, укажите, каким вы воспользовались.
•Будьте точны. Скажите точно, что вы сделали.
•Будьте многословны. Лучше дать больше информации, чем меньше. Если вы сказали слишком много, разработчик может игнорировать какие-то части. Если вы сказали слишком мало, ему придётся обратиться к Вам и задать еще вопросы.
•Будьте осторожны с местоимениями. Не используйте слов вроде «это» или «оно» когда неясно, что они означают.
•Прочитайте то, что вы написали. Внимательно прочитайте своё сообщение, и посмотрите считаете ли вы сами, что оно ясное. Если вы привели последовательность действий, приводящую к сбою, попытайтесь выполнить ее сами чтобы убедиться в том, что вы не пропустили какой-нибудь шаг
•Пишите ясно. Скажите, что вы имеете в виду и убедитесь в том, что это не может быть истолковано неправильно. Если нельзя понять, что вы имели в виду, вы могли бы с таким же успехом вообще ничего не говорить.
Будьте информативны. Множество необходимых деталей зависит от конкретной программы, но одна вещь, которую Вы определенно должны быть готовы сообщить — номера версий. Будьте готовы предоставить дополнительную информацию, если это потребуется разработчику.
Автор
Тема: Что важно знать перед отправкой вашего сообщения об ошибке? (Прочитано 20321 раз)