Как написать отчет об ошибках с примерами

Что такое отчет об ошибке? Зачем вам нужен хороший отчет об ошибках?

Отчет об ошибках — это важный документ в STLC, который предлагает различные преимущества команде тестирования. Он отслеживает все дефекты, многочисленные ошибки, ошибки и другие несоответствия, обнаруженные в ходе тестирования программного обеспечения, и сообщает о них.

Цель этой документации после тестирования — предоставить заинтересованной команде специалистов информацию об уровне ошибок, обнаруженных в процессе тестирования.

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

Почему вас должны волновать хорошие объяснения ошибок?

Хорошие объяснения ошибок

Вот момент, который вам необходимо учитывать при написании хорошего и подробного отчета об ошибках в программном обеспечении:

  • Он действует как руководство, помогающее избежать той же ошибки в будущих выпусках.
  • Экономьте время на общение (электроннаяmailс, звонки).
  • Меньше работы для разработчиков (они сделают именно то, что вы хотите).
  • У вас будет меньше узких мест в проекте; ошибки будут исправлены быстрее и эффективнее.

Как написать отчет об ошибке (шаблон отчета об ошибках)

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

Однако, следованиеwing общие поля всегда необходимы, когда вы хотите написать отчет об ошибке:

  • Идентификатор ошибки/заголовок.
  • Серьезность и приоритет.
  • Описание
  • Окружающая среда
  • Действия по воспроизведению.
  • Ожидаемый результат.
  • Фактический результат.
  • Вложения (скриншоты, видео, текст)

Давайте рассмотрим все эти компоненты устранения ошибок один за другим:

1) Название/идентификатор ошибки:

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

Примеры:

❌ Плохо: «Я не вижу товар, когда снова смотрю, тырп его нет».

  • Волна
  • Агрессивный
  • Слишком многословно

просит реализовать решение.

✅ Хорошо: «КОРЗИНА — В корзину добавлены новые товары, которые не отображаются».

  • Этот тип заголовка мгновенно определяет проблему (CART)
  • Он фокусируется на реальной технической проблеме.

2) Серьезность ошибки:

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

  • Блокировщик: Эта ошибка приводит к сбою приложения.
  • Кафедра: Критическая ошибка указывает на серьезное изменение в бизнес-логике.
  • Малой: Проблема, которая не влияет на функциональность приложения, но влияет на ожидаемые результаты.
  • Тривиально: Это не влияет на функциональность и работу приложения. Это может быть опечатка.

3) Приоритет ошибок:

Фоллоwing это общая градация для определения приоритета ошибки:

  • Высокая: Он охватывает все, что влияет на поток или блокирует использование приложения.
  • среда: Это отрицательно влияет на пользовательский опыт.
  • Малой: Все остальные ошибки типа (опечатки, отсутствующие значки, проблемы с макетом и т. д.).

4) Окружающая среда:

Ошибка может появиться в определенной среде, а не в других. Например, иногда при запуске сайта на Firefox, или приложение работает неправильно только при запуске на устройстве Android и нормальной работе на iPhone.

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

5) Резюме:

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

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

Примеры:

  • Плохо: «Я пытался добавить что-то в тест, но ничего не появилось, когда я это сделал или нажал кнопку».
  • Хорошо: «Когда я попытался добавить [ПРОДУКТ] в корзину, но ничего не произошло, когда я нажал кнопку «Добавить» на веб-странице с обзором конкретного продукта».

6) Шаги по воспроизведению:

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

Укажите конкретные шаги, которые необходимо выполнить:

Вот пример хорошо написанной процедуры:

Шаги:

  1. Выберите продукт X1.
  2. Нажмите «Добавить в корзину».
  3. Нажмите «Удалить», чтобы удалить товар из корзины.

7) Ожидаемый результат:

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

Например:

После нажатия кнопки «Отправить» обязательные поля должны быть выделены красным цветом.

8) Фактический результат:

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

Например:

После нажатия кнопки «Отправить» обязательные поля выделяются зеленым цветом.

9) Вложения (скриншоты и видео):

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

Например:

  • Скриншот: Скриншоты могут легко выявить ошибки в программе; удобно, когда ошибка выделена определенной аннотацией, кружком или изображением стрелки).
  • Видео: Иногда сложно описать ошибку словами, поэтому лучше создать видео, чтобы разработчик мог исправить недочет в программе).

10) Затронутая версия:

Это уязвимая версия программного обеспечения, в которой сообщается об ошибке.

11) Исправленная версия:

Это версия программного обеспечения, в которой устранена ошибка. Поэтому, когда QA, сообщивший об ошибке, проверяет, исправлена ​​ли она, он использует правильную версию программного обеспечения.

12) Целевая версия:

Целевая версия, в которой должна быть исправлена ​​ошибка. Поэтому, когда команда разработчиков работает над исправлением ошибки, они в основном нацелены на конкретную версию приложения.

13) Дата закрытия:

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

14) Статус:

Когда создается новая ошибка, ее статус должен быть открытым. После этого он проходит такие этапы, как «В процессе», «Исправлено», «Выполняется», «Повторное открытие» и т. д.

Советы по написанию отчетов об ошибках

Вот несколько важных советов, которые следует помнить при написании эффективного отчета об ошибках:

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

Инструменты сообщения об ошибках

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

  • JIRA
  • Отслеживание ошибок Zoho
  • Bugzilla

Вы можете ознакомиться с нашим подробным обзором лучший инструмент для сообщения об ошибках.

Распространенная проблема и решение при написании отчета об ошибке:

Вот некоторые распространенные проблемы и их решения при написании отчета об ошибке:

Пример отчета об ошибке Проблема
При умножении 2 на 3 ответ будет положительным. Сообщите о закономерности, а не о примере.
Чтобы избежать этого, список будет упорядочен в алфавитном порядке при добавлении нового элемента. Не описывайте только то, что не так
Например:
Для этого вам нужно будет открыть браузер и ввести URL-адрес сайта. Вы обнаружите, что первое поле «имя пользователя» написано с ошибкой.
Всегда прямо по делу (Никогда не рассказывайте историю!).
Имя клиента в отчете написано с ошибкой. Приоритет: высокий, серьезность: высокий Никогда не смешивайте приоритет и серьезность.
Формула расчета налога НЕПРАВИЛЬНА!!?? Не используются ЗАГЛАВНЫЕ буквы, красные буквы, красные кружки, '!',
Я не думаю, что дизайн главной страницы Ul хорош. Не используйте свое суждение.
Пример неясного описания: По поводу нашего сегодняшнего обсуждения, пожалуйста, выполните необходимые действия для этой страницы. Сделайте свое описание понятным для всех.
Фон страницы должен быть синим, оранжевым или зеленым, либо его можно сделать черным или белым.

Это нехорошо, так как непонятно, что нужно от команды веб-разработки и дизайна.

Минимизируйте варианты
Формула расчета налога иногда работает не так, как ожидалось. Золотое правило: не используйте слово «иногда».

Пример отчета об ошибке

Вот небольшой пример отчета об ошибке:

[МОЙ АККАУНТ] Подчеркивание отображается при наведении курсора мыши на кнопку «Обновить».

Описание: Нам нужно убрать подчеркивание при наведении курсора мыши на кнопку «Обновить» в разделе «Моя учетная запись».

Ссылка: http://test.com/mv-account/

Браузер/ОС: Chrome 25. OSX Yosemite 10.10.2

Действия по воспроизведению:

1. Зайдите на сайт www.test.com.

2. Войдите, используя учетные данные для входа.

3. Перейдите в «Моя учетная запись».

4. Наведите указатель мыши на кнопку «Обновить».

Фактический результат: есть подчеркивание.

Ожидаемый результат: нет подчеркивания.

Данные для входа: test@test.com / mysecretpass12

Необходимо избегать ошибок при написании отчетов об ошибках.

Вот несколько важных ошибок, которых следует избегать при написании отчета об ошибке:

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