Сообщение об ошибках является неотъемлемой частью процесса тестирования. Каждый раз, когда тестировщик обнаруживает дефекты в программном обеспечении, его обязательство состоит в том, чтобы сообщить о них разработчикам. Однако, чтобы сообщение было максимально полезным и эффективным, необходимо придерживаться определенных практик.
В этой статье мануальный тестировщик ИТ-компании BSL — Никита, поделился советами и рекомендациями по эффективному сообщению об ошибках, основанными на личном опыте работы, и объяснил, почему эти практики важны.
1. Будьте конкретными:
Опишите ошибку с точностью и детализацией, даже если вам кажется, что некоторые аспекты интуитивно понятны. Помните, что у каждого разработчика и других заинтересованных сторон может быть свой опыт и представление о том, как должна работать функциональность. Поэтому лучше описать ошибку более подробно, чтобы предоставить разработчикам все необходимые сведения. Следуйте четким требованиям и спецификациям, а не только своему личному представлению о том, как должно быть. Это поможет избежать недоразумений и сделать отчет об ошибке более эффективным.
Плохое описание ошибки: «Не оформляется заказ. Нужно исправить.»
Комментарий: Этот отчет слишком общий и не содержит достаточно информации о том как воспроизвести ошибку.
Пример хорошего отчета: «При попытке оформить заказ, после заполнения всех обязательных полей и нажатия кнопки 'Оформить заказ', ничего не происходит. Ошибка проявляется на странице оформления заказа.»
2. Приложите скриншоты, видео, макеты и документацию:
Визуальные материалы, такие как скриншоты или видеозаписи, могут быть крайне полезными для наглядного демонстрирования ошибки. Приложение макетов или прототипов также может помочь разработчикам лучше понять ожидаемый результат и контекст, в котором возникла ошибка. Кроме того, прикрепление документации с описанием API методов или других взаимодействий с бэкендом может быть важным дополнением, особенно для сложных систем. Помните, что цель состоит в том, чтобы предоставить максимально возможную информацию, которая поможет разработчикам более точно воспроизвести и исправить ошибку.
Плохое описание ошибки: «Ошибка 500.»
Комментарий: Отсутствие визуальных материалов и документации. Отчет выше не подкреплен скриншотами, видео или другими визуальными материалами, которые могут помочь разработчикам понять проблему. Также отсутствует документация с API методами или другой важной информацией.
Пример хорошего отчета: «При отправке запроса на метод 'POST /api/orders' с валидными данными, получаю ответ с кодом ошибки 500. Ссылка на документацию.»
3. Избегайте общих фраз:
Старайтесь избегать общих и расплывчатых выражений в описании ошибки. Вместо этого, используйте точные термины, чтобы описать проблему. Узнайте названия элементов пользовательского интерфейса (UI) на странице и элементов бэкенда, чтобы точно указать, с какими компонентами связана ошибка. Например, вместо «программа работает не так, как ожидалось», укажите конкретные названия полей, кнопок, функций или API-методов, которые вызывают проблему. Это поможет разработчикам легче понять контекст ошибки и быстрее внести необходимые исправления.
Плохое описание ошибки: «Программа работает не так, как ожидалось. Что-то не так с функциональностью.»
Комментарий: Этот отчет не уточняет конкретные названия элементов UI или бэкенда, связанных с ошибкой. Он содержит общие и расплывчатые выражения, которые могут затруднить разработчикам понимание проблемы.
Пример хорошего отчета: «При попытке сохранить изменения в профиле пользователя, после заполнения полей 'Имя' и 'Фамилия', кнопка 'Сохранить' остается неактивной. Ошибка возникает на странице редактирования профиля (URL: /profile/edit) и связана с некорректной валидацией данных. Конкретные UI элементы, связанные с проблемой, включают текстовые поля 'Имя' и 'Фамилия' и кнопку 'Сохранить'.»
4. Укажите окружение и версию:
Указывайте информацию об окружении, такую как операционная система, браузер или устройство, на котором воспроизводится ошибка. Особое внимание уделите указанию названия модели устройства, версии операционной системы, а также версии оболочки Android, если это применимо. Часто новички в тестировании пренебрегают этой информацией, что может затруднить разработчикам воспроизведение и исправление ошибки. Уточняйте названия и версии, чтобы помочь разработчикам точно определить контекст проблемы и ускорить процесс ее исправления.
Плохое описание ошибки: «Ошибка на веб-странице.»
Комментарий: Этот отчет не указывает информацию об операционной системе, модели устройства или версии ПО. Отсутствие этих данных может затруднить разработчикам воспроизведение и исправление ошибки.
Пример хорошего отчета: «При использовании Google Chrome версии 80 на операционной системе Windows 10, при нажатии кнопки 'Отправить' на веб-странице возникает ошибка 500 Internal Server Error.»
5. Будьте краткими:
При написании отчета об ошибке старайтесь быть краткими и лаконичными. Помните, что краткость — сестра таланта. Сфокусируйтесь на ключевых аспектах ошибки и избегайте излишнего многословия. Сократите ненужные детали и лишние объяснения, чтобы сосредоточиться на самой сути проблемы. Краткое и содержательное сообщение об ошибке будет легче восприниматься разработчиками и способствует более быстрому решению проблемы.
Плохое описание ошибки: «В процессе тестирования было обнаружено небольшое несоответствие в функциональности. При выполнении определенных действий на странице оформления заказа, пользователю отображается сообщение об ошибке, которое гласит: 'Произошла ошибка в системе. Пожалуйста, попробуйте еще раз или обратитесь в службу поддержки.' Это сообщение не ясно объясняет причину ошибки и не предоставляет пользователю никакой информации для дальнейших действий. Эта проблема проявляется в различных сценариях, когда пользователь выбирает определенные опции и заполняет определенные поля. Необходимо улучшить сообщение об ошибке и предоставить более конкретные указания для пользователя.»
Комментарий: Слишком много информации. Этот отчет можно и нужно сократить.
Пример хорошего отчета: «При оформлении заказа и выборе доставки 'Экспресс' на странице подтверждения заказа появляется неинформативное сообщение об ошибке.»
6. Предложите возможное решение:
В дополнение к описанию ошибки и ее воздействия, попытайтесь предложить возможное решение проблемы. На основе вашего опыта и знаний о системе, вы можете предложить идеи или подходы, которые могут помочь в исправлении ошибки. Это позволит разработчикам лучше понять вашу точку зрения и может ускорить процесс устранения проблемы.
Плохое описание ошибки: «Нужно починить функцию поиска.»
Хороший отчет: "При использовании функции поиска на сайте с большим количеством товаров, результаты поиска не отображаются до конца. Возможное решение — оптимизировать алгоритм поиска и пагинацию результатов для обеспечения полного и корректного отображения найденных товаров."
Заключение:
Эффективное сообщение об ошибках является критическим элементом успешного тестирования. Четкие и действенные отчеты об ошибках помогают разработчикам быстро и точно устранять проблемы. Используйте эти советы и рекомендации, чтобы улучшить качество ваших отчетов об ошибках и внести больший вклад в процесс разработки программного обеспечения.