В каждой компании существует своя структура оформления баг-репортов. 4 Но в большинстве шаблонов есть общие пункты. 4
Некоторые обязательные элементы баг-репорта:
- ID — идентификационный номер баг-репорта, должен быть уникальным. 2 Помогает быстро найти нужный баг-репорт. 2
- Заголовок — передаёт суть ошибки, помогает быстро понять, в чём дело. 2 Заголовок должен отвечать на три вопроса: «Что? Где? Когда?». 2
- Шаги воспроизведения — пошаговая инструкция о том, как воспроизвести ошибку. 2 Действия должны быть описаны достаточно полно, но ёмко, и быть понятными для любого человека вне зависимости от технической подготовки. 2
- Результаты — описание фактического результата и ожидаемого результата. 2
- Окружение — операционная система, браузер, устройство (в случае мобильного приложения), версия приложения. 2
- Приоритет — показывает степень критичности ошибки и срочность её исправления. 2
Некоторые необязательные поля:
- Предусловие — описывает, как систему нужно подготовить перед тестированием (в случае необходимости). 2
- Постусловие — указывает, как систему нужно вернуть в прежний вид после тестирования (в случае необходимости). 2
- Описание — прописывают, если в заголовке передано недостаточно информации об ошибке. 2
- Дополнительные материалы — прикладываются в случае необходимости и помогают проиллюстрировать ошибку (скриншот, скринкаст). 2
Баг-репорт оформляется в специальной системе для отслеживания ошибок — баг-трекере. 2 Каждая команда или компания сама решает, каким именно баг-трекером пользоваться. 2