Как да напишете доклад за грешка с примери

⚡ Умно обобщение

Писането на отчети за грешки е основно умение за тестване, което документира ясно дефектите, ускорява поправките и подобрява качеството на софтуера, като предоставя на разработчиците възпроизводими стъпки, тежест, приоритет, подробности за средата и поддържащи приложения през целия жизнен цикъл на тестване на софтуера.

  • ???? Основна цел: Доклад за грешка tracks дефекти, записва тежестта и предоставя на разработчиците възпроизводим контекст, така че проблемите да се решават бързо, без двустранна комуникация.
  • 📝 Задължителни полета: Заглавие, тежест, приоритет, среда, стъпки за възпроизвеждане, очакван резултат, действителен резултат и прикачени файлове формират стандартния шаблон в повечето tracкери.
  • 🔍 Тежест спрямо приоритет: Сериозността измерва техническото въздействие (Блокиращо, Основно, Незначително, Тривиално), докато приоритетите фиксират спешността (Високо, Средно, Ниско) и двете никога не трябва да се бъркат.
  • ✅ Най-добри практики: Докладвайте за дефекти незабавно, прикачете екранни снимки или видеоклипове, валидирайте върху подобни модули и прегледайте отчетите веднъж, преди да ги изпратите, за да премахнете неяснотите.
  • 🧪 Съвременни инструменти: Джира, Линеен, Azure DevOps, грешка в Zoho Tracкер и Bugzilla рационализиране на подаването, докато подпомогнатият от изкуствен интелект триаж вече класифицира тежестта и автоматично изготвя стъпките за репродукция.

Как да напишем доклад за грешка

Какво е доклад за грешка? Защо се нуждаете от добър доклад за грешка?

Докладът за грешки е важен документ в STLC, който предлага различни предимства на екипа за тестване. Той поддържа tracна всички дефекти, множество грешки, бъгове и други несъответствия, открити по време на тестване на софтуера, и ги докладва.

Целта на тази документация след тестването е да предостави информация на съответния екип от професионалисти относно нивото на грешките, открити по време на процеса на тестване.

Вашият инженер по разработка на софтуер С помощта на този тип отчет можете да бъдете информирани за всички дефекти и проблеми, налични в софтуера. Той също така ви позволява да разберете какъв е проблемът с дадена грешка, за да можете да използвате най-добрия метод за отстраняването ѝ. Освен това ви помага да спестите време и пари, като използвате помощ.ping забелязвате грешки и проблеми.

Защо трябва да ви е грижа за добрите обяснения за грешки?

Добри обяснения на грешки

Ето какво трябва да имате предвид, за да напишете добър, подробен доклад за програмни грешки:

  • Той действа като ръководство за избягване на същата грешка в бъдещи издания.
  • Спестете време за комуникация (имейли, обаждания).
  • Less работа за разработчици (те ще направят точно това, което искате).
  • Ще имате по-малко тесни места в проекта; грешките ще бъдат коригирани по-бърз и по-ефективен начин.
  • Съвременни екипи, използващи Jira, Linear или Azure DevOps може също да свързва отчети за грешки със спринт билети и канали за пускане на пазара, като гарантира tracефективност в работните процеси за QA и DevOps.

Как се пише доклад за грешка (шаблон за доклад за грешка)

Няма точен шаблон за докладване на грешка, тъй като това зависи от вашата грешка-tracсистема king. Вашият шаблон може да е различен.

Следните общи полета обаче винаги са необходими, когато искате да напишете доклад за грешка:

  • Идентификатор на грешка/Заглавие.
  • Тежест и приоритет.
  • Descriptйон
  • Заобикаляща среда
  • Стъпки за възпроизвеждане.
  • Очакван резултат.
  • Реален резултат.
  • Прикачени файлове (екранни снимки, видеоклипове, текст)

Нека разгледаме всички тези грешки -tracкомпоненти на краля един по един:

1) Заглавие/ИД на грешка:

Всеки бъг трябва да получи уникален идентификационен номер. Инструментите за докладване на грешки трябва да бъдат уникални номера за новооткритите грешки, за да можем лесно да идентифицираме грешката.

Примери:

❌ Лошо: „Не мога да видя продукта, когато го направя отново, мисля, че не го вижда.“

  • неясен
  • Агресивен
  • Твърде многословен

моли за прилагане на решение.

✅ Добре: „КОЛИЧКА – Нови артикули, добавени в количката, които не се показват“.

  • Този вид заглавие незабавно открива проблема (КОЛИЧКА)
  • Фокусира се върху действителния технически проблем.

2) Сериозност на грешката:

Сериозността на грешката е много важен фактор в доклада за грешка. Той описва ефекта на дефекта върху производителността на приложението.

  • Блокер: Тази грешка причинява неуспех на приложението.
  • Специалност: Критична грешка показва голяма промяна в бизнес логиката.
  • Незначителен: Проблем, който не засяга функционалността на приложението, но засяга очакваните резултати.
  • Тривиално: Това не засяга функционалността или работата на приложението. Може да е печатна грешка.

