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