Ką įtraukti į pranešimą apie klaidą?
Kaip parašyti pranešimą apie klaidą
Parašius gerą pranešimą apie trūkumus ar klaidas, galima greitai nustatyti ir išspręsti problemas. Šiame įraše pateikiame įprastus elementus, kurie paprastai yra įtraukti į klaidų ataskaitą.
Jokia ypatinga tvarka:
Defektų identifikatorius, ID
Identifikatorius yra labai svarbus, norint pranešimuose nurodyti trūkumą. Jei defektų registravimo įrankis naudojamas defektų registravimui, ID paprastai yra programos sugeneruotas unikalus skaičius, kuris padidina defektų žurnalą.
Santrauka
Santrauka yra bendras aukšto lygio defekto ir pastebėto gedimo aprašymas. Ši trumpa santrauka turėtų būti trūkumo akcentas, nes tai pirmiausia mato kūrėjai ar apžvalgininkai klaidų ataskaitoje.
apibūdinimas
Defekto pobūdis turi būti aiškiai parašytas. Jei defektą peržiūrintis kūrėjas negali suprasti ir negali sekti detalių apie defektą, tikriausiai ataskaita bus grąžinta bandytojui, paprašiusi daugiau paaiškinimų ir išsamesnės informacijos, dėl kurios vėluojama išspręsti problemą.
Apraše turėtų būti tiksliai paaiškinti veiksmai, kurių reikia imtis norint atkurti defektą, taip pat kokie buvo laukiami rezultatai ir kokie buvo bandymo etapo rezultatai. Ataskaitoje turėtų būti nurodyta, kuriame žingsnyje pastebėta nesėkmė.
Sunkumas
Defekto sunkumas parodo, koks defektas yra žalingas kitoms sistemoms, įmonėms, aplinkai ir žmonių gyvenimui, atsižvelgiant į taikymo sistemos pobūdį. Sunkumai paprastai skirstomi į 4 ar 5 lygius, atsižvelgiant į organizacijos apibrėžimą.
- S1 - kritinis: Tai reiškia, kad defektas yra parodinis kamštis, turintis didelę žalą ir neturintis problemos sprendimo būdų, kad būtų išvengta defekto. Pavyzdys gali būti tai, kad programa visai nepaleidžiama ir dėl to operacinė sistema išsijungia. Tam reikalingas neatidėliotinas dėmesys, veiksmai ir taisymas.
- S2 - rimtas: Tai reiškia, kad kai kurių pagrindinių programų funkcijų trūksta arba jos neveikia, o problemos nėra. Pvz., Vaizdo peržiūros programa negali nuskaityti kai kurių įprastų vaizdo formatų.
- S3 - normalus: Tai reiškia, kad kai kurios pagrindinės funkcijos neveikia, tačiau egzistuoja sprendimas, kurį reikia naudoti kaip laikiną sprendimą.
- S4 - kosmetika / patobulinimas: Tai reiškia, kad nesėkmė sukelia nepatogumų ir susierzinimą. Pavyzdys gali būti tai, kad yra iššokantis pranešimas kas 15 minučių, arba visada turite dukart spustelėti GUI mygtuką, kad atliktumėte veiksmą.
- S5 - pasiūlymas: Paprastai tai nėra brokas ir pasiūlymas pagerinti funkcionalumą. Tai gali būti GUI arba žiūrėjimo nuostatos.
Prioritetas
Nustačius sunkumą, reikia sužinoti, kaip skirti raišką pirmenybei. Pagal prioritetą nustatoma, kaip greitai reikia pašalinti defektą. Prioritetas paprastai yra susijęs su verslo svarba, tokia kaip poveikis projektui ir tikėtina produkto sėkmė rinkoje. Kaip ir sunkumas, prioritetas taip pat skirstomas į 4 ar 5 lygius.
- P1 - Skubi: Tai reiškia, kad tai labai skubu ir reikia nedelsiant ją išspręsti
- P2 - didelis: Kito išorinio leidimo reikalavimas dėl rezoliucijos
- P3 - vidutinis: Pirmosios diegimo metu reikalinga rezoliucija (o ne visos)
- P4 - žemas: Norima išspręsti dėl pirmojo diegimo ar vėlesnių būsimų leidimų
Skaitykite daugiau apie „Sunkumas prieš prioritetą“
Svarbu pažymėti, kad defektui, kuris yra labai sunkus, taip pat teikiamas didelis prioritetas, t. Y. Esant dideliam defektui reikės didelio prioriteto, kad problema būtų išspręsta kuo greičiau. Niekada negali būti didelio sunkumo ir mažo prioriteto defektų. Tačiau defektas gali būti mažo sunkumo, tačiau jam turi būti teikiama pirmenybė.
Pavyzdys gali būti įmonės pavadinimas, kuris paleidus programą yra neteisingai parašytas splash screen. Tai nepadaro didelės žalos aplinkai ar žmonių gyvenimui, tačiau gali pakenkti įmonės reputacijai ir pakenkti verslo pelnui.
Data ir laikas
Taip pat būtina nurodyti datą ir laiką, kada defektas atsirado arba apie kurį pranešta. Tai paprastai naudinga, kai norite ieškoti defektų, kurie buvo nustatyti konkrečiam programinės įrangos leidimui arba nuo tada, kai prasidėjo bandymo etapas.
Bandomos programinės įrangos versija ir komponavimas
Tai taip pat labai svarbu. Daugeliu atvejų yra daugybė programinės įrangos versijų; kiekvienoje versijoje yra daug pataisymų, daugiau funkcijų ir ankstesnių versijų patobulinimų. Todėl būtina pažymėti, kuri programinės įrangos versija parodė gedimą, apie kurį pranešame. Mes visada galime nurodyti tą programinės įrangos versiją, kad atkurtume gedimą.
Pranešė
Vėlgi, tai yra svarbu, nes jei mums gali tekti kreiptis į asmenį, kuris iškėlė defektą, turime žinoti, su kuo susisiekti.
Susijęs reikalavimas
Iš esmės visas programinės įrangos savybes galima atsekti pagal atitinkamus reikalavimus. Taigi, pastebėjus gedimą, galime pamatyti, kokie reikalavimai buvo paveikti.
Tai gali padėti sumažinti pasikartojančias defektų ataskaitas, nes jei galime nustatyti šaltinio reikalavimą, tada, jei užregistruojamas kitas defektas su tuo pačiu reikalavimo numeriu, mums gali nebereikėti jo pranešti, jei defektai yra panašaus pobūdžio.
Priedai / įrodymai
Visi gedimo įrodymai turėtų būti surinkti ir pateikti su defektų ataskaita. Tai yra vizualus defekto aprašymo paaiškinimas ir padeda apžvalgininkui, kūrėjui geriau suprasti defektą.
Išvada
Šiame straipsnyje mes sužinojome, kokią informaciją paprastai turėtume įtraukti į klaidų ataskaitą. Sukūrę gerą klaidų ataskaitą, paspartinsite pagrindinių priežasčių analizę ir pašalinsite klaidą.
