Comment faire un bon rapport de bug ?

Qu’est-ce qu’un bug ?

Un bug est un défaut de conception d’un programme informatique, qui provoque un dysfonctionnement. Il peut être bénin (un défaut d’affichage par exemple), grave (des pertes de données) voire catastrophique (l’explosion du vol 501 de la fusée Ariane 5 a été causé par bug informatique !).
Il ne faut pas confondre le bug avec : une erreur de manipulation, un virus informatique, une absence de compatibilité ou encore une panne du matériel.

Pourquoi est-il important de le signaler correctement ?

Rapport de plantageMieux un bug sera présenté au programmeur, plus vite celui-ci pourra le résoudre. A l’inverse, un bug mal signalé entraînera des erreurs de compréhension, et retardera donc la résolution du problème.
Pour être efficace et exploitable, un rapport de bug doit être complet, clair, précis, utile, et informatif. Il doit rapporter des faits précis (ce que vous avez fait, ce que vous avez vu) et éviter les spéculations (« je pense que… »).

A faire :

  • Faire la démonstration du bug devant le programmeur, afin qu’il puisse constater de visu ce qui fait planter le programme. A défaut, décrire précisément la démarche qui provoque un plantage, de façon à ce que le programmeur puisse reproduire les mêmes manipulations que vous, dans les mêmes circonstances.
  • Dans le cas où des messages d’erreur apparaissent : rapportez-les précisément au programmeur, sans en omettre une partie, même s’il s’agit d’une suite de chiffres (pour cela recopiez les messages, ou réalisez une capture d’écran).
  • Utiliser des termes précis. Attention aux pronoms « il », « elle », etc, qui peuvent induire en erreur. Mieux vaut faire des répétitions !
  • Donner un maximum d’informations. Mieux vaut trop en fournir que pas assez.
  • Relire votre rapport afin de vous assurer qu’il est complet et précis.

A ne pas faire :

  • Des rapports imprécis : « Ça ne marche pas ! »
  • Omettre des informations parce qu’elles vous semblent secondaires (le navigateur utilisé, ou une chaîne de nombres incompréhensibles par exemple)
  • Donner votre opinion sur le problème (sauf si elle est juste !). Des déductions fausses peuvent induire le programmeur en erreur.
  • Confondre un bug avec une erreur de manipulation

Que faire face à un bug ?

Tenter de résoudre soi-même le bug peut fonctionner… mais cela peut également aggraver le problème.
Idéalement, quand quelque chose se passe mal, observez et notez tout ce qui sort de l’ordinaire. Vous pouvez ensuite essayer de cliquer sur « OK », « Annuler », ou de fermer l’application concernée.
Si cela ne fonctionne pas, prévenez le programmeur… sans oublier de lui exposer précisément tout ce que vous venez de faire et de voir.
En cas de doute, n’hésitez pas à demander conseil. Un petit bug sera toujours plus facile à corriger qu’un gros.

Quelques données à ne pas négliger dans un rapport de bug :

Certaines informations semblent peu importantes. Pourtant, elles peuvent être à la base du bug, il ne faut donc pas les négliger dans votre rapport. C’est le cas de :

  • La taille et la résolution de l’écran
  • Le navigateur utilisé
  • Le système d’exploitation (Windows, Mac)
  • Les logiciels ouverts au moment du plantage
  • La durée d’utilisation avant le plantage
  • La taille des fichiers utilisés

Et s’il manque des informations ?

Même un très bon rapport de bug peut être insuffisant pour comprendre et résoudre le problème. Dans ce cas, le programmeur peut avoir besoin d’informations supplémentaires, ou vous demander d’effectuer de nouvelles manipulations.
Même si vous ne comprenez pas l’intérêt et l’utilité de ses demandes, tenez-vous à la disposition du programmeur. Vous l’aiderez ainsi à corriger le bug au plus vite.

En bref :

Un rapport de bug détaillé, précis et clair
=
une résolution du problème rapide et efficace

Une réflexion au sujet de « Comment faire un bon rapport de bug ? »

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *