Duidelijke bugrapporten opnemen met Loom
Belangrijke leerpunten
- Een korte Loom-opname laat ontwikkelaars precies zien wat er gebeurt, zonder langdurige schriftelijke uitleg en zonder ruimte voor verkeerde interpretatie.
- Door elke stap te doorlopen terwijl je uitlegt wat je doet, kan iedereen die volgt meekijken en het probleem meteen begrijpen.
- Door de ernst, impact en verwacht gedrag te benoemen in je opname, geef je ontwikkelaars alles wat ze nodig hebben om het probleem te prioriteren en een oplossing te vinden.
- Browser-, apparaat-, consolelogs en netwerkinformatie worden automatisch vastgelegd door Loom, wat de communicatie tussen auteurs en ontwikkelingsteams versnelt.
- Zet je Loom-link in Slack, e-mail of Jira en laat je hele team kijken en opmerkingen plaatsen wanneer zij willen, dus zonder te hoeven vergaderen.
Duidelijke, bruikbare bugrapporten vastleggen met Loom
Als je ooit hebt geprobeerd een bugrapport te schrijven, weet je hoeveel er verloren kan gaan. Het beschrijven van de stappen, het foutbericht en wat je op dat moment aan het doen was, geeft zelden alles weer wat een ontwikkelaar moet zien.
Dus, wat is een bugrapport in softwareontwikkeling? Een bugrapport is een document (geschreven of opgenomen) waarin precies wordt vastgelegd wat er mis ging, hoe je het kunt reproduceren en wat het verwachte gedrag had moeten zijn. Het doel is om ontwikkelaars genoeg informatie te geven om een begrip te krijgen van het probleem, het te prioriteren en op te lossen zonder overmatig te moeten schakelen.
Een bugrapportage middels video met Loom maakt dat proces aanzienlijk sneller. In plaats van een lap tekst te typen, neem je je scherm op, doorloop je het probleem en deel je een link. Dit helpt teams snel op één lijn te brengen zonder verwarring. Lees verder om te leren hoe je bugrapporten vastlegt die je team alles geven wat nodig is om problemen snel op te lossen.
Stap 1. Bepaal de bug die je wilt rapporteren
Neem voordat je gaat opnemen even de tijd om te controleren of je het probleem betrouwbaar kunt reproduceren. Een bug die maar één keer is voorgekomen en niet kan worden herhaald is veel moeilijker voor een ontwikkelingsteam om te onderzoeken.
Denk na over wat het verwachte gedrag zou moeten zijn versus wat er daadwerkelijk gebeurt. Het contrast tussen wat zou moeten werken en wat kapot is, vormt de kern van elk nuttig bugrapport. Zodra je dat duidelijk hebt, navigeer je naar het gebied van het product waar de bug optreedt, zodat je klaar bent om deze in context vast te leggen.
Stap 2. Start een Loom-schermopname
Open Loom en kies of je alleen je scherm wilt opnemen of je scherm met je camera. Alleen scherm werkt prima voor de meeste bugs. Je camera toevoegen kan helpen als je een niet-technische belanghebbende door iets heen leidt of meer persoonlijke context wilt toevoegen.
Selecteer het specifieke venster of tabblad waar de bug voorkomt. Door de opname beperkt te houden tot het juiste gebied kunnen kijkers beter volgen zonder te worden afgeleid door andere geopende vensters of niet-gerelateerde inhoud.
Stap 3. Reproduceer en leg de stappen vast die de bug triggeren
Dit is het belangrijkste deel van de opname. Doorloop elke actie die het probleem veroorzaakt en vertel wat je doet terwijl je bezig bent. Vertel wat je aanklikt, wat je verwacht dat er gebeurt en wat je in plaats daarvan ziet.
Beweeg bewust. Het kan verleidelijk zijn om door stappen die je goed kent heen te racen, maar degene die volgt ziet dit misschien voor het eerst. Langzamer gaan betekent dat minder mensen op Opnieuw afspelen drukken om het bij te kunnen houden.
Stap 4. Meld de bug en beschrijf wat er mis is
Wanneer de bug op het scherm verschijnt, stop dan en wijs deze duidelijk aan. Ga er niet van uit dat het duidelijk is. Zeg precies wat er niet werkt of incorrect is en wat er in plaats daarvan had moeten gebeuren.
Dit is het moment waarop je opname echt nuttig wordt voor softwareteams. Duidelijke uitleg op het exacte moment dat het probleem optreedt bespaart ontwikkelaars de moeite om vage tijdstempels te interpreteren of te gissen naar wat de auteur bedoelde.
Stap 5. Benadruk de impact en ernst tijdens de opname
Nadat je de bug hebt laten zien, neem je even de tijd om uit te leggen wie er last van heeft en hoe de bug de workflow of ervaring verstoort. Een bug die voorkomt dat een gebruiker kan afrekenen is heel anders dan een klein weergaveprobleem.
Benoem hoe vaak de bug voorkomt, of deze een volledige blocker is, en of er bekende tijdelijke oplossingen zijn. Die informatie helpt bij het prioriteren van de oplossing.
De functies Opmerkingen en reacties van Loom zijn hier ook nuttig. Je kunt een opmerking met tijdstempel plaatsen op het exacte moment dat de bug verschijnt, zodat iedereen die kijkt direct naar dat punt kan springen zonder door de hele video af te hoeven spelen.
Loom legt ook automatisch de technische context vast die ontwikkelaars nodig hebben om problemen op te lossen, inclusief browsertype, apparaat, consolelogs en netwerkdetails. Op deze manier volgt er geen reeks vervolgvragen meer tussen de persoon die het rapport heeft ingediend en het team dat het oplost.
Stap 6. Controleer het bugrapport, snijd het bij en verbeter het met Loom AI
Bekijk je opname voordat je deze deelt. Zoek naar alles wat onduidelijk is en knip onnodige pauzes of onbedoelde verspilde tijd eruit. Een compactere video kun je beter volgen en je kunt er makkelijker op handelen.
AI van Loom maakt dit eenvoudig. Iedereen kan een verfijnde, professionele opname maken zonder enige ervaring met videobewerking. AI-gedreven bewerking ruimt automatisch dingen op, wat vooral handig is voor teamleden die zich niet prettig voelen voor de camera maar toch duidelijk moeten communiceren.
Stap 7. Deel de opname met je team zodat de leden deze kunnen bekijken wanneer het hen uitkomt
Kopieer je Loom-link en plaats deze waar je team ook werkt, of dat nu Slack, e-mail of direct in je bugopsporingstool is.
Als je team Jira gebruikt, maakt Loom die overdracht nog soepeler. Via het tabblad Genereren is er een knop 'Aanmaken in Jira' waarmee je een werkitem direct op het Jira-bord van je team kunt aanmaken zonder Loom te verlaten. De video, context en details gaan rechtstreeks naar waar het werk wordt gedaan.
Vanaf daar kunnen teamgenoten kijken, opmerkingen plaatsen en afstemmen via asynchrone communicatie zonder dat er iets moet worden gepland. Asynchroon werk met Loom betekent dat verspreide teams problemen kunnen beoordelen, bespreken en afstemmen op een tijd die voor hen uitkomt, wat feedbackcycli versnelt en het aantal onnodige vergaderingen vermindert.
Wat zijn de belangrijkste elementen om op te nemen bij het vastleggen van een bugrapport?
Elke sterke bugrapportvideo moet deze elementen bevatten:
- Duidelijke reproductiestappen: Doorloop elke actie die de bug triggert, zodat ontwikkelaars deze kunnen reproduceren zonder te hoeven gissen.
- Zichtbaar gedrag: Laat zien wat er daadwerkelijk gebeurt op het scherm in plaats van het alleen te beschrijven.
- Verwachte vs. werkelijke resultaten: Geef duidelijk aan wat er had moeten gebeuren en wat in plaats daarvan gebeurde. Deze opzet maakt de issue direct begrijpelijk.
- Context van impact en ernst: Leg uit op wie de bug van invloed is en hoe verstorend deze is, zodat het team op basis hiervan prioriteiten kan stellen.
- Omgevingsdetails: Loom legt automatisch informatie vast over de browser en het apparaat, maar het vermelden van het besturingssysteem, de appversie of het accounttype is handig wanneer deze informatie relevant is.
Wanneer je een bugrapport met Loom vastlegt
Niet elk bugrapport vereist een Loom-video, maar er zijn situaties waarin een schermopname veel beter werkt dan alleen geschreven notities. Hier zijn enkele praktijkscenario's waarbij het vastleggen van een bugrapport zinvol is:
- Wanneer je exacte stappen moet tonen voor het reproduceren, zonder livegesprek: Misschien werken jullie in verschillende tijdzones of is de bug lastig uit te leggen in tekst.
- Wanneer Dev/QA vastloopt in opmerkingen over en weer: de ene persoon schrijft wat deze zag, de andere probeert dit zonder succes te reproduceren.
- Wanneer niet-technische auteurs duidelijk moeten laten zien wat ze zien: iemand van het klantsuccesteam of van marketing zou niet de juiste terminologie moeten hoeven leren om een bruikbaar bugrapport in te dienen.
- Wanneer een bug alleen onder specifieke omstandigheden voorkomt: als het issue verschijnt na een bepaalde reeks klikken of alleen met bepaalde gebruikersrechten, is het sneller om het te laten zien dan het te beschrijven.
- Bij visuele problemen: lay-outproblemen, weergavefouten of animatieglitches zijn vrijwel onmogelijk om accuraat schriftelijk uit te leggen.
- Wanneer je intermitterende bugs rapporteert: als het issue niet elke keer optreedt, helpt het vastleggen op video wanneer het wel voorkomt het team om iets concreets te hebben om mee te werken.
- Wanneer de bug meerdere stappen op verschillende schermen of tabbladen behelst: het doorlopen van een complexe workflow is gemakkelijker te volgen in een video dan in een genummerde lijst.
Tips voor het succesvol vastleggen van een bugrapport met Loom
Een paar gewoontes helpen enorm om je bugrapporten bruikbaarder te maken. Deze tips zijn altijd van toepassing, of je nu je eerste rapport indient of je honderdste:
- Houd het gefocust: neem indien mogelijk één video op per bug. Het combineren van meerdere issues in één opname maakt het moeilijker voor ontwikkelaars om werk te triëren en toe te wijzen.
- Vertel wat je doet: klik niet alleen maar. Leg uit wat je doet en waarom. Door elke stap uit te leggen, wordt de opname bruikbaar voor iemand zonder voorkennis.
- Gebruik cursorbeweging bewust: beweeg je muis om de aandacht te vestigen op het gebied dat ertoe doet. Door de muis in de buurt van de bug te houden terwijl deze verschijnt, kunnen kijkers precies volgen waar ze moeten kijken.
- Geef een duidelijke titel op: een titel zoals "Afrekenknop reageert niet na het toepassen van promocode Safari" is veel zinvoller dan "Bug bij afrekenen." Goede titels helpen teams zoeken, sorteren en prioriteren zonder elke video te openen.
Loom is een van de beste tools voor het rapporteren van bugs die beschikbaar zijn en kan worden geïntegreerd in softwaredocumentatietools, om alles georganiseerd op één plek te houden.
Los bugs sneller op met visuele rapporten
Geschreven bugbeschrijvingen vertragen iedereen. De persoon die het rapport indient, heeft moeite om alles vast te leggen. De ontwikkelaar die het leest, moet details raden. De QA-teamgenoot die het probeert te reproduceren, kan dat vaak niet. Een korte Loom-opname vervangt dat allemaal door iets wat iedereen in het team snel kan bekijken. De schermrecorder van loom maakt het eenvoudig om het issue duidelijk vast te leggen, een walkthrough als videopresentatie toe te voegen en deze direct te delen.
Door de video één keer te delen geef je jouw team alles wat het nodig heeft. Reken af met oproepen voor opvolging, verduidelijkende e-mails en wachten tot iemand beschikbaar is.