Мени

Како написати добар извештај о грешци? Савети и Трикови

how write good bug report

Испробајте Наш Инструмент За Елиминисање Проблема

Зашто добар извештај о грешкама?

Ако је ваш извештај о грешкама ефикасан, тада су веће шансе да се поправи. Дакле, исправљање грешке зависи од тога колико ефикасно је пријављујете. Пријављивање грешке није ништа друго до вештина и објаснићу како да се постигне ова вештина.

„Сврха писања извештаја о проблему (извештаја о грешкама) је поправљање грешака“ - Аутор Цем Канер. Ако тестер не пријави исправно грешку, програмер ће највероватније одбити ову грешку наводећи је као непродуктивну.

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

Ово може наштетити моралима тестера, а понекад и егу. (Предлажем да се не задржава било која врста ега. Его је попут „Тачно сам пријавио грешку“, „Могу је репродуковати“, „Зашто је он / она одбацио грешку?“, „Нисам ја крив“ итд. ,).

Шта ћете научити:

Које су особине доброг извештаја о софтверским грешкама?

Свако може да напише извештај о грешци. Али не може свако да напише ефикасан извештај о грешкама.

Требали бисте бити у могућности да разликујете просечан извештај о грешци и добар извештај о грешци. Како разликовати добар и лош извештај о грешкама? Врло је једноставно, примените следеће карактеристике и технике да бисте пријавили грешку.

Карактеристике и технике укључују

# 1) Имати јасно назначен број грешке: Увек доделите јединствени број сваком извештају о грешци. То ће вам, пак, помоћи да идентификујете евиденцију о грешкама. Ако користите било коју алатку за аутоматско пријављивање грешака, овај јединствени број ће се аутоматски генерисати сваки пут док пријављујете грешку.

Забележите број и кратак опис сваке грешке коју сте пријавили.

# 2) Репродуцибилно: Ако се ваша грешка не може поновити, она се никада неће поправити.

Требали бисте јасно споменути кораке за репродукцију грешке. Не претпостављајте и не прескачите ниједан корак репродукције. Грешку која је описана корак по корак лако је репродуковати и поправити.

# 3) Будите прецизни: Не пишите есеј о проблему.

Будите прецизни и прецизни. Покушајте да резимирате проблем у најмање речи, али на ефикасан начин. Не комбинујте више проблема чак и ако се чини да су слични. За сваки проблем напишите различите извештаје.

Ефективно извештавање о грешкама

Пријављивање грешака је важан аспект тестирања софтвера. Ефикасан извештај о грешкама добро комуницира са развојним тимом и избегава забуну или погрешну комуникацију.

који је најбољи иоутубе то мп3 цонвертер

Требао би бити добар извештај о грешкама јасан и сажет без икаквих недостајућих кључних тачака. Сваки недостатак јасноће доводи до неспоразума и успорава и развојни процес. Писање и извештавање о недостацима једно је од најважнијих, али занемарених подручја у животном циклусу тестирања.

Добро писање је веома важно за пријављивање грешке. Најважнија ствар коју тестер треба имати на уму је да се не користи заповедним тоном у извештају. Ово руши морал и ствара нездрав радни однос. Користите сугестивни тон.

Не претпостављајте да је програмер погрешио и стога можете користити оштре речи. Пре пријављивања, подједнако је важно проверити да ли је иста грешка пријављена или не.

Двострука грешка представља терет у циклусу испитивања. Проверите целу листу познатих грешака. Понекад су програмери могли знати проблем и игнорисати га за будуће издање. Такође се могу користити алати попут Бугзилла који аутоматски тражи дупликате грешака. Међутим, најбоље је ручно тражити било коју дуплирану грешку.

Информације о увозу које извештај о грешци мора да саопштава су 'Како?' и где?' Извештај треба јасно да одговори на то како је извршено испитивање и где је тачно дошло до квара. Читач би требао лако репродуковати грешку и пронаћи где је грешка.

Имајте на уму да циљ писања извештаја о грешкама је омогућити програмеру да визуализује проблем. Требао би јасно разумети квар из извештаја о грешкама. Не заборавите да дате све релевантне информације које програмер тражи.

Такође, имајте на уму да би извештај о грешкама био сачуван за будућу употребу и требало би да буде добро написан са потребним информацијама. Користите смислене реченице и једноставне речи да опишем ваше грешке. Не користите збуњујуће изјаве које троше време рецензента.

