Dans un article que j’avais écrit en septembre 2013, j’avais listé neuf règles pour écrire du code maintenable et évolutif.
Récemment, j’ai fait les frais d’un projet qui était difficile à reprendre. A la base, la mission devait durer deux mois et demi dans une agence web. Au final, la mission a duré moins d’un mois à cause du retard que j’avais pris sur ce projet.
L’agence m’a gentiment remercié en me disant qu’il n’avait pas vu le fait de la difficulté de la reprise de ce projet. Malheureusement, malgré le fait que l’agence reconnaisse son erreur, je ne peux prendre cet échec que personnellement.
Pour vous présenter le projet, c’était un site créé sous WordPress et je devais refondre le template du site tout en gardant les fichiers déjà existant.
Au moment où j’ai regardé le template en profondeur (c’est-à-dire le code du template), il y a plusieurs choses qui m’ont choqué :
La première chose qui m’a surpris est qu’il n’y avait aucuns commentaires, ou tout au maximum 10 lignes. Je n’ai pas compté le nombre exact de lignes de code de ce template, mais je peux vous dire que cela dépassait largement les dix milles lignes.
Il était donc presque impossible de reprendre ce template, à moins de prendre son temps ou de demander l’aide de quelqu’un de l’agence.
La deuxième chose qui m’a choqué, est que les fichiers du dit template ne respectait pas les bonnes pratiques de WordPress.
Je m’explique : un template WordPress est normalement constitué de fichiers modèles que WordPress assemble pour afficher les pages de votre site.
Pour en savoir plus, vous pouvez lire la page sur la hiérarchie des fichiers modèles, page qui vous dit quoi faire.
Le template ne contenait aucun de ces fichiers modèles, mais quelques fichiers divers. Et n’ayant toujours pas de commentaires, le code n’était pas forcément compréhensible dans ces fichiers.
Pour finir par rapport à ce projet, je n’avais pas de document pour m’expliquer quoi faire. Pour effectuer le travail que j’avais à faire, je n’avais en tout et pour tout qu’une dizaine d’images, que le designer avait exporté pour moi. Et ces exportations ne montraient pas l’ensemble des modifications à faire.
Je n’avais pas non plus de vrai point avec les autres personnes (sauf le lundi matin, mais ce n’était que des points généraux)
En conclusion, il y a plusieurs points à retenir quand on travail sur un projet.
Point 1 : Il faut toujours faire en sorte que le code soit compréhensible et maintenable, et ce par n’importe qui.
Point 2 : Quand on utilise un outil quelconque (comme un CMS dans cette exemple), il faut respecter les bonnes pratiques liés à cet outil.
Point 3 : Quand une entreprise engage une nouvelle personne (en freelance, ou en salarié), il faut faire de vrai points pour suivre le projet au fur et à mesure des semaines.
Avez-vous déjà travaillé sur des projets avec des problèmes de ce genre ? N’hésitez pas à me laisser des commentaires.
les nouveautés de Highcharts
