# Vocabulaire et jargons

Démystifier les principaux concepts du Craft

---

# Introduction

* Julien
  * DevOps
  * Python
  * passions : informatique et Craft
  * talker
  * bénévole aujourd'hui
* tutoiement, interventions et échanges

---

## Le sujet

> Chaque métier a son jargon, chaque spécialité en rajoute. Cela rend la communication efficace, une fois qu'on maitrise tous ces termes.  
> 
> Ensemble, faisons une passe sur le vocabulaire lié au Craft, en toute simplicité, pour découvrir ces termes parfois inconnus, parfois déjà connus sous un autre nom.

---

## Les attendus ?

Quels sont les termes à définir ?

---

# Comment définir ?

C'est compliqué !

> 1. Fait de déterminer les caractéristiques d'un concept, d'un mot, d'un objet, etc., ensemble des propriétés essentielles de quelque chose.  
> Exemple : "La définition de ce mot n'est pas facile."  
> — Larousse

> 1. Opération par laquelle on détermine le contenu d'un concept en énumérant ses caractères.  
> — Le Robert

Jeu : quelles différences ?

Note:

* "concept" seulement ou aussi "mot", "objet", "quelque chose", ...
* "caractéristiques" versus "ensemble des propriétés essentielles de quelque chose"
* "exemple" ou pas ?
* "fait" versus "opération"
* "opération" versus "fait"
* une courte et l'autre moins
* blague : y'en a une faut accepter les cookies pour pouvoir la lire, et pas l'autre

---

## Define Define

