Очень важно четко и полно описать, в чем ошибка, чтобы не тратить время на выяснение деталей и исправить с первого раза.

Summary

В Summary нужно описать суть ошибки в одном предложении.

Нужно указать контекст ошибки: экран, при каких условиях воспроизводится.

Примеры:

  • Usability issues in the “Email” and the “Verify email” fields on the Register screen
  • It is possible to register more 5 members on the free plan
  • Search works incorrectly on the List of all members page
  • Crash on profile submit for a new member

Description

Указать Steps to reproduce.

Для форм указать значения всех введенных полей. Указать, какие поля оставить пустыми.

Указать Expected result. Описать ожидаемый результат объективно и полно, а не “it must work correctly”.

Указать Actual result. Описать получаемый результат объективно и полно: что видно на экране, а не “it works incorrectly”.

Для Priority = Blocker в конце Description сделать упоминание менеджера продукта. Пример синтаксиса:

Attn: [~obrizan].

или можно поставить собаку (@) и увидеть всех пользователей Джиры:

Все пользователи Джиры

Указать логин, пароль, прочую информацию, где повторяется ошибка.

Прикрепить файлы, если требуется. Например, если ошибка при импорте файла, то прикрепить файл, который вызывает ошибку.

Прикрепить скриншот поясняющий контекст ошибки. Скриншоты нужно переименовать с указанием шага. Например: step1.png, step2.png. В описании ошибки сослаться на эти скриншоты. Можно воспользоваться синтаксисом:

!имя_атачмента|thumbnail!

например:

!IMG_0487[1].PNG|thumbnail!

В тег {noformat} вставить логи ошибок. Лог ошибок можно скопировать с экрана браузера, можно скопировать с консоли браузера (см. Using the Console). Пример использования тега {noformat} в описании ошибки:

Тег {noformat}

Получение крешлога из Crashlytics (нужно нажать кнопку Raw):

Получение крешлога из Crashlytics

Указать частоту повторяемости этой ошибки: постоянно, иногда, изредка и т. д.

Указать статистику из Crashlytics (или аналогичного сервиса статистики): как часто повторяется, у скольки пользователей в абсолютном и относительном значениях.

Priority (severity)

Приоритет — он же критичность.

# Критичность Описание, признаки
1 Blocker Заблокирована разработка, тестирование (более 50% тесткейсов) или использование продукта.
2 Critical Потеря или искажение данных пользователя. Невозможность успешно выполнить основную функцию продукта. Креш продукта у подавляющего большинства пользователей.
3 Major Невозможность успешно выполнить второстепенную функцию продукта.
4 Minor Все остальное.

Labels

Установить следующие метки:

  • customer — если об этой ошибке сообщил клиент (не важно как: по почте, устно, в чате).
  • regression — если эта функция работала раньше, а теперь работать перестала.
  • crash — если произошел креш программы или Internal Server Error.