Расширенное руководство по написанию отчета об ошибке

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

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

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

Давайте начнем!

Перед этим посетите Testuconference 2022 — виртуальный саммит, определяющий будущее тестирования. Присоединяйтесь к более чем 3000 тестировщиков программного обеспечения, разработчиков, экспертов по тестированию и лидеров на 3 невероятных дня обучения, тестирования и общения с сообществом на Testμ Conference 2022 от LambdaTest.

Что такое отчет об ошибке в тестировании программного обеспечения?

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

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

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

Давайте рассмотрим этапы составления отчета об ошибке, прежде чем перейти к тому, как написать отчет об ошибке:

Этап 1: Вы обнаружили ошибку.

Этап 2: Вы отправляете письмо своему разработчику и получаете ответ: «Не могли бы вы объяснить подробнее?».

Этап 3: Вы отправляете подробный отчет о том, в чем заключается ошибка.

Этап 4: Разработчик предпринимает необходимые действия, и тада! Ошибка исчезла навсегда!

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

Посмотрите это видео, чтобы узнать больше об анализе результатов тестирования и отчетности в Selenium 4. Также узнайте о различных инструментах для создания отчетов в Selenium, исходя из простоты настройки, цены, поддерживаемых форматов отчетов и многого другого.

Знаете ли вы о функции Shuffle Text Lines? Перемешиватель текстовых строк принимает на вход набор текстовых строк и выводит их в случайном порядке. Попробуйте перетасовку прямо сейчас!

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

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

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

LambdaTest позволяет проводить кросс-браузерное тестирование веб-сайтов и веб-приложений на **онлайн-ферме браузеров** из более чем 3000 браузеров и операционных систем. Вы можете узнать больше об интеграциях на странице Интеграции LambdaTest.

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

1. Идентификатор проблемы

2. Заголовок

3. Резюме

4. Скриншоты/изображения/видеозаписи

5. Ожидаемые результаты по сравнению с фактическими результатами

6. Пошаговая процедура поиска ошибки

7. Окружение

8. Журналы консоли

9. URL-адрес источника

10. Приоритет и серьезность

11. Дополнительная информация

Идентификатор проблемы: Поддерживайте четкий идентификатор проблемы. Вы можете автоматически генерировать идентификаторы проблем с помощью инструмента отслеживания ошибок. Это также поможет вам избежать дублирования.

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

Пример: «Домашняя страница: Ссылка на новый блог не работает».

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

Пример: «Мы опубликовали посты в социальных сетях в 10.15 утра в нашем недавнем блоге под названием «Пища для жизни». Но когда я щелкнул по ссылке на блог, ничего не произошло. Я попытался зайти на страницу вручную, но она показывает «Сайт не может быть достигнут».

Скриншоты/изображения/видеозаписи: Всегда лучше идти визуальным путем, поскольку визуализация может дать лучшие результаты. Да, визуальное тестирование имеет огромное значение. Видеозапись, изображение или скриншот могут быстро помочь вашему разработчику обнаружить ошибку. Они наверняка смогут понять, как именно повлияла ошибка и что им нужно делать дальше.

Ожидаемые результаты и фактические результаты: Передайте то, что вы ожидали увидеть на экране, и то, что показалось вашему разработчику. Это поможет любому разработчику получить четкое представление о том, что ожидается, а что нет. Именно здесь в игру вступает тестовый пример. Фактическая разница между тестовым случаем и сообщением об ошибке заключается в том, что тестовый случай различает ожидаемый результат и фактический результат. С другой стороны, в отчете об ошибке говорится о количестве ошибок и о том, как их исправить.

Пример:

Ожидаемый результат: Ссылка на блог приведет пользователя на веб-страницу.

Фактический результат: Ссылка на блог не ведет пользователя на веб-страницу.

Пошаговая процедура поиска ошибки: Предположим, что ваш разработчик — новичок, который не знает, как и когда вы нашли ошибку. Как бы вы объяснили им это? Во-первых, проиллюстрируйте это в отчете.
Пример:

• Перейдите на главную страницу.

• Щелкните на странице ресурсов.

• Нажмите на блог.

• Нажмите на ссылку этого блога: https://www.elanthevoila.com/blog/food-for-life/.

Окружение: Включите в тестовую среду жизненно важную информацию, такую как браузер, версия ОС, размер экрана, соотношение пикселей и уровень масштабирования. Это позволит разработчику получить представление о том, на какой платформе или гаджете ошибка проявляется при масштабировании.

Пример:

• Браузер: Firefox 100

• Размер экрана: 1920×1080

• ОС: Windows Server 2022

• Размер окна просмотра: 360 x 800

• Уровень масштабирования: 100%

• Соотношение пикселей: @3x

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

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

Пример: «https://www.elanthevoila.com/blog/food-for-life/».

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

• Крупная

• Критический

• Тривиальная

• Улучшение

• Незначительная

Степень тяжести может варьироваться между высокой, средней и низкой.

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

Пример:

Имя: Амрита Ангаппа
Срок выполнения: 22/05/2022
Назначенный разработчик: Брэндон Старк

**Также проверьте, Lowercase Text- бесплатный онлайн инструмент для преобразования текста в верхнем регистре в нижний регистр мгновенно без рекламы и ограничений использования. Попробуйте преобразовать текст в верхнем регистре в текст в нижнем регистре прямо сейчас. **

Советы и рекомендации

Будь то написание отчета об ошибке после **онлайн-тестирования браузера** или **тестирования с помощью Selenium**, эти советы и рекомендации могут быть очень полезны всем, кто учится писать отчеты об ошибках:

Проверьте, действительно ли это ошибка

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

• Повторить проблему в разных средах.

• Убедиться, что проблема не связана с окружающей средой.

• Проверить спецификацию требований и убедиться в том, что функциональность не работает, или она должна вести себя так, как ведет себя в данный момент.

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

Будьте конкретны в обзоре

Когда вы задаете вопрос: «Как написать хороший отчет об ошибке?». Первый ответ будет заключаться в следующем

• Точный раздел резюме, чтобы сделать сообщение об ошибке уникальным и легко идентифицируемым.

• Краткий обзор, который дает разработчику четкое понимание проблемы.

Часто само резюме дает разработчику представление о том, в чем заключается ошибка. Например, «Кнопка не работает в iPhone X». Посмотрев на резюме, разработчик понимает, что проблема связана с определенной кнопкой на iPhone X.

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

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

• Предоставьте подробную информацию о том, как ее воспроизвести.

• Предоставьте информацию о бизнес-требовании.

Уникальность ошибки

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

• Просмотреть журналы дефектов и выяснить, не сообщалось ли о такой же ошибке или ошибке, похожей на нее.

• Перед тем как сообщить об ошибке, присвойте ей уникальный идентификатор ошибки и сделайте заголовок таким, чтобы его можно было легко найти в индексе.

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

Шаги по воспроизведению ошибки

Это самая важная часть статьи «Как написать отчет об ошибке?». Она помогает разработчику воспроизвести проблему в среде разработки или производства. Это этап, на котором тестировщик учит разработчика, как воссоздать ошибку в своей среде. При написании этого раздела, вместо краткого резюме, сосредоточьтесь на:

• Пошаговое руководство по наблюдению за нарушенной функциональностью.

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

• Не забудьте приложить скриншоты. Они служат надежным доказательством вашего отчета, а также помогают разработчику сравнить отчет со сценарием, воссозданным на его системе.

Узнайте, как отмечать ошибки с помощью тестирования в реальном времени:

Поведенческий отчет

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

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

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

Следите за отчетами

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

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

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

Дополнительные советы и рекомендации

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

Сообщайте сразу после обнаружения ошибки

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

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

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

Внимательно прочитайте отчет перед отправкой

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

Избегайте нецензурных выражений

Да, ошибка была найдена. Но это не дает никому права нападать лично на разработчика. Избегайте личной критики и оставайтесь профессионалом. Это обязательное правило для всех, кто изучает тему «Как написать отчет об ошибке».

Заключение

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

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

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

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

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

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