3) Приоритет на грешки:

Следва общата градация за определяне на приоритета на грешката:

  • Високо: Той обхваща всичко, което засяга потока или блокира използването на приложението.
  • Medium: Това се отразява неблагоприятно на потребителското изживяване.
  • Незначителен: Всички други грешки като (печатни грешки, липсващи икони, проблеми с оформлението и т.н.).

4) Околна среда:

Грешка може да се появи в конкретна среда, а не в други. Например, понякога се появява грешка при стартиране на уебсайта Firefox, или неизправност на приложението само когато работи на Android устройство и работи добре на iPhone.

Тези доклади за грешки могат да бъдат идентифицирани само с тестване на различни браузъри или различни устройства. Така че, когато съобщават за грешка, QA трябва да могат да уточнят дали грешката трябва да бъде наблюдавана в една или повече специфични среди.

5) Резюме:

Добавянето само на заглавието в доклада за грешка обаче не е достатъчно. Така че, ако заглавието ви не е достатъчно, можете да добавите кратко резюме на доклада.

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

Примери:

  • Лошо: „Опитвах се да добавя неща към теста и нищо не се появи, когато го направих или щракнах върху бутона.“
  • Добра практика: „Когато се опитах да добавя [ПРОДУКТ] към магазинаping количката, но нищо не се случи, когато щракнах върху бутона „добавяне“ на уеб страницата с преглед на конкретния продукт.“

6) Стъпки за възпроизвеждане:

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

Бъдете конкретни относно стъпките, които трябва да следвате:

Ето пример за добре написана процедура:

Стъпки:

  1. Изберете продукт X1.
  2. Кликнете върху Добавяне в количката.
  3. Натиснете Премахни, за да премахнете продукта от количката.

7) Очакван резултат:

В докладите за грешки описанието на очаквания резултат според техническата задача, дизайна на резултатите от тестовия случай или според мнението на тестера е важно. Всичко това помага на разработчиците да се съсредоточат върху бързото намиране на необходимата информация.

Например:

Задължителните полета трябва да бъдат маркирани в червено след натискане на бутона „Изпращане“.

8) Действителен резултат:

Както подсказва името, това s поле описва действителния ефект от грешката. Много е важно да напишете ясно описание на действителния резултат.

Например:

Задължителните полета се маркират в зелено след натискане на бутона „Изпращане“.

9) Прикачени файлове (екранни снимки и видеоклипове):

В докладите за грешки е най-добрата практика да прикачвате файлове към докладите за грешки, което улеснява възприемането на информация, когато трябва да я покажете визуално:

Например:

  • снимки: Екранните снимки могат лесно да разработят грешки в програмата; е удобно, когато грешката е маркирана с конкретна анотация, кръг или изображение със стрелка).
  • Видео: Понякога е трудно да се опише грешката с думи, затова е по-добре да се създаде видеоклип, за да може разработчикът да отстрани дефекта в програмата.

10) Засегната версия:

Това е засегнатата версия на софтуера, в която се съобщава за грешка.

11) Коригирана версия:

Това е версията на софтуера, в която грешката е разрешена. Така че, когато QA, който докладва грешката, провери дали тя е коригирана, той използва правилната версия на софтуера.

12) Target версия:

Целевата версия, към която трябва да се насочи грешка, за да бъде коригирана. Така че, когато екипът за разработка работи върху коригирането на грешка, те са насочени най-вече към определена версия на приложението.

13) Дата на затваряне:

Това е датата, на която грешката е затворена от екипа за тестване на софтуера. Затварянето на грешка е жизненоважна и неразделна част от тестването на софтуера.

14) Статус:

Когато се създаде нов бъг, неговият статус трябва да е отворен. След това преминава през етапи като В ход, Фиксиран, Работи, Повторно отваряне и т.н.

Съвети за писане на доклад за грешка

Ето някои важни съвети, които трябва да запомните, докато пишете ефективен доклад за грешка:

  • Бъдете конкретни, когато създавате доклади за грешки. Уверете се, че не включвате никакви безполезни или неподходящи факти.
  • Трябва да съобщите за грешката незабавно, веднага щом бъде открита.
  • Подгответе доклада в детайли, за да дадете възможност на разработчика да използва фактите и информацията за отстраняване на грешки в проблема.
  • Трябва да тествате същата поява на грешка на други подобни модули за проверка.
  • Revт.е. прегледайте доклада за грешка поне веднъж, преди да го изпратите.
  • Трябва да се уверите, че докладът за грешка съдържа описание само на една грешка.
  • И накрая, не трябва да се страхувате да помолите ръководителя на проекта за помощ, ако нещо не ви е ясно.
  • Използвайте функции за триаж, подпомогнати от изкуствен интелект, в Jira или Linear, за да класифицирате автоматично тежестта, да предлагате дубликати и да насочвате отчета към правилния собственик на компонента.

