Des recettes pour ateliers: du code lisible
Les recettes pour ateliers sont des guides pour vous permettre d’expérimenter les ateliers dans votre entreprise. Nous les avons réalisées chez Esker, pour offrir aux participants une perspective différente ou une connaissance nouvelle. Suivez la recette et débriefez ensuite ensemble ! A vos fourneaux!
RECETTE DE CODE LISIBLE (pour 6 personnes)
TEMPS DE PRÉPARATION : 2H
DIFFICULTÉ : ⭐️⭐️ FACILE
NOTE DE L’AUTEUR : ⭐️⭐️⭐️⭐️ EFFICACE
Réalisez la recette en groupe et prévoyez une vingtaine de minute à la fin pour la dégustation (le débrief). Vous profiterez de ce temps pour discuter de la complexité de relire du code qui n’est pas le sien. Il est en effet nécessaire de s’entendre sur ce que l’on appelle du “code lisible”.
INGRÉDIENTS
- 6 ordinateurs
- Un projecteur
- Une connexion internet
INSTRUCTIONS
- Présentez l’agenda aux participants (12 minutes) :
Ils auront 45 minutes pour coder un exercice simple dans un langage simple.
Ils partageront ensuite leur code (ne pas révéler le twist ici), pour évaluer ce qui facilite la lecture d’un code ou au contraire ce qui les dérange. Demandez à chaque participant d’ouvrir le site choisi pour réaliser l’exercice.
- Expliquez l’outil et l’exercice (3 minutes)
L’ outil : https://jsbin.com/
L’ exercice : Diamond Kata
Etant donnée une lettre, afficher un diamant commençant par ‘A’
avec la lettre donnée au point le plus large
Par exemple : print-diamond ‘C’ affiche : A
B B
C C
B B
A
Et … c’est parti!
- Les participants codent ! (45 minutes)
Twist : Au bout de 45 minutes, vous expliquez aux participants qu’ils ne vont pas devoir présenter leur propre code, mais celui de leur voisin de gauche, sans en avoir pris connaissance auparavant … Après tout, puisqu’ils avaient tous le même énoncé, ça ne devrait pas être si compliqué ^^.
- Présentation du code de son voisin : (40 minutes — 5 minutes par participant)
Au tableau : chacun leur tour, les participants présentent le code de leur voisin, sans préparation et en expliquant leur raisonnement à voix haute: ce qu’ils trouvent bien et ce qu’ils trouvent moins bien.
Pendant les présentations, un facilitateur prend note des points que les participants apprécient, et au contraire de ceux qui gênent la compréhension du code.
- Debrief (20 minutes)
A partir de l’ensemble des points évoqués, rédigez un court manifeste du code lisible.
Note de l’auteur
Un atelier simple et efficace. Il faut être rigoureux sur le temps de présentation du code pour ne pas dépasser le temps de préparation de la recette. Ecrire un manifeste à la fin de l’atelier n’est pas systématique mais l’exercice permet au moins d’introduire la revue de code ou le pairing. Lors des différentes itérations de l’atelier, nous avons pu aborder des principes de Clean code, nom de variables et fonctions représentant des concepts métiers, la simplicité du code et maintenabilité VS optimisation.
