A list of tutorials crafters should follow using the slow kata pattern.
Rules for following a slow-tuto.
- Be sure you know the prerequisites given in the header.
- Read the first line without executing it.
- Try to guess what will happen. Write it ideally.
- Run the line.
- Learn from the differences.
- Repeat with the following line, or the current line if you feel it.
Exceptions: a block preceded with a comment starting with "Learning ..." may be executed without guessing.
Rules for writing a slow-tuto.
- Write in the header what prerequisite a trainee should have before starting the tuto.
- Each file can be copy-pasted in a classical environment for the language and run.
- Except for "Learning ...", there should be no comments explaining what the code does. If explanation has to be given, prefere giving pieces of code with smaller learning steps,
- The best slow tuto might be the ones you have built while learning yourself a new techno.
Un ensemble de tutoriel que des développeurs peuvent suivre en utilisant le pattern du slow kata.
Règles pour suivre un slow-tuto.
- Soyez sûr que vous connaissez les prerequis indiqués dans l'en-tête.
- Lisez la première ligne de code sans l'exécuter.
- Essayez de devinez ce qui va se produire. Idéalement, notez-le.
- Exécuter la ligne de code.
- Verbalisez l'apprentissage acquis, qu'il y ait des différences par rapport à ce que vous imaginiez ou non.
- Recommencez avec la ligne suivante, ou la ligne courante si vous le désirez.
Exception : si un bloc est précédé par un commentaire de type "Learning ...", il peut être exécuté sans essayer de deviner ce qui va se passer.
Règles pour écrire un slow-tuto.
- Notez dans l'en-tête les prerequis nécessaires à cet apprentissage.
- Un tuto doit être copier-collable dans un environnement standard et s'exécuter.
- A part des commentaires "Learning...", il ne devrait y avoir aucun commentaire à votre code. Si vous sentez que des explications sont nécesaires, préférez séparer en plusieurs lignes de code offrant des plus petits pas d'apprentissage.
- Les meilleurs slow-tuto sont peut-être ceux que vous avez construits quand vous avez vous-même appris une nouvelle technologie.