Инструменти за докладване на грешки

Процесът на докладване на грешки, извършван ръчно, сега се извършва с различни инструменти за докладване на грешки, налични на пазара.

  • Jira
  • Линеен
  • Azure DevOps
  • Зохо Бъг TracКер
  • Bugzilla

Можете да проверите нашия подробен преглед на най-добрият инструмент за докладване на грешки.

Често срещан проблем и решение при писане на доклад за грешка:

Ето някои често срещани проблеми и техните решения при писане на доклад за грешка:

Пример за доклад за грешка Проблем
Когато умножите 2 по 3, отговорът ще бъде положителен. Докладвайте модела, а не пример.
Списъкът ще бъде подреден по азбучен ред при добавяне на нов елемент, за да се избегне това. Не описвайте само какво не е наред
Например:
За да бъдете, ще трябва да отворите браузъра си и да въведете адреса на сайта URLЩе откриете, че първото поле, „потребителско име“, е написано с правописна грешка.
Винаги насочвайте към същността (Никога не разказвайте историята!).
Името на клиента в доклада е изписано неправилно. Приоритет: Висок, Тежест: Висок Никога не смесвайте приоритет и тежест.
Формулата за изчисляване на данъка е НЕПРАВИЛНА !!?? Не използва ГЛАВНИ БУКВИ, червени букви, червени кръгове, '!',
Не мисля, че дизайнът на началната страница на UL е добър. Не използвайте преценката си.
Пример за неясно описание: Относно нашата дискусия днес, моля, направете необходимото действие за тази страница. Направете описанието си разбираемо за всички.
Фонът на страницата трябва да е син, оранжев или зелен, или можете да го направите черен или бял.

Това не е добре, тъй като не е ясно какво е необходимо от екипа за уеб разработка и дизайн

Минимизирайте опциите
Формулата за изчисляване на данъка понякога не работи според очакванията. Златното правило: Не използвайте думата „Понякога“.

Пример за доклад за грешка

Ето малък пример за доклад за грешка:

[МОЯТ АКАУНТ] Подчертано се показва, когато задържите мишката върху бутона Актуализиране.

Descriptйон: Трябва да премахнем подчертаването, когато задържим мишката върху бутона Актуализиране в секцията Моят акаунт.

Връзка: http://test.com/mv-account/

Браузър/ОС: Chrome 25. OSX Yosemite 10.10.2

Стъпки за възпроизвеждане:

1. Отидете на www.test.com

2. Влезте чрез идентификационни данни за вход

3. Отидете до Моят акаунт

4. Задръжте курсора на мишката върху бутона Актуализиране

Действителен резултат: има подчертаване.

Очакван резултат: без подчертаване.

Данни за вход: test@test.com / mysecretpass12

Трябва да се избягват грешки при писане на доклад за грешка

Ето някои важни грешки, които трябва да избягвате, докато пишете доклад за грешка:

  • Не пишете за недоволството си и никога не включвайте личните си чувства.
  • Дразни хората, които искат да се съсредоточат върху задачата, когато претоварвате публикацията си с много емотикони.
  • Никога не претоварвайте публикацията си с удивителни знаци; не ускорява работата.
  • Никой не иска да се чувства обиден. Разрушава мотивацията и забавя осъзнаването на проблема.

Въпроси и Отговори

Докладът за грешка е структуриран документ, който записва дефект, открит по време на тестване. Той съдържа заглавие, тежест, приоритет, среда, стъпки за възпроизвеждане, очаквани и действителни резултати и прикачени файлове, така че разработчиците да могат бързо да диагностицират и отстранят проблема.

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

Сериозността описва техническото въздействие на дефект върху приложението, като например „Блокиране“ или „Незначителен“. Приоритетът определя колко спешно екипът трябва да го поправи, като е класиран като „Висок“, „Среден“ или „Нисък“. Двете винаги трябва да се задават независимо.

Популярен бъг tracкралските инструменти включват Jira, Linear, Azure DevOps, грешка в Zoho Tracкер и BugzillaВсеки от тях се интегрира с CI/CD конвейери, поддържа персонализирани работни процеси и вече предлага автоматизирано свързване между дефекти, спринтове и версии на изданията.

С помощта на изкуствен интелект, триажът на грешки използва машинно обучение за класифициране на тежестта, откриване на дубликати и насочване на заявки към правилния собственик на компонента. Инструменти като Jira AI и Linear AI анализират текста на отчетите, подреждат ги tracи история за автоматично предвиждане на приоритета.

Да. Асистентите за тестване, задвижвани от изкуствен интелект, записват потребителски сесии, събират лог файлове на конзолата и генерират кратки стъпки за възпроизвеждане от неуспех. traces. Това намалява ръчното усилие, подобрява яснотата и помага на разработчиците да възпроизведат дефекта от първия опит.

Обобщете тази публикация с: