Menu

Comment rédiger un bon rapport de bogue? Trucs et astuces

how write good bug report

Essayez Notre Instrument Pour Éliminer Les Problèmes

Pourquoi un bon rapport de bogue?

Si votre rapport de bogue est efficace, ses chances d'être corrigées sont plus élevées. La résolution d'un bogue dépend donc de l'efficacité avec laquelle vous le signalez. Signaler un bug n'est rien d'autre qu'une compétence et je vais vous expliquer comment atteindre cette compétence.

«Le but de la rédaction d'un rapport de problème (rapport de bogue) est de corriger les bogues» - Par Cem Kaner. Si un testeur ne signale pas correctement un bogue, le programmeur rejettera probablement ce bogue en le déclarant irréproductible.

Comment rédiger un bon rapport de bogue

Cela peut nuire au moral des testeurs et parfois aussi à l'ego. (Je suggère de ne garder aucun type d'ego. L'ego est comme 'J'ai signalé le bug correctement', 'Je peux le reproduire', 'Pourquoi il / elle a rejeté le bug?', 'Ce n'est pas ma faute' etc. ,).

Ce que vous apprendrez:

Quelles sont les qualités d'un bon rapport de bogue logiciel?

Tout le monde peut rédiger un rapport de bogue. Mais tout le monde ne peut pas rédiger un rapport de bogue efficace.

Vous devriez être capable de faire la distinction entre un rapport de bogue moyen et un bon rapport de bogue. Comment faire la distinction entre un bon et un mauvais rapport de bogue? C’est très simple, appliquez les caractéristiques et techniques suivantes pour signaler un bogue.

Les caractéristiques et techniques comprennent

# 1) Avoir un numéro de bogue clairement spécifié: Attribuez toujours un numéro unique à chaque rapport de bogue. Ceci, à son tour, vous aidera à identifier l'enregistrement de bogue. Si vous utilisez un outil de rapport de bogue automatisé, ce numéro unique sera généré automatiquement à chaque fois que vous signalez le bogue.

Notez le numéro et une brève description de chaque bogue que vous avez signalé.

# 2) Reproductible: Si votre bogue n'est pas reproductible, il ne sera jamais corrigé.

Vous devez clairement mentionner les étapes pour reproduire le bogue. N'assumez ni ne sautez aucune étape de reproduction. Un bogue décrit étape par étape est facile à reproduire et à corriger.

# 3) Soyez précis: N'écrivez pas un essai sur le problème.

Soyez précis et précis. Essayez de résumer le problème en un minimum de mots mais de manière efficace. Ne combinez pas plusieurs problèmes même s'ils semblent similaires. Rédigez différents rapports pour chaque problème.

Rapport de bogue efficace

Le rapport de bogue est un aspect important du test de logiciel. Un rapport de bogue efficace communique bien avec l'équipe de développement et évite toute confusion ou mauvaise communication.

Un bon rapport de bogue devrait être clair et concis sans aucun point clé manquant. Tout manque de clarté conduit à des malentendus et ralentit également le processus de développement. La rédaction et la notification des défauts sont l'un des domaines les plus importants mais négligés du cycle de vie des tests.

Une bonne rédaction est très importante pour signaler un bogue. Le point le plus important qu'un testeur doit garder à l'esprit est ne pas utiliser un ton imposant dans le rapport. Cela brise le moral et crée une relation de travail malsaine. Utilisez un ton suggestif.

Ne présume pas que le développeur a fait une erreur et que vous pouvez donc utiliser des mots durs. Avant de signaler, il est tout aussi important de vérifier si le même bogue a été signalé ou non.

Un bug en double est un fardeau dans le cycle de test. Consultez la liste complète des bogues connus. Parfois, les développeurs ont pu connaître le problème et l'ignorer pour une version future. Des outils comme Bugzilla qui recherche automatiquement les bogues en double peuvent également être utilisés. Cependant, il est préférable de rechercher manuellement tout bogue en double.

Les informations d'importation qu'un rapport de bogue doit communiquer sont 'Comment?' et où?' Le rapport doit indiquer clairement comment le test a été effectué et où le défaut s'est produit exactement. Le lecteur devrait facilement reproduire le bogue et trouver où se trouve le bogue.

Gardez à l'esprit que le objectif de rédaction du rapport de bogue est de permettre au développeur de visualiser le problème. Il / Elle doit clairement comprendre le défaut du rapport de bogue. N'oubliez pas de donner toutes les informations pertinentes que le développeur recherche.

Gardez également à l'esprit qu'un rapport de bogue serait conservé pour une utilisation future et devrait être bien rédigé avec les informations requises. Utilisez des phrases significatives et des mots simples pour décrire vos bugs. N'utilisez pas de déclarations déroutantes qui font perdre du temps au réviseur.

Signalez chaque bogue comme un problème distinct. En cas de problèmes multiples dans un même rapport de bogue, vous ne pouvez pas le fermer tant que tous les problèmes ne sont pas résolus.

