Что такое баг-репорт?

Если вы новичок в сфере тестирования и ранее не сталкивались с такими понятиями, как баг-трекинговая система, управление проблемами или веб-разработка в целом, вам может быть интересно, что такое отчет об ошибке, он же баг-репорт.

В этой статье мы изучим данный вопрос с разных точек зрения.

Пример баг-репорта в Android

Что собой представляет баг-репорт на Android? Android предлагает быстрые и простые отчеты об ошибках напрямую от (тестового) пользователя разработчику. Цель — получить “журналы устройств, трассировки стека и другую диагностическую информацию, которая поможет вам найти и исправить ошибки в вашем приложении”. С помощью этой функции вы можете фиксировать ошибки непосредственно с устройств или эмуляторов.

Механизм сообщений об ошибках предлагает проверку через ZIP-файл, а конечные пользователи могут использовать отчеты о сбоях Google Play и Firebase, доступные в течение как минимум 6 месяцев с момента их подачи.

Пример баг-репорта в iOS

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

3 образца отчетов об ошибках

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

Далее мы рассмотрим реальные примеры, чтобы понять, как составлять информативные и действенные баг-репорты.

Тайтл: Отсутствует возможность зайти в учетную запись на сайте.
Окружение: Google Chrome, версия 93.0.4577.82.
Шаги воспроизведения:
- Открыть сайт: https://www.example.com.
- Нажать на кнопку “Войти”.
- Ввести правильные учетные данные (имя пользователя: myusername, пароль: mypassword).
- Нажать кнопку “Войти”.
Ожидаемый результат: Происходит вход в свою учетную запись и дальнейший переход на панель управления.
Актуальный результат: После нажатия кнопки “Войти” страница обновляется, но пользователь остается на странице входа в систему. Уведомление об ошибке не отображается.
Дополнительная информация:
- Кэш и файлы куки браузера очищены.
- Данная проблема постоянно возникает как на настольных, так и на мобильных устройствах.

Пример 2: Сбой в работе мобильного приложения

Тайтл: Приложение вылетает при открытии меню настроек.
Окружение: iOS 15.0, iPhone 12 Pro.
Шаги воспроизведения:
- Запустить приложение.
- Нажать на опцию “Настройки” в нижней навигационной панели.
Ожидаемый результат: Меню настроек открывается без каких-либо проблем.
Актуальный результат: При нажатии на опцию “Настройки” приложение сразу же аварийно завершает работу. При перезагрузке телефона проблема сохраняется.
Дополнительная информация:
- Приложение обновлено до последней версии (v2.0.1), но проблема сохраняется.
- Никакие другие части приложения, вероятно, не затронуты; сбой происходит только при входе в меню настроек.

Пример 3: Проблема с отображением сайта

Тайтл: Искажение макета в браузере Firefox.
Окружение: Mozilla Firefox, версия 92.0.
Шаги воспроизведения:
- Открыть сайт: https://www.example-site.com
- Перейти на страницу каталога продукции.
- Прокрутить страницу вниз, чтобы просмотреть список продуктов.
Ожидаемый результат: Список товаров отображается корректно, с равномерным интервалом и изображениями.
Актуальный результат: Изображения товаров перекрывают друг друга, а расстояние между товарами непостоянно. Данная проблема характерна для браузера Firefox; в Chrome и Edge все отображается корректно.
Дополнительная информация:
- Все расширения браузера отключены, но проблема сохраняется.
- Проблема возникает как в версии Firefox для Windows, так и для macOS.
- Проблема появилась после недавнего обновления сайта.

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

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

Что такое ошибка?

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

По сути, программная ошибка – это то, что работает не так, как задумано.

Вы можете задаться вопросом, почему ошибку часто называют багом (от англ. bug — «жук»)? Это отличный вопрос, поскольку термин “баг”, описывающий ошибку или сбой в работе программного обеспечения, появился еще в 1945 году.

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

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

Итак, теоретически, ошибка – это то, что работает не так, как задумано.

Но что, если что-то спроектировано не так, как должно быть? Является ли это ошибкой? Как видите, сам по себе этот вопрос оставляет много возможностей для интерпретации.

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

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

Определение баг-репорта

Вот основной вопрос: что такое баг-репорт?

Если возникает ошибка (а они, безусловно, возникают), то человек, обнаруживший ее, должен иметь возможность сообщить о ней (задокументировать и отправить) тем, кто отвечает за исправление этой ошибки или сбоя.

В идеале, баг-репорт должен объяснять, как именно сломан продукт.

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

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

Почему баг-репорты так важны?

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

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

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

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

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

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

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

Как лучше всего составить баг-репорт

Четко определите проблему

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

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

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

Составляйте отдельные отчеты о каждой ошибке

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

Укажите, как воспроизвести ошибку

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

Отправив баг-репорт, оставайтесь на связи

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

Добавьте соответствующие коды

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

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

Соберите визуальные подтверждения

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

Хороший баг-репорт против плохого

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

Хороший баг-репорт:

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

Плохой баг-репорт:

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

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

Заголовки issues на странице обратной связи на сайте

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

После устранения ошибки ваша компания должна вернуться к заказчику и сказать: “Мы вас услышали, вот наше решение вашей проблемы!”. Признание проблемы клиента в значительной степени способствует тому, что он остается довольным и вовлеченным.

Как написать хороший баг-репорт

Создание отчета об ошибке означает создание отчета, в котором рассказывается о характеристиках и поведении конкретной ошибки.

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

После тестирования команда по обеспечению качества должна быть в состоянии ответить на следующие вопросы:

Как ошибка влияет на работу программы?
Что является причиной проявления ошибки?
На каком этапе работы приложения возникает ошибка?

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

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

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

Основные шаги написания действенного баг-репорта

Четкий и описательный тайтл. Тайтл должен кратко описывать проблему. Хороший тайтл должен быть конкретным, указывающим на суть проблемы или ее местонахождение.
Предоставьте подробную информацию о среде. Укажите версию программного обеспечения, операционную систему, браузер или используемое устройство. Также укажите все необходимые параметры конфигурации.
Шаги для воспроизведения. Перечислите пошаговые инструкции по воспроизведению проблемы. Будьте точны и укажите все необходимые действия, нажатия или вводы.
Ожидаемые и фактические результаты. Четко укажите ожидаемое поведение программы. Опишите, что произошло на самом деле, включая сообщения об ошибках.
Приложите скриншоты или медиафайлы. При необходимости приложите скриншоты, изображения или видеоролики, иллюстрирующие проблему. Визуальные средства могут оказать неоценимую помощь в понимании сложных проблем.
Приведите дополнительный контекст. Упомяните необычные обстоятельства или соответствующую справочную информацию. Укажите частоту возникновения проблемы (всегда, время от времени и т.д.).
Проверка на наличие дубликатов. Прежде чем отправлять сообщение, проведите поиск по существующим базам данных ошибок, чтобы убедиться, что об этой проблеме уже не сообщалось ранее. Если такой отчет уже был, добавьте в него свои замечания.
Используйте стандартный формат. Если в вашей организации или проекте используется определенный шаблон отчета об ошибке, следуйте ему. Последовательность в составлении отчетов помогает оптимизировать процесс отладки.
Будьте вежливы и профессиональны. Поддерживайте уважительный тон в своем сообщении. Помните, что разработчики и служба поддержки стараются помочь решить проблему.
Протестируйте и проверьте. После устранения проблемы протестируйте ее еще раз, чтобы убедиться в том, что проблема решена. Предоставьте обратную связь о решении проблемы, чтобы замкнуть цикл.

Следуя этим рекомендациям, вы поспособствуете более эффективному и совместному процессу исправления ошибок.

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

Какие шаги следует предпринять для улучшения отчета об ошибке?

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

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

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

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

Система сообщений об ошибках
Программное обеспечение для отслеживания ошибок
Программное обеспечение для отслеживания проблем
Программное обеспечение для управления проблемами
Система отслеживания дефектов

Независимо от того, какое название вы предпочитаете, баг-трекинговая система – это приложение, которое отслеживает отчеты об ошибках в программном обеспечении.

Инструменты для отслеживания ошибок

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

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

Какие же есть программы для создания отчетов об ошибках?

Существует большое количество разнообразных инструментов для отслеживания ошибок. Они могут называться по-разному: Defect tracking software, Bug reporter, Testing tools, Bug tracker, Issue tracker, Bug tracking tool, Defect tracker, Bug tracking software и т.п.

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

Ознакомимся с некоторыми лучшими инструментами для создания отчетов об ошибках:

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

Заключение

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

Процесс работы над ошибками: найти, задокументировать, воспроизвести, исправить.

Перевод статьи «What Is A Bug Report? The Essential Guide + Examples».