Hoe u een bugrapport met voorbeelden schrijft (2024)

Wat is een bugrapport? Waarom heb je een goed bugrapport nodig?

Bug Report is een belangrijk document in STLC dat verschillende voordelen biedt voor het testteam. Het houdt alle defecten, meerdere bugs, fouten en andere discrepanties bij die zijn gevonden tijdens het testen van software en rapporteert deze.

Het doel van deze post-testdocumentatie is om informatie te verstrekken aan het betrokken team van professionals over het aantal bugs dat tijdens het testproces is aangetroffen.

Your software ontwikkelingsingenieur Met dit type rapport kan men op de hoogte worden gesteld van alle defecten en problemen in de software. U kunt er ook achter komen wat er mis is met een bug, zodat u de beste methode kunt gebruiken om deze te repareren. Het helpt u ook tijd en geld te besparen door u te helpen bugs en problemen op te sporen.

Waarom zou u zich zorgen maken over goede bugverklaringen?

Dit is het punt waarmee u rekening moet houden bij het schrijven van een goed, gedetailleerd softwarebugrapport:

Het fungeert als leidraad om dezelfde bug in toekomstige releases te helpen voorkomen.
Bespaar tijd voor communicatie (e-mails, oproepen).
Minder werk voor ontwikkelaars (ze doen precies wat jij wilt).
Je zult minder knelpunten in het project tegenkomen; bugs zullen sneller en efficiënter worden opgelost.

Een bugrapport schrijven (bugrapportsjabloon)

Er is geen exact bugrapportsjabloon, omdat dit afhangt van uw bugvolgsysteem. Uw sjabloon kan anders zijn.

Echter, het vervolgwing gemeenschappelijke velden zijn altijd nodig als u een bugrapport wilt schrijven:

Bug-ID/titel.
Ernst en prioriteit.
Omschrijving
Milieu
Stappen om te reproduceren.
Verwacht resultaat.
Werkelijke resultaat.
Bijlagen (screenshots, video's, tekst)

Laten we al deze bug-tacking-componenten een voor een bekijken:

1) Titel/bug-ID:

Elke bug moet een uniek identificatienummer krijgen. Tools voor het rapporteren van bugs moeten uniek zijn numbers voor de nieuwe bugs, zodat we de bug gemakkelijk kunnen identificeren.

Voorbeelden:

❌ Slecht: “Ik kan het product niet meer zien, maar niet.”

vaag
Agressief
Te woordenrijk

vraagt om implementatie van een oplossing.

✅ Goed: “WAGENTJE – Nieuwe items toegevoegd aan de winkelwagen die niet verschijnen”.

2) Ernst van bugs:

De ernst van de bug is een zeer belangrijke factor in het bugrapport. Het beschrijft het effect van het defect op de prestaties van de applicatie.

Blokkers: Deze fout zorgt ervoor dat de app mislukt.
Major: Een kritieke fout duidt op een grote verandering in de bedrijfslogica.
Minor: Een probleem dat geen invloed heeft op de functionaliteit van de applicatie, maar wel op de verwachte resultaten.
Triviaal: Het heeft geen invloed op de functionaliteit of operavan de app. Het kan een typefout zijn.

3) Bugprioriteit:

Following is de algemene gradatie om de bugprioriteit te bepalen:

Hoog: Het omvat alles wat de stroom beïnvloedt of het app-gebruik blokkeert.
Medium: Het heeft een negatieve invloed op de gebruikerservaring.
Minor: Alle andere fouten zoals (typefouten, ontbrekende pictogrammen, lay-outproblemen, enz.).

4) Omgeving:

Een bug kan in een specifieke omgeving voorkomen en niet in andere. Soms verschijnt er bijvoorbeeld een bug bij het uitvoeren van de website Firefox, of een app-storing alleen wanneer deze op een Android apparaat en werkt prima op de iPhone.

Deze bugrapporten kunnen alleen worden geïdentificeerd door middel van cross-browser- of cross-device-tests. Bij het rapporteren van de bug moeten QA's dus kunnen specificeren of de bug in een of meer specifieke omgevingen moet worden waargenomen.

5) Samenvatting:

Het toevoegen van alleen de Titel aan het bugrapport heeft echter geen nut. Dus als uw titel niet genoeg is, kunt u een korte rapportsamenvatting toevoegen.

