how write good bug report
Чому хороший звіт про помилки?
Якщо ваш звіт про помилки ефективний, то його шанси виправити вищі. Отже, виправлення помилки залежить від того, наскільки ефективно ви повідомляєте про неї. Повідомлення про помилку - це не що інше, як вміння, і я поясню, як цього досягти.
«Сенс написання звіту про проблему (звіту про помилку) полягає у виправленні помилок» - Джем Канер. Якщо тестер не повідомляє про помилку належним чином, програміст, швидше за все, відхилить цю помилку, визначивши її невідтворюваною.
Це може нашкодити випробувачам морально, а іноді і его. (Я пропоную не зберігати будь-який тип его. Его нагадує 'Я повідомив про помилку правильно', 'Я можу її відтворити', 'Чому він / вона відхилила помилку?', 'Це не моя вина' тощо). ,).
Що ви дізнаєтесь:
реалізація двійкового дерева пошуку c ++
- Які якості хорошого звіту про помилки програмного забезпечення?
- Ефективне повідомлення про помилки
- Як повідомити про помилку?
- Важливі функції у звіті про помилки
- Деякі бонусні поради щодо створення хорошого звіту про помилки
- Висновок
- Рекомендована література
Які якості хорошого звіту про помилки програмного забезпечення?
Будь-хто може написати звіт про помилку. Але не кожен може написати ефективний звіт про помилки.
Ви повинні розрізняти середній звіт про помилку та хороший звіт про помилку. Як відрізнити хороший та поганий звіт про помилки? Це дуже просто, застосовуйте наступні характеристики та методи, щоб повідомити про помилку.
Характеристики та методи включають
# 1) Маючи чітко вказаний номер помилки: Завжди призначайте унікальний номер кожному звіту про помилку. Це, в свою чергу, допоможе вам ідентифікувати запис про помилку. Якщо ви використовуєте будь-який автоматизований засіб звітності про помилки, тоді цей унікальний номер буде генеруватися автоматично кожного разу, коли ви повідомляєте про помилку.
Зверніть увагу на номер та короткий опис кожної помилки, про яку ви повідомили.
# 2) Відтворюється: Якщо ваша помилка не відтворюється, вона ніколи не буде виправлена.
Слід чітко згадати кроки щодо відтворення помилки. Не приймайте і не пропускайте жодного кроку відтворення. Помилку, описану поетапно, легко відтворити та виправити.
# 3) Будьте конкретні: Не пишіть есе про проблему.
Будьте конкретні та суть. Спробуйте коротко узагальнити проблему як мінімум словами, але ефективно. Не поєднуйте кілька проблем, навіть якщо вони здаються схожими. Напишіть різні звіти щодо кожної проблеми.
Ефективне повідомлення про помилки
Повідомлення про помилки є важливим аспектом тестування програмного забезпечення. Ефективний звіт про помилки добре спілкується з командою розробників та дозволяє уникнути плутанини або помилок.
Повинен бути хороший звіт про помилки чіткий і лаконічний без будь-яких відсутніх ключових моментів. Будь-яка відсутність ясності призводить до непорозуміння і також уповільнює процес розвитку. Написання та звітування про дефекти - одна з найважливіших, але нехтуваних сфер життєвого циклу тестування.
Гарне письмо дуже важливо для подання помилки. Найважливіший момент, який повинен мати на увазі тестер не використовувати командний тон у звіті. Це порушує моральний дух і створює нездорові робочі стосунки. Використовуйте сугестивний тон.
Не припускайте що розробник припустився помилки і, отже, ви можете використовувати грубі слова. Перед звітуванням не менш важливо перевірити, чи повідомлялося про ту саму помилку чи ні.
Повторена помилка є тягарем у циклі тестування. Перевірте весь список відомих помилок. Іноді розробники могли знати проблему та ігнорувати її для майбутнього випуску. Також можуть бути використані такі інструменти, як Bugzilla, яка автоматично шукає повторювані помилки. Однак найкраще вручну шукати будь-які повторювані помилки.
Інформація про імпорт, яку повинен повідомляти звіт про помилку 'Як?' і де?' Звіт повинен чітко відповідати, як було проведено випробування та де саме стався дефект. Читач повинен легко відтворити помилку та знайти, де вона є.
Майте на увазі, що мета написання звіту про помилки полягає у наданні розробнику можливості візуалізувати проблему. Він / вона повинен чітко розуміти дефект у звіті про помилку. Не забудьте надати всю відповідну інформацію, яку шукає розробник.
Крім того, майте на увазі, що звіт про помилку буде збережений для подальшого використання і повинен бути добре написаний з необхідною інформацією. Використовуйте змістовні речення та прості слова щоб описати ваші помилки. Не використовуйте заплутаних тверджень, які витрачають час рецензента.
Повідомте про кожну помилку як про окрему проблему. У випадку кількох проблем в одному звіті про помилки, ви не можете закрити його, якщо не вирішено всі проблеми.
Тому найкраще розділити проблеми на окремі помилки . Це гарантує можливість обробки кожної помилки окремо. Добре написаний звіт про помилку допомагає розробнику відтворити помилку на своєму терміналі. Це також допомагає їм діагностувати проблему.
Як повідомити про помилку?
Використовуйте такий простий шаблон звіту про помилки:
Це простий формат звіту про помилки. Це може відрізнятися залежно від інструменту звітування про помилки, який ви використовуєте. Якщо ви пишете звіт про помилку вручну, тоді деякі поля потрібно вказати, зокрема номер помилки, який слід призначати вручну.
Доповідач: Ваше ім'я та електронна адреса.
Продукт: У якому продукті ви знайшли цю помилку.
Версія: Версія продукту, якщо така є.
Компонент: Це основні підмодулі продукту.
Платформа: Згадайте апаратну платформу, де ви знайшли цю помилку. Різні платформи, такі як «ПК», «MAC», «HP», «Sun» тощо.
Операційна система: Згадайте всі операційні системи, де ви виявили помилку. Операційні системи, такі як Windows, Linux, Unix, SunOS, Mac OS. Згадайте різні версії ОС, такі як Windows NT, Windows 2000, Windows XP тощо, якщо це можливо.
Пріоритет: Коли слід виправити помилку? Як правило, пріоритет встановлюється від P1 до P5. P1 як “виправити помилку з найвищим пріоритетом”, а P5 як “Виправити, коли дозволить час”.
Серйозність: Це описує вплив помилки.
Типи тяжкості:
- Блокувальник: Подальші роботи з тестування проводити не можна.
- Критично: Збій програми, втрата даних.
- Спеціальність: Велика втрата функції.
- Неповнолітні: Незначна втрата функції.
- Тривіальне: Деякі вдосконалення інтерфейсу.
- Покращення: Запит на нову функцію чи вдосконалення в існуючій.
Статус: Коли ви реєструєте помилку в будь-якій системі відстеження помилок, за замовчуванням статус помилки буде 'Новим'.
Пізніше помилка проходить різні етапи, такі як Виправлено, Перевірено, Відкрито, Не виправлено тощо.
=> Натисніть тут щоб прочитати більше про детальний життєвий цикл помилок.
Призначити: Якщо ви знаєте, який розробник відповідає за той конкретний модуль, у якому сталася помилка, тоді ви можете вказати електронну адресу цього розробника. В іншому випадку залиште це поле порожнім, оскільки це призначить помилку власнику модуля, якщо не менеджер призначить помилку розробнику. Можливо, додайте електронну адресу менеджера до списку CC.
URL: URL-адреса сторінки, на якій сталася помилка.
Короткий зміст: Короткий підсумок помилки, переважно 60 слів або нижче. Переконайтеся, що ваше резюме відображає, в чому проблема і де вона знаходиться.
Опис: Детальний опис помилки.
Для поля опису використовуйте наступні поля:
- Кроки відтворення: Зрозуміло, згадайте кроки щодо відтворення помилки.
- Очікуваний результат: Як повинна поводитися програма на вищезазначених кроках.
- Фактичний результат: Який фактичний результат запуску вищевказаних кроків, тобто поведінка помилок.
Це важливі кроки у звіті про помилку. Ви також можете додати “Тип звіту” як ще одне поле, яке описуватиме тип помилки.
Типи звітів включають:
1) Помилка кодування
2) Помилка проектування
3) Нова пропозиція
4) Випуск документації
5) Апаратна проблема
Важливі функції у звіті про помилки
Нижче наведено важливі особливості звіту про помилки:
# 1) Номер помилки / ідентифікатор
Номер помилки або ідентифікаційний номер (наприклад, swb001) значно полегшує звітування про помилки та посилання на помилку. Розробник може легко перевірити, чи виправлена певна помилка чи ні. Це робить весь процес тестування та повторного тестування більш плавним та легким.
# 2) Назва помилки
Заголовок помилки читається частіше, ніж будь-яка інша частина звіту про помилку. Це повинно говорити все про те, що трапляється у ваді.
Заголовок помилки повинен бути досить сугестивним, щоб читач міг його зрозуміти. Чітка назва помилки полегшує її розуміння, і читач може знати, чи повідомлялося про помилку раніше, чи вона була виправлена.
# 3) Пріоритет
Залежно від серйозності помилки, для неї можна встановити пріоритет. Помилка може бути блокувальником, критичним, основним, другорядним, тривіальним або пропозицією. Пріоритет помилки від P1 до P5 може бути наданий, щоб найважливіші переглядались спочатку.
# 4) Платформа / Навколишнє середовище
Для чіткого звіту про помилки необхідна конфігурація ОС та браузера. Це найкращий спосіб повідомити, як помилку можна відтворити.
Без точної платформи або середовища програма може поводитися інакше, і помилка на кінці тестувальника може не повторюватися на кінці розробника. Тож найкраще чітко згадати про середовище, в якому було виявлено помилку.
# 5) Опис
Опис помилки допомагає розробнику зрозуміти помилку. У ньому описана проблема, з якою виникла проблема. Поганий опис створить плутанину і витратить час розробників та тестувальників.
Необхідно чітко повідомляти про ефект опису. Завжди корисно використовувати цілі речення. Це хороша практика - описувати кожну проблему окремо, замість того, щоб їх взагалі розвалювати. Не використовуйте такі терміни, як 'я думаю' або 'я вірю'.
# 6) Кроки для відтворення
Хороший звіт про помилки повинен чітко згадувати кроки щодо відтворення. Етапи повинні включати дії, що спричиняють помилку. Не робіть загальних тверджень. Будьте конкретні в наступних кроках.
Хороший приклад добре написаної процедури наведено нижче
Кроки:
- Виберіть продукт Abc01.
- Натисніть Додати в кошик.
- Натисніть Видалити, щоб видалити товар із кошика.
# 7) Очікуваний та фактичний результат
Опис помилки є неповним без очікуваних та фактичних результатів. Необхідно окреслити, який результат тесту і на що повинен очікувати користувач. Читач повинен знати, яким є правильний результат тесту. Зрозуміло, згадайте, що сталося під час тесту та який був результат.
# 8) Знімок екрана
Картинка коштує тисячі слів. Зробіть знімок екрана випадку відмови з правильним підписом, щоб виділити дефект. Виділіть несподівані повідомлення про помилки світло-червоним кольором. Це привертає увагу до необхідної площі.
Деякі бонусні поради щодо створення хорошого звіту про помилки
Нижче наведено ще кілька додаткових порад, щоб скласти хороший звіт про помилки:
# 1) Повідомте про проблему негайно
безкоштовне програмне забезпечення для резервного копіювання комп'ютера на зовнішній жорсткий диск
Якщо під час тестування ви виявили помилку, не потрібно чекати, щоб написати докладний звіт про помилку пізніше. Натомість негайно напишіть звіт про помилку. Це забезпечить хороший і відтворюваний звіт про помилки. Якщо ви вирішите написати звіт про помилку пізніше, тоді є велика ймовірність пропустити важливі кроки у своєму звіті.
# 2) Відтворіть помилку тричі перед написанням звіту про помилку
Ваша помилка повинна бути відтворюваною. Переконайтеся, що ваші кроки є достатньо надійними, щоб відтворити помилку без жодної двозначності. Якщо ваша помилка не відтворюється кожного разу, ви все одно можете подати помилку, згадуючи періодичний характер помилки.
# 3) Перевірте ту саму помилку на інших подібних модулях
Іноді розробник використовує один і той же код для різних схожих модулів. Отже, є більша ймовірність помилки в одному модулі також у інших подібних модулях. Ви навіть можете спробувати знайти більш серйозну версію виявленої вади.
# 4) Напишіть хороший підсумок помилок
Підсумок помилок допоможе розробникам швидко проаналізувати природу помилок. Неякісний звіт надмірно збільшить час розробки та тестування. Добре спілкуйтеся зі своїм підсумком звіту про помилки. Майте на увазі, що підсумок помилки використовується як посилання для пошуку помилки в інвентарі помилок.
# 5) Прочитайте звіт про помилку, перш ніж натиснути кнопку Надіслати
Прочитайте всі речення, формулювання та кроки, які використовуються у звіті про помилки. Подивіться, чи не створює будь-яке речення двозначність, яка може призвести до неправильного тлумачення. Слід уникати оманливих слів або речень, щоб мати чіткий звіт про помилки.
# 6) Не використовуйте образливу мову
Приємно, що ви добре попрацювали і виявили помилку, але не використовуйте цей кредит для критики розробника або для нападу на будь-яку особу.
Висновок
Без сумніву, ваш звіт про помилку повинен бути високоякісним документом.
Зосередьтеся на написанні хороших звітів про помилки і витратьте трохи часу на це завдання, оскільки це основний пункт спілкування між тестувальником, розробником та менеджером. Менеджери повинні усвідомити свою команду, що написання хорошого звіту про помилки є головним завданням будь-якого тестувальника.
Ваші зусилля щодо написання хорошого звіту про помилки не лише заощадять ресурси компанії, але й створять хороші стосунки між вами та розробниками.
Для кращої продуктивності напишіть кращий звіт про помилки.
Ви фахівець у написанні звіту про помилки? Не соромтеся ділитися своїми думками в розділі коментарів нижче.
Рекомендована література
- Зразок звіту про помилки
- Як знайти помилку в додатку? Поради та підказки
- Як писати щотижневий звіт про тестування програмного забезпечення
- Що таке життєвий цикл дефектів / помилок при тестуванні програмного забезпечення? Підручник з життєвого циклу дефектів
- Як вирішити всі помилки без будь-якої мітки 'Недійсна помилка'?
- Приклади звітів про помилки веб-програм та програм для продуктів
- Як написати ефективний підсумковий звіт про тест (Зразок завантаження звіту)
- Чому звітування про помилки - це мистецтво, якому повинен навчитися кожен тестувальник?