Пријави сваку грешку као засебан проблем. У случају више проблема у једном извештају о грешкама, не можете га затворити ако се сви проблеми не реше.

Отуда је најбоље да поделите проблеме на засебне грешке . Ово осигурава да се са сваком грешком може поступати одвојено. Добро написан извештај о грешци помаже програмеру да репродукује грешку на њиховом терминалу. Ово им помаже и да дијагностикују проблем.

Како пријавити грешку?

Користите следећи једноставни образац извештаја о грешкама:

Ово је једноставан формат извештаја о грешкама. Може се разликовати у зависности од алата за извештавање о грешкама који користите. Ако ручно пишете извештај о грешци, нека поља треба посебно навести, на пример број грешке, који треба доделити ручно.

Репортер: Ваше име и адреса е-поште.

Производ: У ком производу сте пронашли ову грешку.

Верзија: Верзија производа ако постоји.

Саставни део: То су главни подмодули производа.

Платформа: Наведите хардверску платформу на којој сте пронашли ову грешку. Разне платформе попут „ПЦ“, „МАЦ“, „ХП“, „Сун“ итд.

Оперативни систем: Наведите све оперативне системе у којима сте пронашли грешку. Оперативни системи попут Виндовс, Линук, Уник, СунОС, Мац ОС. Наведите различите верзије ОС-а, попут Виндовс НТ, Виндовс 2000, Виндовс КСП итд., Ако је применљиво.

Приоритет: Када треба исправити грешку? Приоритет је углавном постављен од П1 до П5. П1 као „отклони грешку са највишим приоритетом“, а П5 као „Поправи када време дозволи“.

Озбиљност: Ово описује утицај грешке.
Врсте озбиљности:

програмер у питањима за пробни интервју
  • Блоцкер: Даљи радови на испитивању се не могу обавити.
  • Критичан: Отказивање апликације, губитак података.
  • Главни: Велики губитак функције.
  • Минор: Мањи губитак функције.
  • Тривијалан: Нека побољшања корисничког интерфејса.
  • Побољшање: Захтев за нову функцију или неко побољшање у постојећој.

Статус: Када пријављујете грешку у било који систем за праћење грешака, тада ће статус грешке бити подразумевано „Ново“.
Касније, грешка пролази кроз разне фазе као што су Фикед, Верифиед, Реопен, Вон’т Фик итд.

=> Кликните овде да бисте прочитали више о детаљном животном циклусу грешака.

Доделили: Ако знате који програмер је одговоран за тај одређени модул у коме је дошло до грешке, тада можете да наведете адресу е-поште тог програмера. У супротном нека остане празна јер ће ово доделити грешку власнику модула, ако не, менаџер ће грешку доделити програмеру. Могуће је додати е-адресу менаџера на ЦЦ листу.

УРЛ: УРЛ странице на којој се догодила грешка.

Резиме: Кратак резиме грешке углавном у 60 речи или ниже. Уверите се да ваш резиме одражава шта је проблем и где је.

Опис: Детаљан опис грешке.

Користите следећа поља за поље описа:

  • Кораци репродукције: Јасно, спомените кораке за репродукцију грешке.
  • Очекивани резултат: Како апликација треба да се понаша у горе поменутим корацима.
  • Прави резултат: Који је стварни резултат покретања горе наведених корака, тј. Понашање грешке.

Ово су важни кораци у извештају о грешкама. Такође можете додати „Тип извештаја“ као још једно поље које ће описати тип грешке.

Типови извештаја укључују:

1) Кодирање грешке
2) Грешка у дизајну
3) Нови предлог
4) Питање документације
5) Хардверски проблем

Важне карактеристике у извештају о грешкама

Доље су дате важне карактеристике у извештају о грешкама:

# 1) Број грешке / ид

Број грешке или идентификациони број (попут свб001) олакшава пријављивање грешака и упућивање на грешку. Програмер може лако да провери да ли је одређена грешка исправљена или не. Омогућава читав процес тестирања и поновног тестирања глаткијим и лакшим.

# 2) Наслов грешке

Наслов грешке чита се чешће него било који други део извештаја о грешци. Требало би рећи све о томе шта долази са грешком.

Наслов грешке треба да буде довољно сугестиван да га читалац може разумети. Јасан наслов грешке олакшава разумевање и читалац може знати да ли је грешка раније пријављена или је отклоњена.

# 3) Приоритет

На основу озбиљности грешке, за њу се може поставити приоритет. Грешка може бити Блоцкер, Критична, Мајор, Минор, Тривиал или предлог. Може се дати приоритет грешке од П1 до П5, тако да се најпре прегледају најважније.

