Требования к отчётам о баге | Bug Report Requirements
В этой статье вы узнаете, как правильно документировать баг в соответствии с нашими правилами и стандартами. Для того чтобы понять баг, клиентам нужна достаточная информация в определенном качестве.
После нахождения формы отправки сообщения об ошибке необходимо выбрать нужную функцию. Убедитесь, что в первом раскрывающемся списке отображается функция, для которой вы хотите отправить сообщение об ошибке. Если вы не можете найти нужную функцию, вернитесь на страницу обзора тестирования и подтвердите правильность выбора.
Форма оформления бага
Вся форма ошибки теперь будет вам видна и выглядеть как для функционального типа ошибки:
В следующих разделах мы рассмотрим каждое поле и подробно объясним, что и как следует вводить.
Серьёзность
Для типа ошибки "Functional", вы увидите дополнительную опцию под названием "Severity" с кнопками от 1 до 3: Низкая, высокая и/или критическая. Серьезность указывает на срочность вашего сообщения. Она состоит из множества факторов. Чтобы выбрать соответствующую серьезность вашей ошибки, посетите нашу отдельную статью Функциональные ошибки.
Поле "Severity" не будет отображаться при выборе типов ошибок, отличающихся от "Functional".
Название
Заголовок отчета о баге должен обобщать проблему, чтобы читатель мог получить общее представление о баге, просто прочитав заголовок ошибки. Им не нужно читать весь отчет, чтобы понять, в чем проблема.
Таким образом, названия должны быть точными и не слишком длинными одновременно. Он должен содержать соответствующий элемент (например, поле поиска), функциональность которого нарушена, и источник.
Опишите, что происходит, а не то, что не происходит. Ваш заголовок никогда не должен указывать, что что-то не работает, в противном случае читатель не знает, что на самом деле происходит. Названия не должны быть абстрактными.
Названия должны отражать реальную проблему. Если ошибка возникает только при определенном условии, условие должно быть включено в заголовок ошибки. Если, например, вы не можете забронировать билет, когда заявляете, что вы подросток, это важная информация, которая должна быть указана.
Чтобы придумать описательный заголовок, поставьте себя на место того, кто не тестировал веб-сайт или приложение, кто не может представить, на какой странице вы были, как она выглядит и что вы делали. Прочитайте свой заголовок с точки зрения этого человека и подумайте, поймете ли вы ошибку. Если вы не получили хорошего представления об ошибке, измените название бага и повторите процесс.
Примерные заголовки ошибок
Неправильно: поиск не работает
Правильно: Поиск не запускается при нажатии кнопки поиска - только после нажатия клавиши ввода
Неправильно: метод сортировки X не работает должным образом
Правильно: при настройке метода сортировки X на странице Y продукты не меняют порядок. Никаких изменений не видно.
Проблемы обоих заголовков. Существует много возможных сценариев, в которых этот заголовок подходит. Они слишком абстрактны. Читатель не знает, что вы сделали и как реагирует страница. Тестеры вынуждены читать весь отчет, чтобы понять, в чем заключается ошибка. Другие тестеры не могут отличить эту ошибку от других, что увеличивает вероятность того, что будут отправлены дубликаты отчетов об ошибках.
URL-адрес
Посетите страницу до появления ошибки и скопируйте и вставьте URL из поля URL вашего браузера в поле URL формы отчета об ошибке.
URL-адрес должен быть полным, чтобы он перенаправлял к правильному месту назначения.
Если вы тестируете приложение, оставьте это поле пустым, если в описании теста или в тестовом чате не указано иное.
Шаги для воспроизведения
Баги должны быть воспроизводимыми, и к ним необходимо приложить подробное пошаговое руководство о том, как их возможно воспроизвести. Каждый шаг описывает ваши действия. (Обратите внимание, что вам не нужно нумеровать свои шаги, так как наша система делает это автоматически.)
Первый шаг должен содержать URL-адрес, если вы тестируете веб-сайт, или имя приложения, если вы тестируете мобильное приложение. Затем введите все шаги, которые вы предприняли - какие кнопки вы нажимаете, по каким ссылкам переходите и что вводите. Ваш последний шаг должен описать действие, которое вы выполняете, которое вызывает ошибку.
Ваши шаги должны быть максимально общими. Только если ваш баг возникает при определенных условиях, например только для конкретной страницы обзора продукта, для конкретного фильтра, для конкретного вводимого вами имени, назовите это условие в ваших шагах. Например, не объясняйте, что вы посетили страницу обзора конкретного продукта, затем страницу сведений о конкретном продукте и добавили этот продукт в корзину, если проблема возникает для какого-либо товара. Это поможет читателю понять идею вашей ошибки, и они не будут отвлекаться на несущественные детали.
Если вы должны быть конкретны, например, когда вас попросят задокументировать, какие учетные данные вы использовали для входа в свою учетную запись пользователя, используйте имена, которые являются реальными словами, а не просто ломайте клавиатуру. Плохим примером будет «asdlkfgjasdfkg lajsdhjasd», поскольку это не выглядит профессионально для наших клиентов.
Примеры шагов:
- Перейти на http://www.examplewebsite.com
- Введите любой поисковый запрос в верхнюю правую строку поиска (например, «Сан-Франциско»).
- Нажмите «Искать сейчас» или нажмите клавишу ввода
Ожидаемый результат
Опишите, что вы ожидаете после выполнения вашего последнего шага.
Как всегда, детали являются ключом.
Подумайте, что должно было случиться, если бы вы не нашли свою ошибку, поэтому, если все будет работать правильно.
Пример ожидаемого результата:
Неправильно: функция поиска по названию города работает.
Правильно: После ввода названия города "Сан-Франциско", я ожидаю, что в Сан-Франциско появятся доступные отели. Если таких гостиниц нет, должно появиться сообщение, например, "В вашем городе нет свободных гостиниц".
Фактический результат
Фактический результат - одно из самых важных полей отчета о баге, потому что здесь вы объясняете, в чем проблема, и даёте всю дополнительную информацию, необходимую для понимания ошибки.
Что на самом деле происходит после выполнения вашего пошагового руководства, должно быть подробно описано. Будьте очень точным. Не будьте слишком общими, например, говорят, что продукты остаются в основном в том же порядке после применения метода сортировки X, но приводим конкретные примеры того, что продукты не в порядке.
Добавьте в это поле любую информацию, относящуюся к ошибке: примеры, дополнительные условия или исключения. Просто убедитесь, что структурировали свою информацию, чтобы помочь читателю понять ваш мыслительный процесс.
Важное примечание: фактические и ожидаемые результаты не должны быть полностью противоположными друг другу, и содержать в себе полностью скопированный текст одно другого
Неправильно: функция поиска по названию города не работает.
Правильно: После нажатия на кнопку "Искать сейчас" ничего не происходит. На новой странице браузера не отображаются результаты поиска и пользователь не получает никаких сообщений или уведомлений о том, что произошло. Кнопка "Искать сейчас" не имеет никакой функции.
Тег
С этого момента вы можете оставить это поле пустым. Это устаревшая функция, которую мы в настоящее время не используем. Он может быть удален в будущем, или мы реализуем его по-другому.
Приложения
Для каждого сообщения об ошибке должно быть загружено как минимум одно вложение.
Используемая среда
Для нас и наших клиентов очень важно знать, на каком устройстве вы обнаружили ошибку. Для проверки веб-сайта щелкните значок браузера рядом с используемым устройством. Для тестирования мобильного приложения выберите устройство, на котором установлено приложение.
Вы можете использовать устройства только для тестирования тестовой среды, которые перечислены в этом разделе. Устройство, браузер и/или операционная система должны соответствовать устройству, отображаемому на вложениях.
Убедитесь, что вы выбрали правильную среду в процессе подачи заявки, потому что это единственная часть информации, которая не может быть изменена впоследствии - ни вашим руководителем, ни руководителем группы. К сожалению, ваш отчет должен быть отклонен, если вы выбрали неправильную среду, но вы можете повторно отправить сообщение об ошибке, если тест все еще выполняется и если ни один другой тестер уже не отправил сообщение об ошибке должным образом за это время.
Вы хотите протестировать устройство, которое не может быть добавлено в ваш профиль? Отправьте нам запрос через чат поддержки, и мы проверим, подходит ли ваше устройство для наших клиентов.
Примечание: Когда вы удаляете устройство из списка приглашенных устройств в профиле тестера, вы больше не можете отправлять отчеты в этом тесте. Раздел "Окружающая среда" формы об ошибке будет пустым, и форма не может быть отправлена. Удаление устройства из профиля не может быть отменено!
Прямое правило отказа
Пожалуйста, уделите достаточно времени документированию своих ошибок, потому что руководители команды не улучшат ваши сообщения об ошибках для достижения требуемого уровня качества; ваша работа - предоставляет достаточно информации. Если вы больше не являетесь тестировщиком, руководители команды должны будут прямо отклонить сообщения об ошибках, если один или несколько из следующих случаев верны для вашего сообщения об ошибках:
• Несколько грамматических ошибок (не только опечатка)
• Повторный неправильный выбор функций
• Общее описание сообщения об ошибке непонятно
• Неясное название сообщения об ошибке
• Пропущенные важные шаги
• Тестер явно не прочитал или не следует инструкциям по тестированию.
• Непоследовательные данные - когда расхождение между шагами и скринкастом слишком велико.
• Неполные доказательства, такие как отсутствие вложений, включая недостающие журналы регистрации дорожно-транспортных происшествий.
Если одно из ваших сообщений об ошибке было отклонено из-за недостаточного качества, вы можете отправить его снова с надлежащим качеством, если только другой тестер уже не сделал этого в это же время.