[TodePond - Define Define](https://www.youtube.com/watch?v=ZMklf0vUl18)

![](./define_define.png)

> A definition is a tool that we use to express ourselves, and to communicate. Sometimes, the definition is for other people. Sometimes it's just for you.  
> The definition that **you** use tell us something about **you**.  
> Personally, I love to use definitions very loosely. But what about you ? What definitions do you use ?

> Une définition est un outil que l'on utilise pour s'exprimer, et pour communiquer. Des fois, la définition est pour les autres personnes. Des fois, juste pour soi.
> La définition que **tu** utilises nous dis quelque chose de **toi**.
> Personnellement, j'aime utiliser les définitions de façon très approximative. Et toi ? Quelles définitions tu utilises ?

Note:

HTML n'est pas un langage de programmation mais de balisage, est-ce que ça veut dire qu'on ne programme pas en l'utilisant ? ça dépend ...
Est-ce que la question précédente est stupide ? oui, plutôt

je ne dirais pas "j'aime", mais je suis plutôt d'accord avec ça, et malgré moi je le fais

---

## Méthode

* exercice ensemble
* je suis préparé
* pas de conviction
* objectif : se familiariser avec ces termes

Note:

Faisons l'exercice ensemble d'essayer de définir des termes.
Je viens préparé : j'ai de slides, j'ai répété, je sais où je vous emmène, ...
Mais faisons l'exercice ensemble d'essayer de définir des termes.
Mon but n'est pas du tout de vous convaincre que j'ai raison.
Mon but est que dans une heure on soit + familier de ces termes, vous et moi.
Ok ? c'est parti !

---

# n°1

![](./code_to_review.png)

Note:

oui désolé c'est du Python, je vous avais dis que j'atais fan de Python
j'espère que ça ne vous empêche pas de le lire

qu'est-ce que vous en pensez ?
* uv tool run ruff check --select 'ALL' src/code_review.py<br/>
	- accents dans le nom
	- pas de docstring
	- pas de timeout
	- print au lieu de logging
	- pas de typage
* autres :
	- nom en français
	- pas de paramètres
	- FTP et non pas FTPS
	- FTP et requête HTTP, wtf ?
	- gestion des exceptions (réseau, json parsing)
	- url hardcodée
	- pas de check du HTTP status code de la réponse

---

Quel terme j'essaye de vous faire deviner ?

---

## Code Review

Quelle définition vous proposeriez ?

> Code Review : examen minutieux du code produit par une personne, afin d'en déceler des erreurs potentielles ou factuelles, pour faire des retours constructifs, pouvant mener à des discussions, afin d'améliorer la qualité, de partager des pratiques, d'apprendre et de construire une culture d'équipe

Notes:

ici je vous ai forcé à plisser des yeux pour trouver tous les défauts, je vous ai fait creuser votre cervelle
j'essaye de faire de même quand quelqu'un me propose de relire une PR
j'espère qu'on fait de même pour celles que je propose
le retour peut éventuellement se faire à l'oral, de façon synchrone, ou bien la relecture peut être guidée, ... trouvez ce qui vous plait

---

# n°2

```python
grid_size_in_meters = 200
length_of_degree_of_arc_in_france_in_kilometers = 111.358
step = grid_size_in_meters / length_of_degree_of_arc_in_france_in_kilometers
```

Où est le bug ?

Quelle est la cause ?

Notes:

véritable exemple du code que j'ai écris et qu'il a fallu que je débug
hint : ma step est beaucoup trop petite (symptôme)

erreur d'unité
par quoi elle est causée ?

mélange des unités
est-ce qu'on aurait pu s'en douter ?

---

Quel terme j'essaye de vous faire deviner ?

---

## Code smell

> Code smell : quelque chose qui en soit n'est peut-être pas une erreur, mais risque d'en causer plus tard.

![http://bribriange49.centerblog.net/6585200-011-expressions-et-dictons](./rateau.jpg)

![https://www.reddit.com/r/programming/comments/854qg3/the_security_footgun_in_etcd/](./gun.png)

Vous avez des exemples ?

Clean code !

Notes:

il y en a plein d'autres :
* une variable/fonction/classe/... mal nommée
* avoir des fonctions hyper longues et/ou trop complexes (if imbriqués, récursivité, ...)
* beaucoup de code dupliqué
* code mort (jamais appellé)
* trop de paramètres
* ...

---

# n°3

![](./code_test.png)

Est-ce que ma fonction est correcte ?

Comment en être sûr ?

---

Quel terme j'essaye de vous faire deviner ?

---

## Test

Quelle définition vous proposeriez ?

> Test : contexte + action = résultat attendu ?  
> Autrement dit : s'assurer du fonctionnement du code tel que spécifié.  
> Pas forcément automatiquement, peut-être manuellement ou hybride.

Comment tester la fonction précédente ?

Comment on testerait récupérer_le_bundle ? On en discute ce midi !

---

# n°4

![](./code_refactor.png)

Est-ce que vous préférez ce code ?

Est-ce qu'il fait fondamentalement la même chose ou pas ?

Qu'est-ce que j'ai fait pour le changer ?

---

Quel terme j'essaye de vous faire deviner ?

---

## Refactoring

> Refactoring (version stricte): changer le fonctionnement/la structure interne, sans impacter le fonctionnement externe.
> Pour améliorer des propriétés liées à la qualité : lisibilité, évolutivité, ...
> Allant du simple renommage d'une variable locale, jusqu'à changer complètement toute l'architecture.

⚠️ Définition variable !

Notes:

cette définition est souvent utilisée de façon très approximative, même par moi : des fois le comportement est altéré, mais on juge que c'est négligeable
ici, je ne raise plus d'exception, fondamentalement j'ai changé le comportement de la fonction, mais c'est pour le mieux (peut-être)
d'autres personnes préfèrent une définition très stricte : si on peut voir la moindre différence de l'extérieur, alors c'est peut-être plutôt un fix, c'est le débat du fond versus la forme

---

# n°5

Qui aurait préféré des questions individuelles plutôt que collectives ?

Pourquoi préférer le faire collectivement ?

Notes:

réponses anticipées :
* le stress,
* les erreurs,
* la diversité des réponses,
* les échanges qui en découlent,
* l'inutilité de le faire chacun de son côté,
* ...

---

Quel terme j'essaye de vous faire deviner ?

---

## Pair programming

> Pair Programming (version stricte) : il y a un "conducteur" (driver) qui a le clavier et la souris, et un "navigateur/observateur" qui dicte comment coder au conducteur.
> Les rôles sont échangés à intervalles réguliers.

⚠️ Définition variable !

Quels bénéfices ?

Mais là vous n'êtes pas que 2 ...

Notes:

ça ressemble vraiment à "quelqu'un qui réfléchit" versus "quelqu'un qui tape du code",
et c'est pas si faux, mais en fait ça revient surtout à couper en 2 la pratique du code :
le côté très mécanique ("taper au clavier, corriger les typos, relancer les tests, scroller, naviguer dans l'IDE/la doc/StackOverflow/...")
et l'autre qui, déchargé de cela, a l'esprit un peu plus libre pour réfléchir de façon stratégique : où est-ce qu'on va, comment y aller, qu'est-ce qu'on oublie, ...

C'est la version "stricte", mais à titre personnel je l'utilise de façon plus flexible :
du moment qu'on est deux pour un seul IDE-clavier-souris, je considère qu'on paire, même si on n'a pas forcément de rôles et qu'on ne les alterne pas.
C'est peut-être moins efficace, mais très naturel

Et c'est une définition très structurelle, en parlant juste des rôles, mais ça a aussi des effets autres que simplement produire du code :
* produire du meilleur code
* aller plus vite parfois
* partager les connaissances et pratiques
* renforcer la confiance en soi
* construire du lien humain
* toujours quelqu'un de dispo pour débloquer (car toujours quelqu'un)
* ...

Et encore une fois, c'est une vision stricte : ça ne parle que de programming, quid du debugging ? du design ? des campagnes de test manuel ? des slides pour la démo ? ...
"programming" peut être entendu au sens très très large pour moi, c'est grosso modo toutes les activités dans la vie des devs
j'ai déjà fait du pair-"création de réunion Teams" ou du pair-"imputation des feuilles de temps".

---

Quel terme j'essaye de vous faire deviner ?

---

## Mob programming

Quelle définition vous proposeriez ?

> Mob Programming : du pair programming, mais pas en paire, en trio, quatuor, quintette, sextuor, septuor, 8, 9, 10 ou plus ... peu importe le nombre

En cours de renommage :

> Software teaming : toute l'équipe (les devs bien sûr, mais aussi PO, UX, test, archi, cyber, ...) réunie ensemble pour produire du logiciel.
> Toutes les personnes requises sont présentes simultanément, pour travailler toutes ensemble sans blocage.

Notes:

soit en version stricte : toujours un seul conducteur, plusieurs navigateurs, et on tourne
soit en version souple : plein de monde pour un seul écran

mêmes avantages, globalisés

y'a des équipes qui travaillent comme ça quasi tout le temps

---

# n°6 : TDD

Le terme c'est : TDD.

Mais je dois d'abord vous parler de RGR.

---

## Le Red/Green/Refactor du TDD

![https://martinfowler.com/bliki/TestDrivenDevelopment.html](./red_green_refactor_martin_fowler.png)

---

Définition :
* une technique "red/green/refactor"  
* une façon de faire des "petits pas"  
* une façon de toujours savoir exactement ce qui marche ou pas  
* une façon de produire une "doc" de comment utiliser le code  
* une façon d'avoir du code testable  
* une façon d'avoir du feedback rapide  
* une façon d'être certain d'avoir des tests à la fin  
* une forme de "spécification exécutable"
* une technique de design ("test-driven design" ?)  
* n'est PAS la solution ultime à tous les problèmes

Mise en pratique tout-à-l'heure !

---

# n°7

![https://refactoring.guru/design-patterns/adapter](./adapter_pattern.png)

Qu'est-ce que vous en pensez ?

Notes:

complexe / bien conçu

permet de faire fonctionner les 2 ensemble

---

Quel terme j'essaye de vous faire deviner ?

---

## Design patterns

> Design Pattern : un pattern ("motif") d'une même solution pour un même problème.

chat = "animal quadrupède à fourrure, qui fait miaou!"

catalogue de problèmes/solutions connus

![https://refactoring.guru/design-patterns/catalog](./design_patterns_catalog_refactoring_guru.png)

Notes:

les connaitre permet de rapidement trouver une solution classique à des problèmes connus (par exemple Memento)
très historiques, très liés à la POO

lesquels vous connaissez ? Visitor, Singleton, Iterator, Strategy, Abstract Factory (le fameux !), Builer, Memento, Composite, Decorator, Proxy, Observer, ...

---

# n°8

Dites "panier piano" 10 fois rapidement !

Qui l'a fait le + vite correctement ?

Qui le ferait encore mieux ?

![](./panier_piano.png)

---

Quel terme j'essaye de vous faire deviner ?

---

## CI/CD

> Continuous Integration (CI) : "intégration en continu", les changements de code sont pris en compte incrémentalement, et l'application est reconstruite/retestée/re... à chaque fois

Pas de notion de branche git ...

Trunk versus feature branches

> Continuous Delivery (CD) : livraison en continu, les changements sont livrés, prêts à être utilisés.

> Continuous Deployment (CD) : déploiement en continu, les changements sont automatiquement déployés et utilisés.

Ensemble d'outils et leurs pratiques associées

Notes:

(ok, là c'était peut-être difficile à deviner à partir de l'indice, mais j'espère qu'on aura bien rigolé)
que veut dire CI ?
que veut dire CD ?
que veut dire CI/CD ?

2 sens du mot CI (features branches versus tronc commun pour intégration fréquente)
2 mots CD (delivery/deployment)

---

# n°9

![https://tenor.com/view/racing-pit-stop-gif-11531785](./racing-pit-loop3.gif)

Qu'est-ce que c'est ?

Comment il en sont arrivés à ce niveau d'efficacité ?

Comment combiner rapidité et fiabilité ?

---

Quel terme j'essaye de vous faire deviner ?

---

# DevOps

> DevOps : ensemble de pratiques, outils, et changements culturels pour accorder la production de code avec son exécution en prod.

![](./devops.webp)

Dérive corporate :

> DevOps : non pas une culture d'avoir un objectif commun, mais juste le rôle des gens qui servent de tampon entre les Dev et les Ops, ou bien qui font le boulot des deux.

Shift Left et Dev____Ops

Notes:

faire communiquer les gens, aligner les incentives (vitesse versus fiabilité)

Et ça peut se décliner à toutes les sauces ! Qu'est-ce qu'il manque sur ton projet ? De la sécurité ? Bim du DevSecOps !

Mini-jeu : lesquels sont vrais, lesquels sont inventés ?
* DevOps
* DevSecOps
* DataOps
* MLOps
* AIOps
* GitOps
* FinOps
* ~~CyclOps~~
* ~~E-ScalOps~~

Souvent du marketing néanmoins

---

# n°10

Sortez vos mains, on va faire un atelier !

Faites-le 5 fois d'affilée.

Qui pense maîtriser ?

Notes:

si y'en a qui sont fortiches, s'entraîner à faire les lunettes de super-héros (attention, ça tire sur les avant-bras !)

---

Quel terme j'essaye de vous faire deviner ?

---

## Kata / Dojo

> Kata : dans les arts martiaux japonais, suite codée de mouvements constituant un exercice d'entraînement à la pureté du geste.  
> — Le Robert

> Dojo : salle où l'on pratique les arts martiaux.  
> — Le Robert

> Le _dōjō_ est le lieu où l'on étudie/cherche la voie.  
> [...]  
> Le dojo est un lieu où l'on progresse. Cette progression est obligatoirement supervisée et contrôlée par un maître.  
> — Wikipedia

> Practice makes perfect.

Notes:

Dans le Craft, on a repris ce concept : le dojo est un endroit où l'on pratique des kata, de petits exercices, qu'on peut répéter, pour perfectionner sa maîtrise d'une technique.

---

# n°11

Question pour un (groupe) champion !

Top !

* je suis un concept de programmation  
* je suis issu de l'orienté-objet  
* je promets du code maintenable, testable, flexible, fiable, découplé, ...  
* je suis composé de 5 lettres  
* je suis un acronyme  
* je suis synonyme de robuste  
* je suis ...  
* je suis ...

SOLID !

---

## SOLID

* SRP : Single Responsibility Principle  
	* une classe ne doit faire qu'une seule chose, et le faire bien (pour qu'elle n'ait qu'une seule raison de changer)  
* OCP : Open-Closed Principle  
	* une classe est ouverte aux extensions, mais fermées aux modifications  
* LSP : Liskov Substitution Principle  
	* si une méthode prend en paramètre (ou renvoie) un Animal, alors ça peut concrètement être un Cat ou un Dog car ce sont des Animal  
* ISP : Interface Segregation Principle  
	* une interface ne doit contenir que ce qu'il faut pour ses clients  
* DIP : Dependency Inversion Principle  
	* le code doit dépendre de classes abstraites (qui lui sont fournies) et non pas de classes concrètes (qu'il instancie)

Notes:

c'est très lié à l'orienté-objet, si vous codez avec un autre paradigme (fonctionnel typiquement) ça ne sera pas pertinent
c'est pratique pour les code reviews (code smells) afin de partager un vocabulaire commun

---

# n°12

Petite anecdote de complexité de cache ...

---

Quel terme j'essaye de vous faire deviner ?

---

## KISS

> KISS : keep it simple stupid !

> Conserve la simplicité idiote !

C'est compliqué !

> Je n’ai fait \[cette lettre] plus longue que parce que je n’ai pas eu le loisir de la faire plus courte.  
> — Blaise Pascal

> YAGNI : You ain't gonna need it

> T'en auras pas b'soin

Notes:

Origine : comment concevoir un avion de chasse qui soit réparable par un mécano moyen, avec des outils communs, en situation de stress ?

sans faire un cours sur la complexité et l'entropie (en plein boom de l'IA), c'est compliqué de faire simple, mais c'est important

Un mantra pour se forcer à ne pas inclure des choses "au cas où", partons du principe qu'il n'y en aura pas besoin, et on les rajoutera quand il le faudra

---

# n°13

![https://github.com/jserv/unix-v1/blob/master/src/c/cc.c](./legacy_code.png)

Que pensez-vous de ce code ?

Notes:

produit en 1972, soit 7 ans avant même la naissance du plus vieux des 3 créateurs de GitHub

---

Quel terme j'essaye de vous faire deviner ?

---

## Code legacy

Impossible de proposer une définition !

* ou bien du code écrit il y a très longtemps (à jour ou pas)  
* ou bien du code plutôt récent, mais qui a beaucoup de dépendances qui ne sont pas à jour  
* ou bien du code écrit par d'autres personnes (peu importe quand), qu'on a récupéré mais qu'on aurait pas écrit comme ça  
* ou bien du code écrit par soi, mais on ne l'écrirait plus pareil maintenant  
* ou bien du code sans doc  
* ou bien du code sans test  
* ou bien du code tellement mal conçu (dette technique) qu'on n'arrive rien à faire sans causer des régressions  
* ou bien un système qu'on ne comprend pas car peu clair  
* ou bien un système qu'on essaye de remplacer (rewrite)  
* ou bien tout à la fois

Jamais un compliment, surtout synonyme de problèmes.

---

# n°14

![](./function_without_doc.png)

C'est quoi cette fonction ? (si vous ne la connaissez pas déjà)

Que fait la lib Python "ftfy" ?

Que fait la lib Python "PyERFA" ?

Notes:

originellement, elle s'appelle "InvSqrt" et a des commentaires

"fixes text for you" : répare le mojibake

ERFA est une lib de fonctions astronomiques, dont PyERFA est un ensemble de bindings Python pour Numpy, sans passer par Astropy

avant de devoir écrire ces lignes, je n'avais jamais entendu parler de ces 2 librairies, et pourtant je semble être un expert lorsque j'en parle

---

Quel terme j'essaye de vous faire deviner ?

---

## Documentation

Très difficile à définir (même pour un dico !)

Produire des documents pour expliquer quelque chose :

* quel type de document ?  
* à quel but ?  
* pour quoi ?  
* comment ?  
* quand ?  
* stocké où ?  
* ...

Philosophie (Diátaxis) et outillage

![https://diataxis.fr/](./diataxis.webp)

Notes:

Markdown, Asciidoc, wiki, ReST, Javadoc, Doxygen, ...
Schémas Excalidraw, Draw.io, photos du tableau, ...

---

# n°15 : Architecture

> Architecture : choisir quelles portes on veut s'ouvrir, lesquelles on va se fermer, et les coûts/bénéfices associés.

![](./archi_monolith_vs_microservices.png)

---

Architectures :

* Héxagonale / Clean / Onion  
* en couche  
* Orientée-services  
* Micro-services  
* CQRS-ES  
* ...

---

# n°16 : DDD

> DDD: Domain-driven design, mettre le "métier" au centre des discussions, du code, des pratiques.

Un sujet très large.

Notes:

Ubiquitus language

patterns stratégiques et tactiques

---

# Récapitulatif

- Code review
- code smell
- tests
- refactoring
- pair/mob programming/software teaming
- TDD
- Design patterns
- CI/CD
- Dev(Sec)Ops
- dojo + kata
- SOLID
- KISS / YAGNI
- Legacy
- Documentation
- Archi héxa/clean/couches/orientée-services/micro-services/cqrs-es
- DDD

---

# Pour continuer

Quelles définitions pour :
* couplage ?
* dette technique ?
* Lean ?
* mock ?

Pour continuer à apprendre :
* conférences et meetups Craft
* replays des conférences
* podcasts, livres, articles, ...
* pratiquer
* [le livre "Software Craft" (Dunod)](https://www.dunod.com/sciences-techniques/software-craft-tdd-clean-code-et-autres-pratiques-essentielles-0)