Как написать эффективный баг-репорт?

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

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

Друзья, поддержите нас вступлением в наш телеграм канал QaRocks. Там много туториалов, задач по автоматизации и книг по QA.

Что такое баг-репорт?

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

Важность эффективного баг-репорта

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

Как написать баг-репорт?

Баг-репорты могут варьироваться в зависимости от тестируемого программного обеспечения. Существует девять ключевых моментов, которые необходимо учитывать при создании баг-репорта:

1. Используйте четкий заголовок

Важно, чтобы в баг-репорте присутствовал короткий и четкий заголовок, в котором как можно более подробно и кратко излагается содержание. Разработчик, прочитав заголовок, должен понять, о чем будет идти речь в баг-репорте. Заголовок должен включать категорию и местоположение ошибки, например “UI” или “Cart”, а также саму ошибку. Хорошим примером может быть: “Medium: Корзина не обновляется – новые товары не появляются в корзине”.

2. Напишите четкое, краткое описание

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

Например, “В [дата] я попытался добавить [товар] в корзину, используя [браузер] и [операционную систему]. Новый товар не отобразился в корзине после нажатия кнопки “Добавить” на [URL веб-сайта]”.

3. Назначьте приоритет багу

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

  • Critical, blocker or high: Критической считается ошибка, которая не позволяет приложению работать должным образом. Ошибка может включать потерю данных, повреждение файлов или полный отказ программы, что делает ее непригодной для использования.
  • Medium: Ошибка влияет на работу пользователя, но он все равно может пользоваться программой без особых неудобств.
  • Low: Любые другие минимальные проблемы, негативно влияющие на работу пользователя, такие как опечатки или отсутствие каких-то иконок на странице.

4. Включите подробную информацию о среде

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

  • Информация об устройстве: Укажите тип аппаратного обеспечения, номер модели и сведения о производителе.
  • Браузер и операционная система: Включите версию операционной системы, в которой была обнаружена ошибка.
  • Сведения об учетной записи: Укажите информацию об учетной записи и данные для входа в систему.
  • Сетевое подключение: Укажите, при каком подключении – Wi-Fi, Ethernet или мобильной передачи данных – появляется ошибка.
  • Версия приложения: Укажите номер версии тестируемого приложения.
  • Разрешение экрана: Укажите уровень масштабирования и соотношение пикселей.
  • Частота: Укажите количество раз, когда вам удалось воспроизвести ошибку, и количество попыток воспроизвести ошибку.
  • Исходный URL-адрес: Укажите URL-адрес страницы с ошибкой, чтобы помочь разработчику быстро обнаружить проблему.

5. Запишите шаги для воспроизведения ошибки

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

Пример:

  1. Поиск продукта в приложении
  2. Выбор товара
  3. Выбор опции “Добавить в корзину”
  4. Переход в корзину (товар не отображается)

6. Опишите ожидаемый результат

Это результат, который вы ожидали получить при выполнении конкретной задачи. Будет полезно, если в этом разделе вы представите более глубокие сведения по поводу ожидаемой работы приложения. Это позволит разработчику получить больше информации для того, чтобы установить причину ошибки. В качестве примера может быть: “Товар должен отображаться в корзине после нажатия кнопки “Добавить в корзину”.

7. Опишите фактический результат

Опишите результат, полученный при возникновении ошибки. Можно отметить, что приложение аварийно завершает работу, появляется символ загрузки или сообщение об ошибке. Например: “Товар не отобразился в корзине на нескольких платформах и операционных системах”.

8. Добавьте вложения, если это необходимо

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

9. Укажите свои контактные данные

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

Советы по написанию эффективного баг-репорта

  • Пишите об одной ошибке в одном отчете. Если вы обнаружили несколько ошибок, то для каждой из них создайте отдельный баг-репорт. Это поможет разработчику следить за ошибками и легко видеть приоритет и информацию о каждой из них отдельно.
  • Сообщайте об ошибке немедленно. Если при тестировании системы вы обнаружили какие-либо ошибки, сообщите о них как можно скорее.
  • Пробуйте и тестируйте. Протестируйте ошибку несколько раз, чтобы иметь четкое представление о проблеме и включить в отчет как можно больше деталей. Попробуйте воспроизвести ошибку на различных устройствах, браузерах и операционных системах.
  • Проверьте, не сообщалось ли об этой ошибке ранее. Если это распространенная ошибка, то вполне вероятно, что другой тестировщик уже обнаружил ее и сообщил о ней. Если это так, добавьте в комментарий все необходимые дополнительные сведения. Избегайте создания дублирующего баг-репорта.
  • Прочтите еще раз свой баг-репорт, прежде чем нажать кнопку “Отправить”. После завершения работы над отчетом прочтите его еще раз. Убедитесь, что вы написали его достаточно подробно и понятно для разработчика. Если баг-репорт кажется запутанным или сложным, перепишите его так, чтобы он был понятен.

Перевод статьи «How To Write a Bug Report Effectively in 10 Steps».

Оставьте комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *