July 10, 2021

Написание отчета

ВАЖНО! Отчет нужно писать на том языке страны, которую вы указали при регистрации (Великобритания - Английский, Германия - немецкий и тп)

Чтобы приступить к написанию отчета, нужно перейти во вкладку Report Issue в правом верхнем углу:

1. Заголовок ошибки

В курсах Академии, так же как и в платных заказах, расписывают как должен выглядеть заголовок:

Формат заголовка в Академии должен выглядеть следующим образом:

Устройство – Область ошибки – Краткое описание ошибки

  • Устройство - это устройство, на котором была найдена ошибка:

Для ПК указывается операционная система, которая установлена на вашем устройстве, например:

  • Windows 7
  • Windows 10
  • macOS 11.4

Для ошибки найденной на мобильном устройстве, следует указать модель телефона/планшета, например:

  • iPhone XR
  • Samsung galaxy a50
  • iPad Pro (2020)
  • Область ошибки

Здесь вам нужно указать место, где вы нашли ошибку.

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

  • Главная страница
  • Поиск
  • Footer (нижняя часть страницы сайта, чаще всего обозначенная другим цветом)
  • Каталог товаров
  • Краткое описание ошибки

Здесь вам необходимо, как можно короче объяснить в чем заключается ошибка, например:

  • При нажатии на кнопку "Информация о доставке" ничего не происходит
  • При нажатии на кнопку "Кроссовки" страница не открывается
  • Во вкладке "Посуда" не воспроизводится видео

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

Примеры правильных заголовков:

  • Windows 10 - Product Recall - "Zulily blog" redirects to a site that does not exist
  • Windows 7 - Investors - "SAFETY RECALL INFORMATION" button directs to an undiscovered page
  • iPhone XR - Most popular - Endless loading
  • Samsung galaxy A50 - Slime Recipes - Button takes you to a page that doesn't exist

2. Тип ошибки

Далее вам нужно будет указать тип ошибки:

3. Частота появления ошибки

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

4. Приоритет ошибки

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

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

Если не уверены, какой приоритет выбрать - обратитесь к куратору.

5. Устройство

Здесь вам нужно указать с какого устройства происходило тестирование, а так же браузер, который вы использовали:

6. Описание пошагового выполнения ошибки

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

Первым шагом всегда указывается сайт/приложение, которое вы тестировали!

Правильно расписанные шаги будут выглядеть так:

  1. Открыть ссылку www.тестируемый_сайт.com
  2. Пролистать в самый низ страницы
  3. Нажать кнопку "Learn more"
  4. Пролистать в самый низ страницы
  5. Нажать кнопку "Resources"

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

Пример шагов:

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

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

  • Не объединяйте несколько действий в одно
  • Записывайте каждый шаг с большой буквы
  • Каждый шаг должен быть описывать конечное действие
  • Не используйте слова: найти, обнаружить, проверить, посмотреть, и т.д.
  • После нумерация каждого шага ставьте пробел
  • При тестировании с компьютера используйте слово Click, вместо слова Press, tap и тп. (Click on button)
  • При тестировании с телефона используйте слово Tap, вместо слова click, press и тп. (Tap on button)

Примеры правильно описанных шагов:

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

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

Например, если пользователь нажимает на кнопку "About Us" и дальше ничего не происходит, то можно предположить, что пользователь хотел получить необходимую информацию о компании.

Примеры правильно оформленных ожидаемых результатов:

  • При нажатии на кнопку "About Us" пользователь хочет получить необходимую информацию о компании.
  • При нажатии на изображение пользователь должен увидеть как должен выглядеть товар.
  • При нажатии на кнопку "Create account" пользователь должен иметь возможность зарегистрировать аккаунт.

8. Текущий результат

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

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

Примеры правильно оформленных текущих результатов:

  • При нажатии на кнопку «About Us» ничего не происходит и пользователь не может получить необходимую информацию
  • При нажатии на изображение пользователь не может увидеть товар потому что изображение не открывается
  • При нажатии на кнопку «Create account» пользователь не может зарегистрировать аккаунт

9. Сообщение ошибки

Данное поле заполняется только в том случае, если при возникновении ошибки вам показывается код ошибки/наименование ошибки/текст ошибки (например ошибка 404, page not found и т.д.). Во всех остальных случаях оставляем поле пустым.

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

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

11. Вложения

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

Для скриншотов:

  • Скриншоты должны иметь формат .png или .jpg.
  • На скриншоте должна быть видна адресная строка тестируемого сайта.
  • На скриншоте не должно быть видно значка VPN.
  • На скриншоте должна быть выделена область, где происходит ошибка

Правильно сделанный скриншот:

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

Для видео:

  • Видео не должно весить больше 15 Мб.
  • Видео должно иметь формат .mp4.
  • На видео не должно быть звука.
  • На видео не должно быть видно значка VPN.
  • На видео должны быть проделаны все шаги, которые приводят к ошибке, начиная от захода на сайт, заканчивая получением ошибки.

Для логов:

  • Логи должны иметь формат .txt
  • Для компьютерной Академии логи должны начинаться со строки navigate to www.тестируемый_сайт.com

Для логов Charles:

  • Логи должны иметь формат .chls
  • Логи не должны содержать сайтов, которые оканчиваются на .ru
  • Логи не должны содержать "битых" сайтов, изображений (помечены красным крестиком)
  • Логи не должны содержать приложений или сайтов, которыми пользуются только/преимущественно в СНГ, например www.vk.com

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

В первой Академии логи не нужны!

Дополнительные поля

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

Для Android:

  • Если вы тестировали сайт, то нужно будет указать "Chrome Developer Tools"
  • Если вы тестировали приложение, то нужно будет указать "ADB Logcat"

Для iOS:

  • Как для приложений, так и для сайтов указываем "iMazing"

Иногда будет появляться поле, в котором вам нужно будет указать версии тестируемого приложения/сайта:

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