Par conséquent, il est préférable de diviser les problèmes en bogues distincts . Cela garantit que chaque bogue peut être traité séparément. Un rapport de bogue bien rédigé aide un développeur à reproduire le bogue sur son terminal. Cela les aide également à diagnostiquer le problème.

Comment signaler un bug?

Utilisez le modèle de rapport de bogue simple suivant:

Il s'agit d'un format de rapport de bogue simple. Cela peut varier en fonction de l'outil de rapport de bogue que vous utilisez. Si vous rédigez un rapport de bogue manuellement, certains champs doivent être mentionnés spécifiquement comme le numéro de bogue, qui doit être attribué manuellement.

Journaliste: Votre nom et votre adresse e-mail.

Produit: Dans quel produit vous avez trouvé ce bogue.

Version: La version du produit le cas échéant.

Composant: Ce sont les principaux sous-modules du produit.

Plate-forme: Mentionnez la plate-forme matérielle sur laquelle vous avez trouvé ce bogue. Les différentes plates-formes telles que «PC», «MAC», «HP», «Sun», etc.

Système opérateur: Mentionnez tous les systèmes d'exploitation sur lesquels vous avez trouvé le bogue. Systèmes d'exploitation comme Windows, Linux, Unix, SunOS, Mac OS. Mentionnez les différentes versions du système d'exploitation comme Windows NT, Windows 2000, Windows XP, etc., le cas échéant.

Priorité: Quand un bogue doit-il être corrigé? La priorité est généralement définie de P1 à P5. P1 comme «corriger le bogue avec la priorité la plus élevée» et P5 comme «corriger quand le temps le permet».

Gravité: Ceci décrit l'impact du bogue.
Types de gravité:

  • Bloqueur: Aucun autre travail de test ne peut être effectué.
  • Critique: Crash d'application, perte de données.
  • Majeur: Perte de fonction majeure.
  • Mineur: Perte fonctionnelle mineure.
  • Banal: Quelques améliorations de l'interface utilisateur.
  • Renforcement: Demande d'une nouvelle fonctionnalité ou d'une amélioration de l'existant.

Statut: Lorsque vous enregistrez le bogue dans un système de suivi de bogue, le statut du bogue par défaut sera «Nouveau».
Plus tard, le bogue passe par différentes étapes telles que Corrigé, Vérifié, Rouvrir, Ne sera pas corrigé, etc.

=> Cliquez ici pour en savoir plus sur le cycle de vie détaillé des bogues.

Affecter à: Si vous savez quel développeur est responsable de ce module particulier dans lequel le bogue s'est produit, vous pouvez spécifier l'adresse e-mail de ce développeur. Sinon, gardez-le vide car cela attribuera le bogue au propriétaire du module sinon le Manager attribuera le bogue au développeur. Ajoutez éventuellement l'adresse e-mail du responsable dans la liste CC.

URL: L'URL de la page sur laquelle le bogue s'est produit.

Sommaire: Un bref résumé du bogue principalement en 60 mots ou moins. Assurez-vous que votre résumé reflète la nature du problème et son emplacement.

Description: Une description détaillée du bogue.

Utilisez les champs suivants pour le champ de description:

  • Reproduisez les étapes: En clair, mentionnez les étapes pour reproduire le bogue.
  • Résultat attendu: Comment l'application doit se comporter lors des étapes mentionnées ci-dessus.
  • Résultat actuel: Quel est le résultat réel de l'exécution des étapes ci-dessus, c'est-à-dire le comportement du bogue.

Voici les étapes importantes du rapport de bogue. Vous pouvez également ajouter le «Type de rapport» comme champ supplémentaire qui décrira le type de bogue.

Les types de rapport incluent:

1) Erreur de codage
2) Erreur de conception
3) Nouvelle suggestion
4) Problème de documentation
5) Problème matériel

Caractéristiques importantes de votre rapport de bogue

Vous trouverez ci-dessous les caractéristiques importantes du rapport de bogue:

# 1) Numéro / identifiant du bogue

Un numéro de bogue ou un numéro d'identification (comme swb001) facilite grandement le rapport de bogue et la référence à un bogue. Le développeur peut facilement vérifier si un bogue particulier a été corrigé ou non. Cela rend l'ensemble du processus de test et de nouveau test plus fluide et plus facile.

# 2) Titre du bogue

Un titre de bogue est lu plus souvent que toute autre partie du rapport de bogue. Cela devrait tout dire sur ce que contient le bogue.

Le titre du bogue doit être suffisamment suggestif pour que le lecteur puisse le comprendre. Un titre de bogue clair le rend facile à comprendre et le lecteur peut savoir si le bogue a été signalé plus tôt ou a été corrigé.

# 3) Priorité

En fonction de la gravité du bogue, une priorité peut être définie pour celui-ci. Un bug peut être un bloqueur, critique, majeur, mineur, trivial ou une suggestion. Une priorité de bogue de P1 à P5 peut être donnée afin que les plus importants soient visualisés en premier.

# 4) Plateforme / Environnement

La configuration du système d'exploitation et du navigateur est nécessaire pour un rapport de bogue clair. C'est le meilleur moyen de communiquer comment le bogue peut être reproduit.

Sans la plate-forme ou l'environnement exact, l'application peut se comporter différemment et le bogue du côté du testeur peut ne pas se répliquer du côté du développeur. Il est donc préférable de mentionner clairement l'environnement dans lequel le bogue a été détecté.

meilleur logiciel pour récupérer des fichiers supprimés

# 5) Description

La description du bogue aide le développeur à comprendre le bogue. Il décrit le problème rencontré. La mauvaise description créera de la confusion et fera perdre du temps aux développeurs et aux testeurs.

Il est nécessaire de communiquer clairement sur l'effet de la description. Il est toujours utile d’utiliser des phrases complètes. C'est une bonne pratique de décrire chaque problème séparément au lieu de les émietter complètement. N'utilisez pas de termes tels que «je pense» ou «je crois».

# 6) Étapes à suivre pour reproduire

Un bon rapport de bogue doit clairement mentionner les étapes à reproduire. Les étapes doivent inclure les actions à l'origine du bogue. Ne faites pas de déclarations génériques. Soyez précis dans les étapes à suivre.

Un bon exemple de procédure bien écrite est donné ci-dessous

Pas:

  • Sélectionnez le produit Abc01.
  • Cliquez sur Ajouter au panier.
  • Cliquez sur Supprimer pour supprimer le produit du panier.

# 7) Résultat attendu et réel

Une description de bogue est incomplète sans les résultats attendus et réels. Il est nécessaire de décrire le résultat du test et ce à quoi l'utilisateur doit s'attendre. Le lecteur doit savoir quel est le résultat correct du test. Indiquez clairement ce qui s'est passé pendant le test et quel en a été le résultat.

# 8) Capture d'écran

Une image vaut mieux que mille mots. Prenez une capture d'écran de l'instance de l'échec avec un sous-titrage approprié pour mettre en évidence le défaut. Mettez en surbrillance les messages d'erreur inattendus avec une couleur rouge clair. Cela attire l'attention sur la zone requise.

Quelques conseils bonus pour rédiger un bon rapport de bogue

Vous trouverez ci-dessous quelques conseils supplémentaires pour rédiger un bon rapport de bogue:

# 1) Signalez le problème immédiatement

Si vous trouvez un bogue pendant le test, alors n'attendez pas pour rédiger un rapport de bogue détaillé plus tard. Au lieu de cela, rédigez immédiatement le rapport de bogue. Cela garantira un bon rapport de bogue reproductible. Si vous décidez d'écrire le rapport de bogue plus tard, il y a de fortes chances que vous manquiez les étapes importantes de votre rapport.

# 2) Reproduisez le bogue trois fois avant d'écrire un rapport de bogue

Votre bogue doit être reproductible. Assurez-vous que vos étapes sont suffisamment robustes pour reproduire le bogue sans aucune ambiguïté. Si votre bogue n'est pas reproductible à chaque fois, vous pouvez toujours déposer un bogue mentionnant la nature périodique du bogue.

# 3) Testez la même occurrence de bogue sur d'autres modules similaires

Parfois, le développeur utilise le même code pour différents modules similaires. Il y a donc plus de chances que le bogue d'un module se produise également dans d'autres modules similaires. Vous pouvez même essayer de trouver la version la plus grave du bogue que vous avez trouvée.

# 4) Rédigez un bon résumé de bogue

Le résumé du bogue aidera les développeurs à analyser rapidement la nature du bogue. Un rapport de mauvaise qualité augmentera inutilement le temps de développement et de test. Communiquez bien avec votre résumé de rapport de bogue. Gardez à l'esprit que le résumé du bogue est utilisé comme référence pour rechercher le bogue dans l'inventaire des bogues.

# 5) Lisez le rapport de bogue avant de cliquer sur le bouton Soumettre

Lisez toutes les phrases, formulations et étapes utilisées dans le rapport de bogue. Voyez si une phrase crée une ambiguïté qui peut conduire à une mauvaise interprétation. Les mots ou phrases trompeurs doivent être évités afin d'avoir un rapport de bogue clair.

# 6) N'utilisez pas de langage abusif

C'est bien que vous ayez fait du bon travail et trouvé un bogue, mais n'utilisez pas ce crédit pour critiquer le développeur ou pour attaquer quiconque.

Conclusion

Nul doute que votre rapport de bogue doit être un document de haute qualité.

Concentrez-vous sur la rédaction de bons rapports de bogues et passez du temps sur cette tâche car c'est le principal point de communication entre le testeur, le développeur et le gestionnaire. Les responsables doivent faire prendre conscience à leur équipe que la rédaction d'un bon rapport de bogue est la responsabilité principale de tout testeur.

Vos efforts pour rédiger un bon rapport de bogue permettront non seulement d'économiser les ressources de l'entreprise, mais également de créer une bonne relation entre vous et les développeurs.

Pour une meilleure productivité, rédigez un meilleur rapport de bogue.

Êtes-vous un expert dans la rédaction d'un rapport de bogue? N'hésitez pas à partager vos réflexions dans la section commentaires ci-dessous.

lecture recommandée

^