L’art et la manière de rédiger un ticket
17 octobre 2018
Pour qu’un système de tickets soit efficace, il y a quelques règles à observer.
En effet, un développeur peut travailler sur plusieurs sites dans une même journée.
Il n’a pas forcément en tête les spécificités de tel ou tel projet.
C’est pourquoi il est important d’être concis, précis et documenté lorsque l’on crée un ticket.
Réaction d’un développeur qui découvre un ticket de bug
qui s’intitule “Ça marche pas !” :
1/ Ça marche pas !
Voilà bien un titre qui ne veut rien dire…
Qu’est ce qui ne fonctionne pas?
Le titre d’un ticket doit refléter le contexte dans lequel l’incident s’est produit.
Par exemple :
- Impossible de me connecter à mon compte
Ce titre nous indique que vous essayez de vous connecter à votre compte et que vous n’y arrivez pas.
Ce message ne nous permet pas de savoir sur quel projet, avec quel compte, sur la version de dev ou en production, avec quel mot de passe, etc …
Avec un message imprécis, nous allons tous deux perdre beaucoup de temps a récolter ces informations, résoudre les quiproquos et relancer chacun.
C’est le temps moyen que cela prend :
- D’essayer de comprendre ce que le ticket signifie,
- d’éventuellement chercher le projet concerné
- d’aller sur le projet et d’essayer trouver le problème,
- De laisser tomber ou de chercher dans le mauvais projet,
- de rédiger une réponse qui invite à donner plus de détail,
- d’attendre votre retour,
- de reprendre ses esprits et se remettre au travail sur un autre projet…
Sans informations précises, nous pouvons nous égarer et chercher le problème sur un autre projet ou une autre page.
2/ Le contenu du ticket
Le rêve du développeur, quand il ouvre un ticket, est de trouver toutes les informations utiles à la reproduction de celui-ci.
Plus vous allez lui donner d’indices, et plus il sera efficace et rapide.
Voici un exemple de message qui permet de répondre efficacement :
- Le contexte:
J’étais sur la page d’accueil et j’ai cliqué dans le menu pour aller sur la page de connexion.
Lors ce que j’ai renseigné les champs identifiant et mot de passe j’ai eu une erreur bizarre. - Le lien de la page incriminée:
Le bug est apparu sur la page : https://monsite.com/connexion - Les informations saisies
J’ai saisi mon compte sophie.legrand, j’ai cliqué sur le bouton “Valider”
Il était 12h45 - La cerise sur le gâteau : une copie d’écran
Voici une copie d’écran de l’erreur :
- Contacts pour le retour :
Je suis disponible pour vos retours au 06123456 ou par mail sophie.legrand@macliente.com cet après-midi.
Avec un message de ce type, nous pouvons réagir dans les meilleurs délais et tout le monde gagne de l’efficacité.
3/ Victoire !
Le bug est résolu et le développeur vous en informe et vérifiera avec vous sa pleine résolution.
