Kuidas kirjutada veaaruannet koos näidetega

Mis on veaaruanne? Miks on vaja head veaaruannet?

Veaaruanne on STLC-s oluline dokument, mis pakub testimismeeskonnale erinevaid eeliseid. See jälgib kõiki tarkvara testimise käigus leitud defekte, mitmeid vigu, vigu ja muid lahknevusi 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 seda tüüpi aruannete abil saab teavitada kõigist tarkvaras esinevatest defektidest ja probleemidest. See võimaldab teil ka aru saada, mis veaga on valesti, et saaksite selle parandamiseks kasutada parimat meetodit. Samuti aitab see säästa teie aega ja raha, aidates tuvastada 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.

Kuidas kirjutada veaaruannet (veaaruande mall)

Täpset veaaruande malli pole, kuna see sõltub teie veajälgimissüsteemist. 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)

Vaatame kõiki neid vigade kõrvaldamise komponente ükshaaval:

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:

Kuid ainult pealkirja lisamine veaaruandesse ei täida eesmärki. Seega, kui teie pealkirjast ei piisa, saate lisada lühikese aruande kokkuvõtte.

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 proovisin [TOOTET] ostukorvi lisada, ei juhtunud midagi, kui klõpsasin konkreetse toote ülevaate veebilehel nuppu "Lisa".

6) Reprodutseerimise sammud:

Veast teatamisel on oluline täpsustada selle taasesitamise sammud. Peaksite lisama ka toimingud, mis võivad vea põhjustada. Siin ärge tehke üldisi avaldusi.

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: Mõnikord on viga sõnadega raske kirjeldada, seega on parem luua video, et arendaja saaks programmi defekti parandada).

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.

• Veaaruannete loomisel olge konkreetne. Veenduge, et te ei lisaks kasutuid või ebaolulisi fakte.
• 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.

Vigadest teatamise tööriistad

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

• TUUR
• Zoho veajälgija
• viga zilla

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.	Ärge kirjeldage ainult seda, mis on valesti
Näiteks: Olemiseks peate avama brauseri ja sisestama saidi URL-i. Esimene väli „kasutajanimi” on valesti kirjutatud.	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, '!',
Ma ei usu, et kodulehe Ul disain on hea.	Ära kasuta oma otsustusvõimet.
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.	Kuldne reegel: ära kasuta sõna 'mõnikord'.

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:

• Ärge kirjutage oma rahulolematusest ja ärge kunagi lisage oma isiklikke tundeid.
• 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.