BugIt4 min de lecture

Un modèle de rapport de bug que les développeurs liront vraiment

Un modèle de rapport de bug à copier, le rôle de chaque partie, et les habitudes qui transforment une plainte vague en ticket qu’un développeur peut corriger.

Une fiche de rapport de bug en six parties légendées : titre, étapes pour reproduire, résultat attendu, résultat obtenu, environnement et preuves.

Deux phrases coûtent aux équipes logicielles plus de temps qu’elles n’en méritent. La première : « Chez moi, ça marche. » La seconde : « Vous pouvez m’envoyer plus de détails ? »

Ces deux phrases trahissent un rapport de bug auquel il manquait quelque chose. La personne qui l’a signalé voyait clairement le problème. Le développeur, lui, ne le voit pas : le ticket attend, l’auteur du signalement passe à autre chose, et quand la réponse arrive enfin, peu de gens se souviennent des détails.

La solution n’est pas un rapport plus long. C’est un rapport qui contient les bonnes parties, sous une forme facile à parcourir. Voici un modèle, le rôle de chaque partie et quelques habitudes qui le rendent efficace.

Le modèle, prêt à coller

Copiez-le dans le champ de description de votre outil de suivi ou dans un modèle partagé par votre équipe.

``` Titre : [Zone] Ce qui ne va pas, en quelques mots

Étapes pour reproduire

  1. Point de départ (page, écran, commande)
  2. Ce que vous faites
  3. Ce que vous faites ensuite
  4. L’étape où le problème survient

Résultat attendu Ce qui aurait dû se passer.

Résultat obtenu Ce qui s’est passé à la place, y compris le message affiché.

Environnement Version ou build, plateforme, navigateur ou système d’exploitation, type de compte, et fréquence du problème.

Preuves Extrait de journal, capture d’écran, identifiant de requête ou courte vidéo.

Sévérité et raison La gravité du problème et les personnes concernées.

Tickets liés Tickets qui semblent similaires ou qui touchent la même zone. ```

On dirait un formulaire, et c’est voulu. Un développeur qui ouvre un ticket sous cette forme sait où chercher chaque réponse avant même de lire un mot.

Pourquoi chaque partie a sa place

Le titre décrit un symptôme, pas une théorie. « Le total du paiement ignore le forfait annuel après l’application d’un code promo » indique précisément à la personne chargée du tri où regarder. « Bug de prix » ne lui dit rien. Une étiquette comme [Paiement] en tête aide à parcourir une longue liste et à regrouper les tickets qui vont ensemble.

Les étapes sont numérotées et partent d’un endroit qu’un inconnu peut atteindre. Indiquez les valeurs réelles que vous avez utilisées, comme le code promo ou le forfait, car les bugs adorent les entrées précises. Faites ensuite ce que la plupart des gens sautent : rejouez vos propres étapes une fois de plus avant de déposer le ticket. Si le bug ne se reproduit pas, dites-le et précisez à quelle fréquence il est apparu. Cette honnêteté épargne un après-midi à un développeur.

Les résultats attendu et obtenu tranchent le débat dès le départ. Sans le résultat attendu, le développeur doit deviner ce que vous vouliez. Sans le résultat obtenu, il doit deviner ce que vous avez vu. Deux lignes courtes suppriment deux suppositions.

L’environnement répond à la première question d’un développeur. De quel build s’agissait-il ? La version lui indique si le problème existe encore dans le code qu’il a sous les yeux. Ajoutez la plateforme et tout réglage de compte susceptible de modifier le comportement, et indiquez la fréquence du problème. Un problème qui apparaît à chaque fois et un autre qui apparaît de temps en temps mènent à des enquêtes différentes.

Une preuve vaut mieux qu’une description. Un journal réduit à la ligne d’erreur et à quelques lignes autour vaut plus qu’un paragraphe d’explication. Une capture d’écran doit montrer assez de l’écran pour qu’on sache où vous êtes. Avant de joindre quoi que ce soit, cherchez les données personnelles et les secrets, comme les adresses e-mail et les jetons d’accès, et supprimez-les.

La sévérité doit être justifiée. « Élevée » tout court n’est qu’une opinion. « Élevée : un client payant voit un total erroné » permet à l’équipe de classer le ticket par rapport à tout le reste de la file.

Un exemple rempli

Voici le modèle avec un cas concret.

``` Titre : [Paiement] SAVE20 applique le prix mensuel après passage à l’annuel

Étapes pour reproduire

  1. Ajouter le forfait Pro au panier (mensuel)
  2. Passer la période de facturation à annuelle
  3. Appliquer le code promo SAVE20
  4. Regarder le récapitulatif de commande

Résultat attendu 20% de réduction sur le prix annuel.

Résultat obtenu 20% de réduction sur le prix mensuel, affiché comme total annuel.

Environnement Production, web, build 2.14.1, à chaque fois.

Preuves TypeError: plan.period is undefined at applyPromo (pricing.ts:88)

Sévérité et raison Élevée : un client payant voit un total erroné. ```

Voyez ce qu’un développeur peut en faire dès la première minute. Il connaît la zone, il peut suivre les étapes, et la ligne d’erreur pointe vers un fichier. Aucune question complémentaire n’est nécessaire.

Les habitudes qui gardent les rapports utiles

Les petites habitudes comptent plus qu’un modèle parfait.

  • Un bug par ticket. Deux problèmes dans un même rapport sont corrigés à des moments différents : déposez-les séparément et liez-les.
  • Cherchez avant de déposer. Quelqu’un a peut-être déjà signalé le même problème. Ajouter vos preuves à ce ticket garde toute l’histoire au même endroit.
  • Dites ce que vous avez essayé. Si une actualisation, un autre navigateur ou un autre compte change le résultat, c’est un indice qui mérite une ligne.
  • Gardez un ton neutre. Un rapport n’est pas l’endroit pour exprimer sa frustration. Les faits se corrigent plus vite que les états d’âme.
  • Mettez le ticket à jour quand vous en apprenez davantage. Un nouveau numéro de build ou une série d’étapes plus resserrée a de la valeur, même un jour plus tard.

La place de BugIt

Écrire sous cette forme, tout le monde l’approuve, mais c’est difficile à tenir à la fin d’une longue journée. C’est l’écart que BugIt comble. BugIt est un agent QA qui fonctionne dans l’assistant que vous utilisez déjà. Vous décrivez ce qui ne marche pas en une phrase approximative, et il rédige le rapport avec les mots de votre équipe : titre, étapes, résultats attendu et obtenu, sévérité et les preuves que vous lui avez fournies. Il masque les données personnelles courantes dans la mesure du possible, et vous relisez donc le brouillon avant que quoi que ce soit n’en sorte. Vous relisez chaque brouillon avant son dépôt, et rien n’est écrit dans votre outil de suivi tant que vous n’avez pas tapé FILE IT.

Vous pouvez voir comment cela fonctionne sur bugit.dev et en savoir plus sur le produit sur taskivator.com/bugit.

À retenir

Un bon rapport de bug répond aux questions du développeur avant qu’il ne les pose : où, comment, ce que vous attendiez, ce qui s’est passé, sur quel build et avec quelle gravité. Utilisez le modèle, vérifiez vos étapes une fois, joignez des preuves que vous avez épurées et justifiez votre sévérité. Les quelques minutes que vous y consacrez vous reviendront sous forme de corrections plus rapides.

DisponibleAgent QA pour votre assistant IA

BugIt

Français