# 4) Платформа / Животна средина

Конфигурација ОС-а и прегледача је неопходна за јасан извештај о грешкама. То је најбољи начин да се саопшти како се грешка може репродуковати.

Без тачне платформе или окружења, апликација се може понашати другачије и грешка на крају тестера можда се неће реплицирати на крају програмера. Зато је најбоље јасно споменути окружење у којем је грешка откривена.

# 5) Опис

Опис грешке помаже програмеру да разуме грешку. Описује настали проблем. Лош опис ће створити забуну и такође изгубити време програмера и тестера.

Потребно је јасно комуницирати о ефекту описа. Увек је корисно користити комплетне реченице. Добра је пракса описивати сваки проблем одвојено, уместо да их у потпуности срушите. Не користите изразе попут „мислим“ или „верујем“.

# 6) Кораци за репродукцију

Добар извештај о грешкама треба да јасно помиње кораке за репродукцију. Кораци треба да укључују радње које узрокују грешку. Не дајте генеричке изјаве. У конкретним корацима будите прецизни.

Добар пример добро написаног поступка дат је у наставку

Кораци:

  • Изаберите производ Абц01.
  • Кликните на Додај у корпу.
  • Кликните на Ремове (Уклони) да бисте уклонили производ из корпе.

# 7) Очекивани и стварни резултат

Опис грешке је непотпун без очекиваних и стварних резултата. Потребно је назначити шта је исход теста и шта корисник треба да очекује. Читалац треба да зна који је исправан исход теста. Јасно, спомените шта се догодило током теста и какав је био исход.

# 8) Снимак екрана

Слика вреди хиљаду речи. Снимите снимак екрана случаја грешке са одговарајућим натписима да бисте истакли недостатак. Неочекиване поруке о грешкама истакните светлоцрвеном бојом. Ово скреће пажњу на потребно подручје.

Неки бонус савети за писање доброг извештаја о грешкама

Следећи доле дати су још неки додатни савети за писање доброг извештаја о грешкама:

# 1) Одмах пријавите проблем

Ако током тестирања нађете било какву грешку, немојте чекати да касније напишете детаљан извештај о грешци. Уместо тога, одмах напишите извештај о грешци. Ово ће осигурати добар и поновљив извештај о грешкама. Ако се касније одлучите за писање извештаја о грешкама, велике су шансе да пропустите важне кораке у свом извештају.

# 2) Репродукујте грешку три пута пре писања извештаја о грешци

Ваша грешка би требала бити поновљива. Уверите се да су ваши кораци довољно робусни да репродукују грешку без икаквих двосмислености. Ако се ваша грешка не може репродуковати сваки пут, још увек можете да је пријавите и помињете периодичну природу грешке.

# 3) Тестирајте исту појаву грешке на другим сличним модулима

Понекад програмер користи исти код за различите сличне модуле. Дакле, веће су шансе да се грешка у једном модулу појави и на другим сличним модулима. Можете чак покушати да нађете тежу верзију грешке коју сте пронашли.

најбољи иоутубе видео у мп3 претварач

# 4) Напишите добар резиме грешке

Резиме грешака ће помоћи програмерима да брзо анализирају природу грешке. Извештај лошег квалитета непотребно ће повећати време израде и тестирања. Добро комуницирајте са резимеом извештаја о грешкама. Имајте на уму да се резиме грешке користи као референца за претраживање грешке у инвентару грешака.

# 5) Прочитајте извештај о грешкама пре него што притиснете дугме Пошаљи

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

# 6) Не користите насилни језик

Лепо је што сте добро урадили и пронашли грешку, али не користите ову заслугу за критиковање програмера или за напад на било кога.

Закључак

Нема сумње да би ваш извештај о грешкама требало да буде документ високог квалитета.

Усредсредите се на писање добрих извештаја о грешкама и проведите мало времена на овом задатку, јер је ово главна тачка комуникације између тестера, програмера и менаџера. Менаџери би требали створити свест о свом тиму да је писање доброг извештаја о грешкама примарна одговорност било ког испитивача.

Ваш труд око писања доброг извештаја о грешкама не само да ће уштедети ресурсе компаније, већ ће створити и добре односе између вас и програмера.

За бољу продуктивност напишите бољи извештај о грешкама.

Да ли сте стручњак за писање извештаја о грешкама? Слободно поделите своје мисли у одељку за коментаре испод.

Препоручено читање

^