Баг-репорт — это технический документ для фиксирования и подробного описания ошибок в работе ПО. Помимо описания бага, в документе отслеживается статус и приоритетность, что позволяет эффективно управлять задачами: разработчик видит критичные проблемы и устраняет их в первую очередь. Это минимизирует сбои и поддерживает более качественный пользовательский опыт.
Пример баг-репорта
Баг-репорты отличаются в зависимости от требований компании, проекта и даже используемого ПО для коллаборации. Ниже мы собрали для вас примеры баг-репортов в Jira и Trello.
Хотя визуально баг-репорты отличаются, структура у них примерно одинаковая:
- Заголовок, название или краткое описание бага
- Шаги к воспроизведению
- Фактический результат
- Ожидаемый результат
- Окружение
- Приоритет
- Статус
- Автор
- Исполнитель
- Дополнительно
Иногда в баг-репорт добавляет еще и некоторые нюансы:
- Описание
- Тип ошибки
- Проект
- Номер бага
Как составить баг-репорт?
Рассказываем, как правильно оформить баг-репорт в Jira после того, как тестировщик обнаружил ошибку в работе ПО.
1. Составьте емкий заголовок Он должен отвечать на вопросы «Что? Где? Когда?». Не указывайте побочную информацию типа версий или окружений. Заголовок — это краткое содержание, которое позволяет разработчику быстро понять суть проблемы. Не нужно его намеренно удлинять или укорачивать.
2. Подробно опишите проблему в поле «Описание» Если у баг-репорта краткий заголовок, можно его раскрыть в свободной форме, добавив больше важных деталей. В этом же поле описываются:
- «Фактический результат»: как проявляется баг в работе ПО. Например, при клике на кнопку «Купить» не всплывает окно «Добавить в корзину»
- «Ожидаемый результат»: как должно работать ПО без сбоя. Например, при клике на кнопку «Купить» автоматически появляется форма заказа
При описании фактического и ожидаемого результата не стоит сухо указывать «При клике ничего не происходит». Описание должно быть понятным и доступным, чтобы разработчик сразу же понял суть проблемы. Иначе он вернется к тестировщику с дополнительными вопросами, баг-репорт потребует доработки, а время устранения сбоя в работе ПО затянется.
Если вы работаете в Jira, то добавить файлы, например, скриншоты для визуальных багов, можно именно в этом поле. Всегда старайтесь добавлять иллюстрации к визуальным и UX-ошибкам. Так разработчик быстрее поймет суть проблемы и обнаружит баг при его исправлении.
3. Опишите «Шаги к воспроизведению» Кратко и последовательно опишите путь до бага. Например, перейдите в раздел «Каталог», кликните на любой товар и нажмите кнопку «Купить». Не нужно описывать шаги издалека — с разблокировки экрана телефона, включения компьютера или запуска приложения. Избегайте размытых и двусмысленных формулировок, чтобы разработчик смог быстро воспроизвести последовательность действий и обнаружить баг. Лучше представить шаги в виде нумерованного списка.
4. Установите уровень приоритета бага Выберите степень серьезности проблемы:
- S4 — Блокирующая. ПО не работает из-за ошибки, например при переходе в «Каталог» выдает «Ошибка 404»;
- S3 — Критическая. Из-за бага не работает основной функционал ПО, например, в интернет-магазине нельзя добавить товар в корзину и купить его;
- S2 — Значительная. ПО работает, но использовать его неудобно из-за ошибки, например, добавить товар в корзину можно только из карточки товара, а из каталога нельзя;
- S1 — Незначительная. Логика процессов практически не нарушена, программа функционирует, например, неудобная навигация в интернет-магазине;
- S0 — Тривиальная. Баг не влияет на процесс работы ПО, например, при вводе даты автоматически стоит 01-01-2000, а не актуальная дата.
Иногда вместо степени серьезности в баг-репорте выставляют приоритет (или срочность выполнения задачи):
- P1 — Высокий
- P2 — Средний
- P3 — Низкий
5. Заполните другие поля Обычно нужно еще установить статус бага (при открытии бага и внесении его в баг-репорт выберите «Открытый»), указать автора и исполнителя (разработчика, который будет исправлять сбой), добавить окружение и версию. Не забудьте добавить скриншоты с важной информацией, например, логи, визуальные ошибки или компоненты системы.
После того как все поля заполнены, нужно создать баг-репорт, и задача попадет разработчику.
