Что такое баг-репорт и как его составить

О чем речь? Баг-репорт – отчет об ошибках. Составляется в основном для документирования промахов разработчиков. Отчет нужен для выявления виновных и исправления багов. Если сообщать об ошибке лично, то разработчик может либо забыть, либо понадеяться на своих коллег, которые ничего не исправят.

Как? У баг-репорта нет установленной структуры, поэтому каждый вправе разрабатывать документ по своему усмотрению. Однако некоторые разделы в нем должны быть обязательны. Также важно помнить, что это технический отчет, а значит, в нем не место художественному тексту.

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

Баг-репорт (bug report) представляет собой технический документ, в котором указывается информация об ошибке в работе программного обеспечения. Его заполнением занимается тестировщик. Затем документ отправляется разработчикам, чтобы они исправили имеющиеся недочеты.

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

Откуда берутся баги

Баг – это некорректная работа ПО. Причиной является ошибка в коде, которую допустил разработчик в процессе его написания.

Узнай, какие ИТ - профессии
входят в ТОП-30 с доходом
от 210 000 ₽/мес

Павел Симонов

Исполнительный директор Geekbrains

Команда GeekBrains совместно с международными специалистами по развитию карьеры подготовили материалы, которые помогут вам начать путь к профессии мечты.

Подборка содержит только самые востребованные и высокооплачиваемые специальности и направления в IT-сфере. 86% наших учеников с помощью данных материалов определились с карьерной целью на ближайшее будущее!

Скачивайте и используйте уже сегодня:

Павел Симонов

Исполнительный директор Geekbrains

Топ-30 самых востребованных и высокооплачиваемых профессий 2023

Поможет разобраться в актуальной ситуации на рынке труда

Подборка 50+ бесплатных нейросетей для упрощения работы и увеличения заработка

Только проверенные нейросети с доступом из России и свободным использованием

ТОП-100 площадок для поиска работы от GeekBrains

Список проверенных ресурсов реальных вакансий с доходом от 210 000 ₽

Получить подборку бесплатно

pdf 3,7mb

doc 1,7mb

Уже скачали 32014

Это может произойти из-за:

• попыток уложиться в сжатые сроки;
• стресса;
• усталости;
• недомогания;
• проблем с коммуникациями внутри команды;
• непонимания техзадания;
• отсутствия необходимых знаний у специалиста;
• проблем, связанных с концентрацией внимания;
• недостатка документации или иной информации о проекте;
• высокой сложности программы;

Виды багов

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

• Визуальные. Они относятся к интерфейсу ПО. К примеру, кнопка «Оформить заказ» отображается за пределами экрана.
• Функциональные. К примеру, человек жмет на кнопку «Оформить заказ», но приложение никак на это не реагирует. Еще одна частая проблема – пользователи применяют одноразовые купоны на скидку по несколько раз.
• Дефект UX. Такая ошибка делает работу с ПО менее удобной. К примеру, для подтверждения номера телефона человеку нужно несколько раз закрыть и открыть приложение.
• Баг нагрузки. В интернет-магазин будет заходить множество пользователей. Особенно это касается праздничных дней и других примечательных дат. Например, так называемая Черная пятница. Во избежание проблем необходимо провести нагрузочное тестирование. Можно смоделировать ситуацию, при которой один раздел одновременно открывают несколько тысяч пользователей. Если ПО начнёт тормозить, то тестировщик должен сообщить о баге нагрузки.
• Баг производительности. К примеру, приложение занимает слишком много места в памяти мобильного устройства, медленно функционирует или быстро расходует заряд батареи.
• Баг требований, или логический баг. Как правило, такие ошибки возникают в том случае, если до начала разработки ПО или отдельной «фичи» в требованиях было что-то упущено. К примеру, не добавили всплывающее оповещение, что при включенном VPN ПО может работать с ошибками. Разработчик написал код так, как было указано в требованиях. В результате программа функционирует согласно ТЗ, но не так, как хочется заказчику.

Читайте также!

DBeaver: простое управление различными типами баз данных

Подробнее

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

Степени серьезности и приоритетов в баг-репортах

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

Есть пять базовых степеней серьезности:

• Блокирующий. Вся программа не сможет функционировать, если ошибку не исправить.
• Критический. Большинство составляющих программы работает некорректно.
• Значительный. Ошибка мешает функционированию одной из основных логических цепочек ПО. Программа работает, но при этом задача не решается с помощью предназначенного для этого способа.
• Незначительный. Основные логические цепочки программы работают нормально. ПО можно использовать с незначительными потерями качества.
• Тривиальный. Вся программа будет нормально работать, даже если ошибку не исправлять.

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

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

Стоит учесть, что степень серьезности бага определяет степень его приоритета.

Шаблон баг-репорта

Рассмотрим важнейшие атрибуты баг-репорта:

Эти поля можно использовать для создания шаблона баг-репорта.

Как оформить баг-репорт

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

Как же составить баг-репорт? Рассмотрим несколько важных нюансов, которые необходимо учесть начинающему тестировщику:

• Размер заголовка. Эта часть баг-репорта помогает разработчику быстро понять суть проблемы. Заголовок не должен быть слишком длинным или коротким.
• Локализация. Тестировщик должен не просто найти баг, но еще и правильно его описать. В противном случае разработчики будут решать проблему, которая не имеет никакого отношения к их обязанностям.
• Вложения. Если баг визуальный или UX (к примеру, нашлась некорректная вёрстка или не функционирует кнопка), то для наглядности необходимо сделать скриншоты. Так разработчик поймет, что видит пользователь при возникновении ошибки.
• Шаги воспроизведения. Не стоит начинать с этапа«Включить компьютер». При этом шаги должны быть описаны максимально точно, без размытых формулировок. К примеру, «нажать кнопку “Начать”, сканировать любой товар из задачи».
• Взгляд на проблему. Специалист должен поставить себя на место заказчика. К примеру, если текст не помещается в поле, то такая ошибка мешает бизнесу? Это необходимо, чтобы правильно оценить серьезность и приоритет дефекта.
• Фактический и ожидаемый результаты. Если тестировщик опишет проблему непонятно, то разработчику придется задать ему уточняющие вопросы. К примеру, фактически результат— кнопка не работает, а ожидаемый результат — кнопка работает. Такое описание не дает разработчику никакого понимания сути проблемы.

Обычно после того как баг был обнаружен, он попадает на стадию «Новый». Когда все работы по исправлению будут завершены, он получит статус «Закрытый».

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

• Отклонен. Эта стадия нужна для багов, которые не получилось воспроизвести из-за неточностей в «Шагах воспроизведения» или повторном попадании дефекта в категорию «Новый». Кроме того, баг может быть отклонен в том случае, если его исправление разрешается перенести на более позднюю дату.
• Открыт. Если баг требуется исправить в кратчайшие сроки.
• Исправлен. Сюда относят уже исправленные ошибки.
• Переоткрыт. Если ранее баг был отсрочен или отклонен, но потом решение поменялось.

Дарим скидку от 60%
на курсы от GeekBrains до 01 декабря

Уже через 9 месяцев сможете устроиться на работу с доходом от 150 000 рублей

Забронировать скидку

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

Типичные ошибки в баг-репорте

Тестировщик должен иметь определенные знания и навыки, чтобы правильно формировать баг-репорты. Джуниоры зачастую испытывают трудности при выявлении дефектов ПО. Рассмотрим самые распространенные ошибки:

• Неправильно составлен заголовок. Он должен отвечать на вопросы «Что? Где? Когда?».
• В заголовке есть лишние сведения (версии, окружения, учетные данные пользователей и т. п.).
• Слишком подробно описаны шаги для воспроизведения.
• Нет фактического и / или ожидаемого результата.
• Нет ссылки на требование, которое проверялось (при наличии).
• Нет скриншота / видеозаписи для UI/UX багов. Либо на скриншоте не выделен дефект.
• Допущены грамматические ошибки.
• Техническая безграмотность.
• Использование «жаргона».

Читайте также!

Deploy как этап разработки программного обеспечения

Подробнее

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

Советы по заполнению баг-репорта

Перечислим рекомендации, которые помогут правильно заполнить баг-репорт:

• Следует выявлять причину возникновения ошибки. К примеру, если на веб-сайте не удается восстановить пароль, то проблема может иметь разные корни: бэкенд или фронтенд. Тестировщику необходимо выявить истинную причину бага, чтобы команда разработчиков четко понимала, кто должен заниматься исправлением.
• Лучше выполнять тестирование на разных устройствах. Если баг был обнаружен в десктоп-версии, то он может возникнуть и на смартфонах.
• Необходимо выполнять тестирование в разных версиях ПО. При составлении баг-репорта нужно учитывать, что ошибка может не обнаруживаться на старой версии ПО, однако в обновлении она все же есть.
• Нужно описать несоответствия между ожидаемым результатом и фактическим. Для этого необходимо ознакомиться с технической документацией и техзаданием.

Часто задаваемые вопросы о баг-репорте

Как правильно описать баг?

Начинающий специалист должен задаваться главным вопросом «Что, если?». Чем больше гипотез формирует и проверяет тестировщик, тем лучше.

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

Что делать тестировщику, если он нашел слишком много ошибок?

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

Перечислим примеры метрик:

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

Только до 28.11

Скачай подборку материалов, чтобы гарантированно найти работу в IT за 14 дней

Список документов:

ТОП-100 площадок для поиска работы от GeekBrains

20 профессий 2023 года, с доходом от 150 000 рублей

Чек-лист «Как успешно пройти собеседование»

Чтобы получить файл, укажите e-mail:

Введите e-mail, чтобы получить доступ к документам

Подтвердите, что вы не робот,
указав номер телефона:

Введите телефон, чтобы получить доступ к документам

Скачать подборку бесплатно pdf 2,5mb

Уже скачали 52300

Я подтверждаю согласие на обработку персональных данных.

Почему баг-репорты составляют не во всех компаниях?

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

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

Автор статьи:

Редакция сайта GeekBrains Шеф-редактор раздела Программирование