How to Write a Bug Report with Examples

Mis on veaaruanne? Miks on vaja head veaaruannet?

Vearaport on STLC-s oluline dokument, mis pakub testimismeeskonnale mitmeid eeliseid. See hoiab track kõikidest tarkvara testimise käigus leitud defektidest, mitmetest vigadest, eksimustest ja muudest lahknevustest ning annab neist teada.

Selle testimisjärgse dokumentatsiooni eesmärk on anda asjaomastele professionaalide meeskonnale teavet testimisprotsessi käigus ilmnenud vigade taseme kohta.

Sinu tarkvaraarenduse insener can be made aware of all the defects and issues present in the software using this type of report. It also lets you figure out what is wrong with a bug, so you can use the best method to fix it. It also helps you to save your time and money by helping sa märkad vigu ja probleeme.

Miks peaksite hoolima headest veaseletustest?

Siin on punkt, mida peate hea ja üksikasjaliku tarkvaravea aruande kirjutamisel arvesse võtma:

• See toimib juhendina, mis aitab vältida sama viga tulevastes versioonides.
• Varu aega suhtlemiseks (e-kirjad, kõned).
• Less töötage arendajate heaks (nad teevad täpselt seda, mida soovite).
• Teil on projektis vähem kitsaskohti; vead parandatakse kiiremini ja tõhusamalt.
• Modern teams using Jira, Linear, or Azure DevOps can also link bug reports to sprint tickets and release pipelines, ensuring traceability across QA and DevOps workflows.

Kuidas kirjutada veaaruannet (veaaruande mall)

Täpset vearaporti malli pole, kuna see sõltub teie veast.trackuninglik süsteem. Teie mall võib olla erinev.

Veaaruande kirjutamisel on aga alati vajalikud järgmised tavalised väljad:

• Vea ID/ Pealkiri.
• Raskus ja prioriteet.
• Kirjeldus
• keskkond
• Paljundamise sammud.
• Oodatud tulemus.
• Tegelik tulemus.
• Manused (ekraanipildid, videod, tekst)

Let us look at all these bug-tracking components one by one:

1) Pealkiri/vea ID:

Igale veale tuleks anda kordumatu identifitseerimisnumber. Vigadest teatamise tööriistad peaksid olema äsja tõstatatud vigade kordumatud numbrid, et saaksime vea hõlpsalt tuvastada.

Näited:

❌ Halb: "Ma ei näe toodet uuesti, aga ei näe."

• Vague
• Agressiivne
• Liiga sõnakas

palub lahenduse elluviimist.

✅ Hea: “KORVI – ostukorvi lisati uued kaubad, mis ei ilmu”.

• Selline pealkiri tuvastab koheselt probleemi asukoha (CART)
• See keskendub tegelikule tehnilisele probleemile.

2) Vea raskusaste:

Vea raskusaste on veaaruandes väga oluline tegur. See kirjeldab defekti mõju rakenduse jõudlusele.

• Blokeerija: See viga põhjustab rakenduse ebaõnnestumise.
• Major: Kriitiline viga viitab suurele muudatusele äriloogikas.
• Väike: Probleem, mis ei mõjuta rakenduse funktsionaalsust, kuid mõjutab oodatud tulemusi.
• Triviaalne: See ei mõjuta rakenduse funktsionaalsust ega toimimist. See võib olla trükiviga.

3) Vea prioriteet:

Vea prioriteedi määramiseks on järgmine üldine gradatsioon:

• Kõrge: See hõlmab kõike, mis mõjutab voogu või blokeerib rakenduse kasutamist.
• Medium: See mõjutab kasutajakogemust negatiivselt.
• Väike: Kõik muud vead, näiteks (kirjavead, puuduvad ikoonid, paigutusprobleemid jne).

4) Keskkond:

Viga võib ilmneda konkreetses keskkonnas, mitte teistes. Näiteks mõnikord ilmneb veebisaidi käivitamisel viga Firefoxvõi rakenduse rike ainult siis, kui töötate seadmega Android seade ja töötab iPhone'is hästi.

Neid veateateid saab tuvastada ainult brauseri- või seadmeteülese testimise teel. Seega peaksid kvaliteedikontrollid veast teatades suutma täpsustada, kas viga tuleks ühes või mitmes konkreetses keskkonnas täheldada.

5) Kokkuvõte:

However, adding only the Title in the bug report does not serve the purpose. So, if your Title is not enough, you can add a short report summary.

Teie võimalikult väheste sõnadega kokkuvõte, sealhulgas millal ja kuidas viga ilmnes. Otsingutes tuleks kasutada ka teie pealkirja ja veakirjeldust, seega peate tagama, et olete hõlmanud olulised märksõnad.

Näited:

• halb: "Proovisin testile asju lisada ja midagi ei ilmnenud, kui seda tegin või nuppu klõpsasin."
• Hea: „Kui ma proovisin [TOODET] poodi lisadaping ostukorvi, aga toote ülevaate veebilehel nupule „Lisa“ klõpsamisel ei juhtunud midagi.

6) Reprodutseerimise sammud:

When reporting a bug, it is important to specify the steps to reproduce it. You should also include actions that may cause the bug. Here, do not make any generic statements.

Olge konkreetne järgitavate sammude osas:

Siin on näide hästi kirjutatud protseduurist:

Sammud:

1. Valige toode X1.
2. Klõpsake nuppu Lisa ostukorvi.
3. Toote ostukorvist eemaldamiseks klõpsake nuppu Eemalda.

7) Oodatav tulemus:

Veaaruannetes on oluline eeldatava tulemuse kirjeldamine tehnilise ülesande, testjuhtumi tulemuste disaini või vastavalt testija arvamusele. Kõik see aitab arendajatel keskenduda vajaliku teabe kiirele leidmisele.

Näiteks:

Kohustuslikud väljad tuleb pärast nupu „Esita” klõpsamist punasega esile tõsta.

8) Tegelik tulemus:

Nagu nimigi ütleb, kirjeldab see väli vea tegelikku mõju. Väga oluline on kirjutada tegeliku tulemuse selge kirjeldus.

Näiteks:

Kohustuslikud väljad tõstetakse rohelise värviga esile pärast nupu “Esita” klõpsamist.

9) Manused (ekraanipildid ja videod):

Veaaruannetes on parim tava lisada veaaruannetele failid, mis hõlbustab teabe tajumist, kui peate seda visuaalselt kuvama.

Näiteks:

• Pilt: Ekraanitõmmised võivad programmi vigu hõlpsalt täpsustada; on mugav, kui viga on esile tõstetud konkreetse märkuse, ringi või noolepildiga).
• Video: Sometimes, it is difficult to describe the bug in words, so it is better to create a video so that developer can rectify the defect in the program).

10) Mõjutatud versioon:

See on mõjutatud tarkvaraversioon, kus veast teatatakse.

11) Parandatud versioon:

See on tarkvara versioon, milles viga on lahendatud. Seega, kui veast teatanud QA kontrollib, kas see on parandatud, kasutab ta õiget tarkvaraversiooni.

12) Target versioon:

Sihtversioon, kus vea parandamiseks tuleks sihtida. Seega, kui arendusmeeskond töötab vea parandamise kallal, sihivad nad enamasti konkreetse rakenduse versiooni.

13) Sulgemise kuupäev:

See on kuupäev, mil tarkvara testimismeeskond vea sulgeb. Vea sulgemine on tarkvara testimise oluline ja lahutamatu osa.

14) Olek:

Uue vea loomisel peaks selle olek olema avatud. Pärast seda läbib see selliseid etappe nagu pooleli, fikseeritud, töötamine, taasavamine jne.

Näpunäiteid veateadete kirjutamiseks

Siin on mõned olulised näpunäited, mida peaksite tõhusa veaaruande kirjutamisel meeles pidama.

