Перейти до основного контенту

Вкладені файли звіту про помилку

Що потрібно додати, надсилаючи звіт про помилку?

Kostya avatar
Автор: Kostya
Оновлено протягом останнього тижня

Кожен баг має бути задокументований щонайменше одним вкладенням. За допомогою вкладення(нь) ви надаєте доказ того, що баг виникає на вашому пристрої, операційній системі та/або в браузері.

Примітка: вкладення НЕ замінюють письмову інформацію у вашому звіті. Вони є візуалізацією проблеми та підтвердженням її існування.

Скріншот чи скрінкаст?

Загалом, для функціональних багів потрібен скрінкаст, щоб їх правильно та ефективно показати. Якщо інструкції або керівник команди не вимагають певних вкладень, користуйтеся таким простим правилом, щоб визначити, чи потрібен скріншот чи скрінкаст для вашого бага:

  • Щоразу, коли для виклику помилки потрібна дія або потрібно показати процес, завантажуйте відеозапис екрану (скрінкаст). Знімки екрана у вигляді статичних зображень є лише моментальними кадрами і не можуть показати справжню причину проблеми. З цієї причини для функціональних помилок завжди потрібен скрінкаст.

  • Якщо природа помилки статична, наприклад, проблеми зі статичним інтерфейсом користувача (GUI), достатньо зробити знімок екрана, який навіть буде кращим за відео для візуалізації. Знімки екрана зазвичай достатні для проблем, пов’язаних з контентом або візуальними помилками.

Основні вимоги до додатків

  • Нові додатки мають створюватися для кожного звіту про помилку або відтворення окремо.

  • Заборонено копіювати додатки з інших звітів про помилки або відтворень.

  • Додатки повинні містити всю релевантну інформацію про помилку, щоб слугувати доказом.

  • Вся важлива інформація має бути англійською мовою (або за бажанням німецькою, якщо звіт написаний німецькою), наприклад дата, час, системна інформація та повідомлення про помилки.

  • При звітуванні потрібно обирати лише один пристрій або браузер і завантажувати додаток саме для нього. Якщо помилку вдається відтворити на інших пристроях чи браузерах, вкажіть це у полі "Фактичний результат".

  • Не показуйте інформацію, яка може стосуватися інших клієнтів Test IO (наприклад, листи-запрошення або назви вкладок браузера). Показувати встановлені додатки інших клієнтів дозволено.

  • Не демонструйте особисту інформацію чи непрофесійні дані, такі як фото, відео або підказки автокорекції із помилками. Пам’ятайте, що ваші додатки будуть доступні іншим тестерам, співробітникам Test IO та клієнтам, тож будьте уважні до того, що ви показуєте.

  • Для тестів вебсайтів поле з URL має бути видно на додатках.

  • Роздільна здатність має бути достатньо високою, щоб текст і елементи було легко розпізнати.

  • Завжди записуйте весь екран.

  • Для звітів про помилки та позитивних відтворень аварій додаток з журналом помилок (збоїв) є обов’язковим. Відео, яке документує аварію, має відповідати доданому журналу — таймінги мають співпадати.

Правила щодо дати й часу:

  • Поточна дата і час повинні бути видні у вкладених файлах.

  • При підтвердженні помилки за допомогою скріншоту на мобільному пристрої потрібно додати другий скріншот із датою та часом (рівень заряду батареї і час мають відповідати першому скріншоту).

  • Дата може бути у будь-якому поширеному форматі, наприклад DD/MM або MM/DD, англійською (або за бажанням німецькою, якщо мова звіту про помилку — німецька).

  • Час повинен бути у 24-годинному форматі, або якщо ви використовуєте 12-годинний формат, обов’язково зазначте AM/PM.

Відображення поточної дати на вкладенні підтверджує, що запис був зроблений саме в цей день. Наведений нижче список пропонує, де знайти дату:

  • Windows: Відображення панелі завдань або в календарі

  • Mac: Відображення піктограми календаря на панелі Dock або панелі меню

  • iOS & Android: Проведіть пальцем вниз по центру сповіщень на початку запису.

Додаткова інформація: How-to-Geek.

Що потрібно включити в скріншот?

Правила для скріншотів:

  • Скріншот має бути у форматі JPG або PNG.

  • Виділіть помилку на скріншоті.

Ми рекомендуємо інструменти для запису та передові практики в такій статті: Скріншоти

Також можна подивитися найпоширеніші помилки в додатках у статті «Поширені помилки у вкладеннях»

Що потрібно включити в скрінкаст?

Відеозаписи екрану (скрінкасти) мають бути якомога коротшими, але достатньо тривалими, щоб показати проблему. Це означає, що варто пропускати кроки, які не викликають помилку. Наприклад, якщо кнопка «Додати в кошик» на сторінці товару в інтернет-магазині працює неправильно, зазвичай не має значення, як саме ви потрапили на цю сторінку. Важливими є останній крок навігації, крок, який викликає помилку, і сама помилка.

Приклад 1: Помилка на веб-сайті, перевірено на настільному пристрої

Кроки для створення скрінкасту:

  1. Перейдіть на сторінку, де сталася помилка.

  2. Почніть запис.

  3. Оновіть сторінку.

  4. Виконайте дію, яка викликає помилку.

  5. Дочекайтеся появи помилки.

  6. Зупиніть запис.

Приклад 2: Помилка в додатку, перевірено на мобільному пристрої

Кроки для створення скрінкасту:

  1. Запустіть програму та перейдіть на сторінку, де потрібен лише один навігаційний крок, щоб перейти до сторінки, де сталася помилка.

  2. Почніть запис.

  3. Проведіть пальцем вниз по центру сповіщень, щоб на пару секунд відобразити поточну дату.

  4. Виконайте останній крок навігації, щоб перейти на потрібну сторінку.

  5. Виконайте дію, яка викликає помилку.

  6. Дочекайтеся появи помилки.

  7. Зупиніть запис.

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

Правила для скрінкастів:

  • Скрінкасти повинні бути у форматі файлу MP4.

  • Максимальний розмір вкладення — 25 МБ.

  • Максимальна тривалість скрінкаста для звітів про баги — 60 секунд, якщо лише ваш баг не потребує демонстрації процесу завантаження або тривалого ручного вводу.

  • Максимальна тривалість скрінкаста для відтворень і користувацьких історій — 15 секунд, оскільки потрібно показати лише останню дію, що викликала баг.

  • Ваші кліки, натискання та курсор миші мають бути видимі (це обов’язково для записів з Android та десктопів).

  • Записуйте відео одним дублем. Не можна ставити запис на паузу чи вирізати частини посередині. Якщо ваш скрінкаст вийшов надто довгим і потребує редагування, дозволяється обрізати лише початок або кінець файлу.

  • Прискорення відео заборонене. Якщо запис вийшов довшим за дозволений час, перевірте, чи не показали ви зайві кроки.

  • Не записуйте жодних звуків (крики дітей, розмови, телевізор, музика, звуки тварин тощо).

Рекомендуємо ознайомитись з інструментами запису і найкращими практиками у статті: Скрінкасти


Поширені помилки з вкладеннями описані у статті: Поширені помилки у вкладеннях

Спеціальні правила скрінкасту для потокових (Streaming) пристроїв:

  • Завжди записуйте весь екран телевізора.

  • Скрінкаст має бути у високій роздільній здатності та хорошої якості.

  • Освітлення в кімнаті не повинно бути надто темним.

  • Пульт від телевізора має бути видно на скрінкасті. Він має бути повністю та чітко в кадрі.

  • У вкладенні обов’язково має бути відображена поточна дата й час. Ви можете показати їх безпосередньо на телевізорі або на зовнішньому пристрої — комп’ютері, телефоні чи планшеті.

  • Для звітів про помилки максимальна тривалість відео — 60 секунд, а для відтворень помилок та User Story — 15 секунд.

  • Не записуйте фонові шуми (дитячий плач, розмови, телевізор, музику, домашніх тварин тощо).

  • Скрінкаст має виглядати професійно — не знімайте свої ноги, безлад під телевізором чи подібне.

Як записати скрінкаст для клавіатурних багів

Іноді під час взаємодії з вебсайтами за допомогою клавіш клавіатури комп’ютера виникають баги.

У таких випадках, оскільки ми повинні показати дію, яка спричиняє помилку на скрінкасті, відображення введення з клавіатури є обов’язковим.

Ось чудовий приклад того, як створити скрінкаст з показом натискань клавіш:

Універсальні вимоги до скрінкастів для всіх пристроїв

Розмивання особистої інформації у вкладеннях

Щоб захистити вашу особисту інформацію, таку як закладки, імена облікових записів або збережені електронні адреси, від відображення на вкладках браузера, ви можете скористатися простим способом — розмиттям цієї інформації. Однак для ефективнішого процесу створення звітів про помилки рекомендується використовувати окреме вікно браузера спеціально для тестування, як показано в прикладі нижче, де немає зайвих відкритих вкладок або видимих закладок.

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

Важливо, щоб URL залишався видимим, а елементи сайту не були закриті.

З професійних причин важливо уникати приховування інформації на вкладеннях за допомогою намальованих вручну або начеркових методів, як показано в прикладі нижче:

Ви отримали відповідь на своє запитання?