Uw samenvatting in zo min mogelijk woorden, inclusief wanneer en hoe de bug zich heeft voorgedaan. Uw titel en bugbeschrijving moeten ook worden gebruikt bij zoekopdrachten, dus u moet ervoor zorgen dat u belangrijke trefwoorden hebt afgedekt.

Voorbeelden:

Bad: “Ik probeerde dingen aan de test toe te voegen, maar er verscheen niets toen ik dat deed of op de knop klikte.”
Goed: “Toen ik probeerde [PRODUCT] aan het winkelwagentje toe te voegen, gebeurde er niets toen ik op de knop ‘toevoegen’ klikte op de specifieke webpagina met het productoverzicht.”

6) Stappen om te reproduceren:

Bij het melden van een bug is het belangrijk om de stappen te specificeren om deze te reproduceren. U moet ook acties opnemen die de bug kunnen veroorzaken. Maak hier geen algemene uitspraken.

Wees specifiek over de te volgen stappen:

Hier is een voorbeeld van een goedgeschreven procedure:

Stappen:

Selecteer product X1.
Klik op Toevoegen aan winkelwagen.
Klik op Verwijderen om het product uit de winkelwagen te verwijderen.

7) Verwacht resultaat:

In bugrapporten is het belangrijk om het verwachte resultaat per technische taak, het ontwerp van de testcase-uitkomsten of volgens de mening van de tester te beschrijven. Dit alles helpt ontwikkelaars zich te concentreren op het snel vinden van de benodigde informatie.

Bijvoorbeeld:

Verplichte velden moeten rood gemarkeerd zijn nadat u op de knop "Verzenden" hebt geklikt.

8) Werkelijk resultaat:

Zoals de naam al doet vermoeden, beschrijft dit veld het daadwerkelijke effect van de bug. Het is erg belangrijk om een duidelijke beschrijving van het daadwerkelijke resultaat te schrijven.

9) Bijlagen (screenshots en video's):

In bugrapporten is het het beste om bestanden aan bugrapporten toe te voegen, waardoor het gemakkelijker wordt om informatie waar te nemen wanneer u deze visueel moet weergeven:

Bijvoorbeeld:

Screenshot: Schermafbeeldingen kunnen fouten in het programma gemakkelijk uitwerken; Dit is handig wanneer de bug wordt gemarkeerd met een specifieke annotatie, cirkel of pijlafbeelding).
Video: Soms is het moeilijk om de bug in woorden te beschrijven, dus het is beter om een video te maken zodat de ontwikkelaar het defect in het programma kan verhelpen).

10) Betrokken versie:

Het is de getroffen softwareversie waarin de bug wordt gerapporteerd.

11) Fix-versie:

Het is de softwareversie waarin de bug is opgelost. Dus als de QA die de bug heeft gerapporteerd, controleert of deze is verholpen, gebruikt hij de juiste softwareversie.

12) Doelversie:

De doelversie waarop een bug moet worden gericht om te worden opgelost. Wanneer het ontwikkelingsteam dus werkt aan het oplossen van een bug, richten ze zich meestal op een bepaalde applicatieversie.

13) Datum gesloten:

Het is de datum waarop de bug is gesloten door het softwaretestteam. Het sluiten van een bug is een essentieel en integraal onderdeel van het testen van software.

14) Status:

Wanneer een nieuwe bug wordt aangemaakt, moet de status ervan open zijn. Daarna doorloopt het fasen zoals In uitvoering, Opgelost, Actief, Opnieuw openen, enz.

Tips voor het schrijven van bugrapporten

Hier zijn enkele belangrijke tips die u moet onthouden bij het schrijven van een effectief bugrapport:

Wees specifiek bij het maken van bugrapporten. Zorg ervoor dat u geen nutteloze of irrelevante feiten vermeldt.
U moet de bug onmiddellijk melden zodra deze wordt gedetecteerd.
Bereid het rapport gedetailleerd voor, zodat de ontwikkelaar de feiten en informatie kan gebruiken om het probleem op te lossen.
U moet hetzelfde exemplaar van de bug testen op andere vergelijkbare modules ter validatie.
Controleer het bugrapport minstens één keer voordat u het verzendt.
Zorg ervoor dat het bugrapport de beschrijving van slechts één fout bevat.
Tenslotte moet je niet bang zijn om de Projectmanager om hulp te vragen als je ergens onduidelijk over bent.

Hulpmiddelen voor bugrapportage

Het bugrapportageproces, dat handmatig wordt uitgevoerd, wordt nu uitgevoerd met verschillende bugrapportagetools die op de markt verkrijgbaar zijn.

JIRA
Zoho Bugtracker
Bugzilla

U kunt onze gedetailleerde beoordeling van de beste bugrapportagetool.

Veelvoorkomend probleem en oplossing bij het schrijven van een bugrapport:

Hier zijn enkele veelvoorkomende problemen en hun oplossingen bij het schrijven van een bugrapport:

Voorbeeld van bugrapport	probleem
Als je 2 met 3 vermenigvuldigt, is het antwoord positief.	Rapporteer het patroon, geen voorbeeld.
Om dit te voorkomen, wordt de lijst alfabetisch geordend wanneer u een nieuw item toevoegt.	Beschrijf niet alleen wat er mis is
Bijvoorbeeld: Hiervoor moet u uw browser openen en de URL van de site typen. Het eerste veld, 'gebruikersnaam', is verkeerd gespeld.	Altijd direct to the point (Vertel nooit het verhaal!).
De naam van de klant in het rapport is verkeerd gespeld. Prioriteit: hoog, ernst: hoog	Meng nooit prioriteit en ernst.
De belastingberekeningsformule is ONJUIST !!??	Maakt geen gebruik van CAPS, rode letters, rode cirkels, '!',
Ik denk niet dat het Ul-ontwerp van de startpagina goed is.	Gebruik je oordeel niet.
Voorbeeld van een onduidelijke beschrijving: Voer over onze discussie van vandaag de vereiste actie uit voor deze pagina.	Zorg ervoor dat je beschrijving voor iedereen begrijpelijk is.
De pagina-achtergrond moet blauw, oranje of groen zijn, maar u kunt deze ook zwart of wit maken. Dit is niet goed, omdat het onduidelijk is wat er nodig is van het webontwikkelings- en ontwerpteam	Minimaliseer de opties
De belastingberekeningsformule werkt soms niet zoals verwacht.	De gouden regel: gebruik het woord ‘soms’ niet.

Voorbeeld van bugrapport

Hier is een klein voorbeeld van een bugrapport:

[MIJN ACCOUNT] Onderstreping wordt weergegevenyed wanneer u met de muis over de knop Bijwerken gaat.

Beschrijving: We moeten de onderstreping verwijderen wanneer u met de muis over de knop Bijwerken in het gedeelte Mijn account beweegt.

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

Browser/besturingssysteem: Chroom 25. OSX Yosemite 10.10.2

Stappen om te reproduceren:

1. Ga naar www.test.com

2. Inloggen via inloggegevens

3. Navigeer naar Mijn account

4. Ga met de muis over de knop Bijwerken

Werkelijke resultaat: er is een onderstreping.

Verwacht resultaat: geen onderstreping.

Inloggegevens: test@test.com / mysecretpass12

Moet fouten vermijden bij het schrijven van bugrapporten

Hier zijn enkele belangrijke fouten die u moet vermijden bij het schrijven van een bugrapport:

Schrijf niet over uw ontevredenheid en vermeld nooit uw persoonlijke gevoelens.
Het irriteert mensen die zich op de taak willen concentreren als je je bericht overbelast met veel emoticons.
Overbelast uw bericht nooit met uitroeptekens; het versnelt het werk niet.
Niemand wil zich beledigd voelen. Het vernietigt de motivatie en vertraagt de realisatie van het probleem.

Je houdt misschien van:

Perl-zelfstudie: Variabele, Array, Hashes met programmeervoorbeeld
WebPagetest API-zelfstudie met voorbeeld
Verschil tussen waterval versus spiraalvormig en incrementeel model
Capability Maturity Model (CMM) en zijn niveaus in Software Engineering
Incrementeel model in SDLC: gebruik, voordeel en nadeel
Wat is het RAD-model? Fasen, voordelen en nadelen
Spiraalmodel: wanneer te gebruiken? Voor-en nadelen
Wat is het watervalmodel in SDLC? Voor-en nadelen