Mon premier tutoriel

Contexte

Depuis que je me forme au développement web en lisant ou en regardant des vidéos sur internet, j'ai toujours eu une certaine admiration pour les personnes qui créent du contenu pour faire apprendre les autres, de transmettre du savoir et de la passion.

Dans le même temps, je pense que réussir à créer un tutoriel, à expliquer un sujet et que l'autre le comprenne, est la preuve d'une compréhension d'un sujet.

En 2020, j'avais déjà pu commencer à écrire un ensemble de slides pour apprendre à écrire à utiliser HTML, CSS et JavaScript. Mais je n'ai jamais eu le temps de les finaliser notamment parce que je n'avais pas anticipé la difficulté de créer un tutoriel.

Durant 1 an, j'ai conservé l'idée jusqu'à que je trouve une occasion de réessayer l’exercice !

Premier tutoriel

Fin août 2021, en travaillant sur un projet web, j'ai découvert AdonisJS. C'est un framework NodeJS qui permet de créer des applications web en utilisant le langage TypeScript. Dans le même temps, un ami ma fait part de vouloir commencer à apprendre le développement côté serveur.

AdonisJS me semblait alors le parfait candidat pour lier les 2 projets, créer un tutoriel et permettre à un débutant de découvrir le développement web.

Pourquoi AdonisJS ?

J'ai eu l'occasion de tester différentes librairies comme Express ou Fastify ou différents frameworks comme NestJS ou Feathersjs. Mais j'ai vraiment eu un coup de coeur pour AdonisJS. Je vous conseil d'y jeter un oeil parce qu'il ne vous décevra pas.

Tutoriel

AdonisJS permet à la fois la création de monolith ou d'API JSON. Il m'a donc fallu choisir les sujets à aborder au sein de ce tutoriel. Je me suis alors placé dans la peau d'un débutant en explorant le plus largement possible les concepts tout en restant dans le concret. J'ai alors eu l'idée de créer un blog.

Le tutoriel permet d'aborder l'ensemble les grandes fonctionnalités d'AdonisJS :

Authentification
Gestion du contenu
Base de données
Templates engine

L'idée est de permettre à l'utilisateur d'être autonome et qu'il est une idée des possibilité d'AdonisJS à la fin de la lecture du tutoriel.

Retrouver la série sur Dev.to

Conclusion

Écrire un tutoriel, c'est un exercice difficile et qui demande du temps mais c'est vraiment enrichissant. Ça oblige à être très rigoureux et très précis. Il faut savoir se mettre dans la peau du lecture pour s'assurer que chaque phrase est clair et éviter les sous entendus.

J'ai pu avoir des retours de lecteurs satisfaits. C'est donc une expérience validée et que je renouvellerai dès que possible.