Clean Code as Learning path¶
Description¶
Titre¶
Code ou Doc ? Ou : quand le Clean Code m'aide à monter en compétence.
Abstract¶
"Tu as lu la doc ?" "RTFM (Read The Friendly Manual)." Avez-vous déjà entendu ce genre de propos ? La documentation est souvent un passage obligé en arrivant sur un projet. Elle est utilisée pour décrire le contexte du projet et des logiciels qui gravitent autour.
C'est aussi un passage nécessaire lorsque l'on quitte un projet, pour transmettre toutes vos connaissances aux futurs développeurs.
Personnellement, je n'aime pas la doc, et je préfère coder. Ici, on parle code plutôt que doc. Pourquoi ne pas joindre l'utile à l'agréable ?
Si cela vous parle, nous verrons ensemble des trucs et astuces pour monter en compétence sur du code hérité. Mais aussi des guides et des aides pour écrire du code pour la postérité
Note aux organisateurs¶
Plan succinct¶
- Documentation : Qu'est-ce qu'une bonne documentation ?
- Code is Doc
- Appréhender du code Legacy
- Clean Code : guide de lecture du logiciel
- Code Review ou Refactor : quel état d'esprit en arrivant sur le code ?
-
Documentation : le code est-il auto suffisant ? (spoiler : non)
- Oui : Living Documentation
- Oui : ADR
- Oui : le Domaine métier est dans le code
- Oui : les scénarios de test
- Non : les autres corps de métier
-
A quel moment et dans quel contexte on vous demande de partager vos connaissances ?
- Partager vos connaissances par la documentation.
- Documentation : Qu'est-ce qu'une bonne documentation ?
- Quelques pratiques autour de la documentation
- Framework Diátaxis (tutoriaux/howto/explications/référence)
- ADR (Architecture Decision Record)
- Living documentation
- Code is Doc
- Appréhender du code Legacy
- Clean Code : guide de lecture du logiciel
- Modéliser son code : Clean code level 2
- Aparté sur les modèles mentaux -
- Code Review ou Refactor : quel état d'esprit en arrivant sur le code ?
Message to organizers
Bonjour, Tout d'abord : merci d'avoir pris le temps de lire l'abstract du talk.
La gestion de la connaissance dans le milieu du logiciel est un sujet qui m'anime. Les ressources visibles que j'ai partagé dans les références sont encore des brouillons et je travaille pour rendre le sujet ludique et concret. Je me tiens à votre disposition si vous souhaitez échanger pour adapter davantage le fond au public du DevFest.
Bonne journée !