Lors de nombreuse conférence et très souvent au travail, un point important revient tout le temps :
Les tests et la documentation !
Je m’attarde ici sur la seconde partie. En effet, nous passons beaucoup de temps à coder… Mais sans une bonne documentation, notre code n’est pas facilement compréhensible par les autres. Pour une bibliothèque, son utilisation sera faible si la documentation est faible. Pour une application, le code devient legacy très rapidement et personne ne voudra plus le modifier.
Mais que dire de la documentation du langage de programmation utilisé ? Je mets le langage dans la catégorie des bibliothèques. Ceux qui me connaissent un peu sauront que je parle de PHP et plus particulièrement de la traduction de la documentation en français.
Il y a quelque temps, j’ai posté un twit pour inviter les bonnes volontés à venir traduire la documentation.
La documentation française de @official_php a besoin de vous ! Plus de 2300 fichiers à mettre à jour ou à traduire ! @afup R.T. S.V.P. pic.twitter.com/BS0Dag8vZa
— J. B. Nahan (@jbnahan69) 2 novembre 2017
Après 31 Re-Twit (merci à eux) et 12 j’aime, il y a eu 2 contributions. Le résultat n’est pas si mal !
Au fil de la pérégrination de mon twit, Antoile Bellion a posé une question à laquelle je m’attendais.
Mais qui regarde la doc en français ? 🤔
— Antoine Bellion (@antoinebellion) 2 novembre 2017
La réponse fut pertinente de la part de l’un des traducteurs de la documentation PHP :
les débutants avec un mauvais niveau en anglais 🙂
— Mehdi Achour (@mac_hour) 3 novembre 2017
Pour ma part, je me suis attaché à réaliser un peu de ménage dans les fichiers à mettre à jour. En effet, certains fichiers à mettre à jour ne comportaient aucune (ou très peux de) modification. Il en reste encore beaucoup, mais le compteur est aujourd’hui à 913.
Pour les nouveaux fichiers à traduire, il reste 1258 fichiers en attente d’une première traduction.
Et vous, pourrez-vous nous aider à rattraper la documentation française de PHP ?