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

Нравится вам это или нет, но ошибки - это неизбежная часть любого программного обеспечения.

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

Сообщение об ошибках - правильный путь

Итак, вот как написать отчет об ошибке, который поможет сузить проблему, порадовать разработчиков и упростить процесс обеспечения того, чтобы ваше программное обеспечение просто… работало.

Сводка ошибки

В чем проблема? Сводка ошибок должна давать быстрое представление о том, в чем именно заключается проблема. Это должно быть точно.

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

В чем проблема? Если это веб-сайт, скопируйте и вставьте URL. Если это не так, дайте название экрану, на котором вы находитесь.

В какой среде вы используете программное обеспечение?

Вы используете ПК или Mac? Firefox или Chrome? iPad или iPhone? iOS или Android? Какая (ые) версия (а) программного обеспечения? Какие плагины для браузера вы установили? Какое сумасшедшее программное обеспечение вы используете в фоновом режиме?

Опишите проблему (очевидно)

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

Ожидаемый результат - Предлагаемое исправление

Скажите, что вы ожидали, что произойдет с предпринятыми шагами и что произошло на самом деле. Как вы думаете, знаете, как это исправить? Большой! Избавьте разработчиков от лишнего времени и путаницы и опишите здесь, как, по вашему мнению, это следует исправить.

Скриншоты!

Если вы видите проблему, запечатлейте момент. Нет ничего лучше, чем увидеть проблему самостоятельно. И если в нем уже есть аннотации, вы его прибили!

Поделитесь любовью с разработчиками

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

Так же просто, как разжечь электронное письмо и с любовью задокументировать происшествие. Не просто позвоните или отправьте однострочное сообщение.

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

С уважением, разработчик.