BugIt3 min de lecture

Comment rédiger un titre de bug qui sera traité lors du tri

Le titre d’un bug est la seule ligne que la plupart des gens lisent. Découvrez ce qu’il faut y mettre, ce qu’il faut laisser de côté, et comment le tester dans la liste de l’outil de suivi avant de déposer.

Un titre de bug vague à côté d’un titre clair qui nomme la zone, le symptôme et la condition.

Ouvrez un outil de suivi bien rempli et regardez la vue en liste. Vous voyez une ligne par ticket : un identifiant, un statut et un titre. Rien d’autre. C’est sur cette ligne qu’un bug est accepté, ignoré, fusionné avec un autre ticket ou renvoyé avec une question, et la décision est souvent prise avant que quiconque n’ouvre la description.

Le titre travaille donc plus que n’importe quelle autre ligne que vous écrivez. Voici comment le rendre à la hauteur de ce rôle.

Ce qu’un titre doit faire

Dans la vue en liste, un titre a trois rôles.

  • Dire où. La zone, l’écran ou la commande, pour que la bonne personne le remarque.
  • Dire ce qui ne va pas. Le symptôme que vous avez vu, pas votre théorie sur la cause.
  • Être trouvable. Quelqu’un qui tombera sur le même bug le mois prochain cherchera quelques mots. Votre titre doit contenir les mots qu’il utiliserait.

Une forme qui fonctionne

Essayez cet ordre : où, puis ce qui s’est passé, puis la condition qui compte.

`` Paiement : code promo appliqué deux fois quand on utilise le bouton Retour Export : CSV vide quand la période chevauche deux années Connexion : erreur 500 affichée après réinitialisation du mot de passe sur le web mobile ``

Chaque titre nomme une zone, énonce le symptôme et ajoute la seule condition qui distingue ce bug des bugs similaires. Un développeur qui parcourt la liste peut dire lequel le concerne.

Les titres qui vous coûtent

| Titre | Ce qui ne va pas | |---|---| | « Bug dans le paiement » | Aucun symptôme. Cela pourrait être n’importe quel ticket sur le paiement. | | « Corriger l’export » | Une tâche, pas un signalement. Cela suppose une cause et cache les preuves. | | « Le bouton ne marche pas » | Quel bouton, et que veut dire « ne marche pas » ? | | « URGENT!!! Appli cassée » | L’urgence a sa place dans le champ de priorité, et « cassée » n’est pas un symptôme. | | « Plantage intermittent » | Où ? Dans quelles conditions ? Il sera fusionné avec le ticket le plus proche. |

Décrivez le symptôme, pas l’hypothèse

« Cache non vidé après l’enregistrement » est une hypothèse. « L’ancien prix reste affiché après l’enregistrement d’un nouveau » est ce que vous avez vu. Si votre hypothèse est fausse, une hypothèse dans le titre envoie le développeur vers le mauvais code et rend le ticket plus difficile à trouver pour quelqu’un qui voit le même symptôme avec une autre cause. Mettez votre théorie dans la description, présentée comme une théorie.

Incluez le texte de l’erreur, quand il y en a un

Si le produit a affiché un message, une courte citation de ce message est le meilleur terme de recherche que vous puissiez offrir à la personne suivante. Restez bref et laissez de côté les identifiants, les e-mails et tout ce qui est personnel. « Paiement refusé avec “card declined” pour une carte valide » retrouve ses jumeaux.

Testez le titre avant de déposer

Faites deux vérifications rapides.

  1. Lisez-le seul. Cachez la description. Un inconnu pourrait-il dire ce qui ne va pas, et où ?
  2. Faites une recherche avec. Collez votre titre dans la recherche de l’outil de suivi. Si un ticket antérieur apparaît, lisez-le avant de déposer. Si votre titre ne trouve pas un ticket dont vous savez qu’il existe, le titre de ce ticket est faible, et le vôtre a peut-être besoin des mots qui lui manquent. Notre article sur le repérage des bugs en double avant le dépôt traite de la recherche elle-même.

Gardez des titres assez courts pour être lus dans une liste, et déplacez les détails dans la description. Un titre qui s’étale sur plusieurs lignes contient généralement une description.

La place de BugIt

Les titres sont faciles à réussir quand on est calme, et faciles à rater quand on est pressé. Quand vous décrivez un problème à BugIt dans une note en vrac, il rédige un rapport avec un titre de cette forme, et il cherche dans votre outil de suivi les tickets similaires avant que vous ne voyiez le brouillon. La recherche se fait en lecture seule. Vous relisez le brouillon, modifiez le titre si vous le souhaitez, et BugIt masque les données personnelles courantes, au mieux. Rien n’est écrit dans votre outil de suivi tant que vous n’avez pas tapé FILE IT.

Découvrez comment cela fonctionne sur taskivator.com/bugit et bugit.dev.

À retenir

Rédigez le titre pour la vue en liste : où, ce qui s’est passé, et la seule condition qui compte. Décrivez ce que vous avez vu, citez l’erreur s’il y en a une, et cherchez avec votre propre titre avant de déposer.

DisponibleAgent QA pour votre assistant IA

BugIt

Français