S01E48 — 14-09-2024.
Quoi de neuf doc ?
jour 48.
Sayé, j’ai commencé à écrire la documentation. J’aurais pensé que ça serait grave relou, mais finalement j’aime bien. J’ai trouvé un angle de vue et un parallèle intéressant qui vont rendre cette initiation à la programmation un peu plus sympa que ce qu’on a l’habitude de voir. Les adeptes du manga Naruto vont être content, ceux qui ne le connaissent, comprendront tout autant.
Si jamais, tu te demandes pourquoi on doit obligatoirement écrire une documentation. En soit, ce n’est pas obligatoire, cependant je te conseille fortement d’en écrire une et cela pour plusieurs raisons :
- Faciliter la compréhension et l’utilisation de ton langage.
- Encourager les bonnes pratiques.
- Rendre ton langage accessible à une large audience.
La documentation devient le référentiel, elle va servir à fournir des guides, des tutoriels ainsi que des exemples pour aider les développeurs à comprendre comment utiliser les fonctionnalités de ton langage de manière efficlasse. Puis, c’est le moment pour toi de décrire les concepts clés, les différentes syntaxes, etc. Tu marqueras des points en faisant cela. L’utilisateur ne te le dira peut-être pas, mais il te sera reconnaissant d’avoir pris le temps de le faire.
Bien sûr, la documentation doit être à jour, elle doit évoluer en même temps que ton langage. Honnêtement, je n’aurai jamais cru que ça pouvait être si amusant. De trouver des exemples parlant avec un ou deux exercices associés. Puis c’est un moyen de défendre son pain, il y a une part de marketing derrière tout ça. Je mets en avant les avantages de mon langage, j’explique au lecteur pourquoi et comment mon langage va lui être utile.
Je t’avouerai que j’avais grave la flemme avant de me lancer puis une fois que tu as trouvé ton angle de vue et commencer à écrire ton introduction, tout le restant va défiler dans ta tête. Tu vas pouvoir définir ton univers en prenant plaisir à le faire. Par exemple, dans mon cas, j’ai envie d’avoir une approche grave simpliste donc je vulgarise énormément. L’idée n’est pas de faire fuir mon lecteur, je veux qu’il assimile rapidement les concepts informatiques. Les concepts plus complexes doivent être faciles à comprendre. Tout de même, j’envisage peut-être d’avoir des genres de niveaux dans la documentation qui, selon le niveau choisit par le lecteur aient le ton approprié et le niveau de complexité adapté.