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

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

Почему в тестировании это называется “баг”?

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

Зачем нужны баг-репорты?

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

Что должен включать в себя качественный отчет об ошибке?

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

Из чего состоит идеальный баг-репорт?

Вот что необходимо включить в отчет об ошибке:

  • Название/идентификатор ошибки: Описание ошибки (не более одной строки).
  • Краткое описание:  Добавьте дополнительную информацию к заголовку, чтобы сделать суть ошибки более понятной.
  • Серьезность и приоритет ошибки: Определение степени серьезности и приоритета ошибки помогает разработчикам понять, как быстро нужно её исправить.
  • Окружение:  Веб- и мобильные приложения ведут себя по-разному в зависимости от окружения. Разработчикам необходимо знать устройство, операционную систему и версию, браузер, размер экрана, окружение (тест/стэйдж/продакшен), компонент, учетные данные тестового пользователя и т. д.
  • Шаги воспроизведения ошибки: Объясните в простых шагах действия, которые вы предприняли до появления ошибки. Чтобы воспроизвести ошибку было еще проще, добавьте скриншот или запись экрана – так разработчик сможет увидеть, как вы воспроизводите эту новую ошибку.
  • Ожидаемые и фактические результаты: Бывает полезно указать, что, по вашему мнению, должно было произойти, а что произошло. Например, “Пользователи пытались найти товары в магазине, но результаты поиска не появлялись на странице”.
  • Консольные или сетевые логи: При возникновении ошибки очень велика вероятность того, что произошла ошибка в JavaScript фронтенда или сбой в работе некоторых API. Вы всегда можете увидеть эти ошибки при открытии скрипта сайта или на вкладке “Сеть” в DevTools, что очень полезно, но не всегда очевидно.
  • Исходный URL: Разработчикам необходимо знать, на какой странице произошла ошибка, и её конкретный URL. Это сэкономит всем массу времени!
  • Дополнительная информация: Также может быть полезно добавить любую другую информацию, которая может быть полезна разработчику, назначенному для исправления ошибки.

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

Такие инструменты управления проектами, как Jira или Trello являются первым выбором большинства людей, когда речь идет об отслеживании ошибок. Список 20 лучших программ, инструментов и решений для отслеживания ошибок даст вам лучшее представление о том, что представлено на рынке.

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

Перевод статьи «Effective Bug Report [Detailed Guide]».

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

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