• Be specific when creating bug reports. Make sure you do not include any useless or irrelevant facts.
• Peate veast kohe teatama, niipea kui see avastatakse.
• Valmistage aruanne ette üksikasjalikult, et anda arendajale võimalus kasutada probleemi silumiseks fakte ja teavet.
• Kontrollimiseks peaksite testima sama vea esinemist teistes sarnastes moodulites.
• Revlugege veaaruannet vähemalt üks kord enne selle esitamist.
• Peaksite tagama, et veaaruanne sisaldaks ainult ühe vea kirjeldust.
• Lõpetuseks ei tasu karta projektijuhilt abi küsida, kui jääb millegi suhtes ebaselgeks.
• Use AI-assisted triage features in Jira or Linear to auto-classify severity, suggest duplicates, and route the report to the right component owner.

Vigadest teatamise tööriistad

Vigadest teatamise protsess, mida tehakse käsitsi, viiakse nüüd läbi erinevate turul saadaolevate vigadest teatamise tööriistadega.

• Jira
• Linear
• Azure DevOps
• Zoho viga Tracker
• Bugzilla

Saate vaadata meie üksikasjalikku ülevaadet parim vigadest teatamise tööriist.

Levinud probleem ja lahendus veaaruande kirjutamisel:

Siin on mõned levinumad probleemid ja nende lahendused veaaruande kirjutamisel.

Veaaruande näide	Probleem
Kui korrutada 2-ga, on vastus positiivne.	Teatage mustrist, mitte näitest.
Selle vältimiseks järjestatakse loend uue üksuse lisamisel tähestikulises järjekorras.	Do not only describe what is wrong
Näiteks: Selleks peate avama brauseri ja sisestama saidi aadressi. URL. You will find the first field, ‘username,’ misspelled.	Suunake alati asja juurde (Ära kunagi räägi lugu!).
Aruandes on kliendi nimi valesti kirjutatud. Prioriteet: kõrge, raskusaste: kõrge	Ärge kunagi segage prioriteeti ja tõsidust.
Maksu arvutamise valem ON VALE !!??	Ei kasuta suurtähti, punaseid tähti, punaseid ringe, '!',
I do not think that the home page Ul design is good.	Do not use your judgment.
Ebaselge kirjelduse näide: meie tänase arutelu kohta tehke sellel lehel nõutavad toimingud.	Muutke oma kirjeldus kõigile arusaadavaks.
Lehe taust peaks olema sinine, oranž või roheline või saate selle muuta mustaks või valgeks. See pole hea, kuna on ebaselge, mida veebiarendus- ja disainimeeskonnalt vaja on	Minimeerige valikud
Maksu arvutamise valem ei tööta mõnikord ootuspäraselt.	The golden rule: Do not use the word ‘Sometimes’.

Veaaruande näide

Siin on väike näide veaaruandest:

[MINU KONTO] Allajoonitud kuvatakse, kui hiirekursor liigub värskendusnupule.

Descriptioon: Peame eemaldama allakriipsu, kui liigute hiirekursoriga jaotises Minu konto nupule Värskenda.

Link: http://test.com/mv-account/

Brauser/OS: Chrome 25. OSX Yosemite 10.10.2

Paljundamise sammud:

1. Minge aadressile www.test.com

2. Logige sisse sisselogimismandaatide kaudu

3. Liikuge jaotisesse Minu konto

4. Hõljutage kursorit nupul Värskenda

Tegelik tulemus: seal on allajoon.

Oodatud Tulemus: allajooni pole.

Sisselogimisandmed: test@test.com / mysecretpass12

Peab vältima vigu veateate kirjutamisel

Siin on mõned olulised vead, mida peaksite veaaruande kirjutamisel vältima:

• Do not write about your dissatisfaction, and never include your personal feelings.
• See ärritab inimesi, kes soovivad ülesandele keskenduda, kui laadite oma postituse paljude emotikonidega üle.
• Ärge kunagi koormake oma postitust hüüumärkidega; see tööd ei kiirenda.
• Keegi ei taha end solvatuna tunda. See hävitab motivatsiooni ja aeglustab probleemi teadvustamist.

KKK