Le suivi, le signalement et la correction des bugs sont des processus intégraux du développement logiciel. Parmi toutes ces tâches, le signalement peut sembler être la moins importante, mais ce n’est pas le cas. Plus le rapport est bon, plus vite le bug est corrigé. À l’inverse, si le rapport ne fournit pas tous les détails essentiels ou le fait de manière incorrecte, la correction du bug prendra plus de temps, d’efforts et d’argent.
Nous avons rassemblé les pratiques les plus efficaces en matière de signalement de bugs qui seront utiles pour les testeurs QA débutants.
Comment rédiger un rapport de bug ? Meilleurs exemples et pratiques
Vous avez détecté un bug, donc votre prochaine étape est de le signaler. Voici les recommandations pour créer un rapport de bug efficace.
Fournir tous les détails essentiels
Un bon rapport de bug doit contenir :
Numéro de bug
Chaque rapport doit avoir un identifiant de bug unique — il est utilisé pour référencer un problème spécifique lors de sa discussion, de sa priorisation et de sa correction. Si vous utilisez un outil de signalement de bugs automatisé (ou quelque chose de plus universel comme Jira), le numéro sera automatiquement créé et ajouté à votre rapport.
Titre
Un titre doit expliquer brièvement ce qui ne va pas. Par exemple, « Le bouton Contactez-nous ne fonctionne pas ». En regardant le titre, votre équipe obtiendra une idée de base du problème et comprendra s’il s’est produit auparavant.
Environnement
Si vous ne spécifiez pas l’environnement, il peut être impossible de reproduire le bug. Par exemple, vous avez détecté un bug dans la version iOS de l’application. Ensuite, un développeur a essayé de le reproduire dans la version Android, mais rien ne s’est passé — tout fonctionnait bien. De telles situations sont possibles, donc fournissez toujours des détails sur l’environnement. Ils peuvent inclure les éléments suivants :
- – Appareil (spécifier le modèle exact)
- – Système d’exploitation et sa version
- – Compte utilisé
- – Version de l’application
- – Navigateur et sa version
- – Type de connexion
Étapes pour reproduire
Tout bug doit être reproductible, sinon il ne sera pas corrigé. Par conséquent, lors de la création de votre rapport, décrivez étape par étape quelles actions conduisent à l’apparition du bug. Ne manquez rien, même les détails les plus évidents comme la connexion au système. Il serait également utile d’essayer de reproduire le bug par vous-même plusieurs fois, puis de préciser combien de tentatives ont réussi en termes d’activation du bug.
Résultat attendu
Expliquez ce qui devrait se passer si vous suivez les étapes de reproduction quand tout fonctionne correctement. Si nous prenons l’exemple de « Le bouton Contactez-nous ne fonctionne pas » une fois de plus, le résultat attendu peut ressembler à ceci : « Le formulaire de contact s’affiche ».
Résultat réel
Ici, vous devez décrire le bug lui-même. Que se passe-t-il après avoir suivi toutes les étapes de reproduction ? Qu’est-ce qui ne va pas ? Voici un exemple : « Le formulaire de contact ne s’affiche pas ».
Preuves
Joignez des images et des vidéos — cela accélérera le processus de reproduction du bug.
Sévérité
Quel est le niveau de criticité du bug ? Quel impact a-t-il sur la fonctionnalité du système ? Ces informations aideront les managers à prioriser leurs tâches, ce qui est particulièrement important lorsqu’il y a de nombreux bugs à corriger. Par exemple, un bug qui bloque l’utilisation de l’application doit être marqué comme critique, mais s’il s’agit d’une faute de frappe dans le texte, vous pouvez le marquer comme trivial.
Votre nom
Indiquez votre nom et vos coordonnées, afin que les développeurs puissent vous contacter facilement. Cela peut être nécessaire si vous n’utilisez pas de logiciel de test spécial pour le signalement des bugs.
Avant de passer à la prochaine recommandation, jetez un œil à cet exemple d’un bon rapport de bug dans Jira. Il comprend le numéro de bug (généré automatiquement), le titre, l’environnement, les étapes de reproduction (avec une précondition), les résultats attendus et réels, une vidéo, la priorité et le nom du rapporteur :
Soyez précis
Évitez de rédiger un essai entier — vous devez rester concentré et être précis. Fournissez simplement tous les détails essentiels (nous les avons décrits dans le paragraphe précédent), expliquez clairement ce qui ne va pas et comment reproduire le bug, et c’est tout.
N’hésitez pas
Lorsque vous détectez un bug, ne reportez pas la création du rapport. Faites-le immédiatement — sinon, vous pourriez oublier certaines étapes essentielles pour sa reproduction ou simplement oublier de rédiger un rapport. C’est particulièrement important pour les bugs critiques qui doivent être corrigés le plus rapidement possible.
Vérifiez le rapport
Après avoir rédigé le rapport, relisez-le une fois de plus. Certaines phrases peuvent-elles être mal interprétées ? Y a-t-il quelque chose d’ambigu ? Si oui, résolvez ces problèmes avant d’envoyer le rapport. Si vous ne le faites pas, la correction du bug prendra plus de temps.
Évitez les critiques
Évidemment, les bugs sont irritants, mais critiquer les développeurs ne rendra pas votre rapport meilleur et plus efficace. Soyez discret (même si le bug est très ennuyeux ou se produit à nouveau après qu’il aurait dû être corrigé), et décrivez simplement clairement le problème. Rappelez-vous, un bon rapport est un rapport rédigé dans un langage simple et sobre, sans aucun abus.
Utiliser des outils et des services
Voici quelques-uns des outils et services les plus pratiques utilisés par les :
Jira
Nous avons déjà mentionné Jira, et si votre équipe l’utilise, il sera très pratique pour vous de créer des rapports de bugs là-bas. Vous n’aurez qu’à choisir le projet approprié, spécifier le type de problème (bug), ajouter le résumé et la description. Des images et des vidéos peuvent également être jointes. De plus, si vous savez qui peut traiter ce problème, vous pouvez l’attribuer directement à cette personne.
HipTest Publisher
La mission de l’outil HipTest Publisher (précédemment connu sous le nom HipTest) est de lire les projets de gestion des tests depuis CucumberStudio. Avec HipTest, vous pouvez écrire des scénarios de test, exporter des projets et des exécutions de tests, transmettre les résultats à CucumberStudio. Ce qui est encore plus pratique, vous pouvez créer des rapports de bugs Jira directement depuis HipTest.
Backlog
Le logiciel de signalement de bugs Backlog offre de nombreuses solutions utiles, telles que la gestion de projets et de tâches, la gestion des flux de travail, le contrôle de version. Le signalement de bugs en fait partie. Vous pouvez créer et prioriser des problèmes de bugs et suivre la progression tout comme dans Jira. Il est également possible d’importer des données Jira dans Backlog.
ReQtest
Les fonctionnalités de ReQtest incluent la gestion des exigences, la gestion des tests, l’intégration de l’automatisation des tests, l’intégration Jira et, évidemment, le suivi des bugs. Les bugs peuvent être signalés à partir des étapes de test échouées. L’ajout d’images et de vidéos est également possible.
Bird Eats Bug
Bird Eats Bug est une extension Chrome qui permet de capturer des bugs par enregistrement d’écran. Le rapport comprendra les journaux réseau et console, ainsi que les informations système. La durée d’enregistrement est illimitée et le microphone peut également être utilisé. Chaque enregistrement peut être accompagné d’une description où vous pouvez fournir des détails supplémentaires si nécessaire. Vous pouvez également prendre des captures d’écran qui seront également accompagnées des journaux console et d’autres données importantes. Bird Eats Bug peut être intégré avec d’autres outils et services comme Jira et Slack, vous pouvez donc envoyer vos rapports directement là-bas.
Réflexions finales
Pour créer un bon rapport de bug, vous devez être précis et fournir tous les détails, tels que le numéro de bug, le titre, l’environnement, les étapes de reproduction, le résultat attendu et réel, les captures d’écran et/ou les vidéos, la sévérité, et votre nom avec vos coordonnées. Rédigez vos rapports dans un langage clair, ne critiquez pas les développeurs et vérifiez les rapports avant de les envoyer. Et, évidemment, n’hésitez pas à rédiger et envoyer vos rapports — faites-le juste après avoir détecté un bug.
En ce qui concerne les outils et services, Jira est l’une des options les plus populaires et pratiques, et votre équipe l’utilise peut-être déjà. Si c’est le cas, ne négligez pas ses fonctionnalités. En tout cas, toute l’équipe doit utiliser une seule plateforme pour la gestion de projet, car cela garantit une collaboration adéquate et une réalisation efficace des tâches. Cependant, certains outils (comme Bird Eats Bug) peuvent être utilisés indépendamment grâce à leurs fonctionnalités d’intégration.
Obtenez une perspective impartiale de votre application avec un rapport actionnable gratuitement
