Commentaires de news :
Vos Tutos 3.5 : un mythe, une légende

Edit : l'accès aux tutoriels est de nouveau possible (modification comprise). Nous pensons avoir corrigé un nombre important de problèmes mais nous vous conseillons toutefois la plus grande prudence dans les jours à venir (sauvegardez aussi vos textes sur votre ordinateur quelque temps). Merci.

Edit 2 : nous avons corrigé un très grand nombre de problèmes de transfert des tutoriels. Toutefois il semble rester quelques erreurs et nous ne vous conseillons pas d'utiliser vostutos pour le moment car vos modifications auraient de grandes chances d'être perdues. Il faudra attendre notre feu vert.




Villejuif, 5h30 du matin

La température extérieure me rappelle qu'il fait encore nuit, au cas où je ne l'aurais pas remarqué. La rue est déserte, comme on peut s'y attendre à cette heure. À l'arrêt de bus, personne. C'est tout juste si une voiture passe par là au bout de 5 minutes.

Le silence est total avant la bataille. Au bureau, j'arrive à 6h06. Natim est déjà là depuis 6 minutes. À l'autre bout de la planète, à Sydney en Australie, Karamilo est en ligne comme convenu la veille.

La lutte peut commencer. Bien qu'ayant préparé le moment depuis une semaine, nous ne pouvons nous empêcher de ressentir cette petite (mais délicieuse) pointe de stress avant une mise en production importante. Depuis la sortie de la version 3 du Site du Zéro, il s'agit en effet du plus important changement sur le principal module du site : "Vos tutos", qui gère l'affichage et l'édition des tutoriels.

Vos Tutos 3.5, une histoire mouvementée

L'histoire de Vos Tutos 3.5 commence à... oulah, il y a bien longtemps déjà. Pour bien comprendre, il faut au moins remonter à la sortie du Site du Zéro v3 (fin 2005), qui a marqué un tournant dans l'histoire du site en harmonisant entièrement son fonctionnement grâce à un développement maison pensé pour et par le Site du Zéro lui-même. Sans cette nouvelle version du site, nous n'aurions pas pu évoluer comme nous l'avons fait, c'est une évidence.

Malgré tout, quelques temps après la sortie de la v3 et de son tout nouveau module "Vos tutos 3.0" de gestion des tutoriels, karamilo et moi-même avons commencé à réfléchir à un nouveau modèle de données pour Vos tutos, plus flexible mais aussi beaucoup plus complexe. C'était au premier semestre de l'année 2007.

L'objectif était de poser des bases plus solides pour l'évolution des tutoriels car, étant donné que le trafic venait d'augmenter considérablement en l'espace d'une année, il valait mieux ne pas trop tarder à faire cette grosse migration une fois pour toutes afin de pouvoir évoluer plus sereinement par la suite.

Toutefois, le travail à faire (et le cahier des charges que j'ai rédigé pour karamilo, j'avoue ) était conséquent. Vos tutos devenait bien plus complexe à gérer pour le développeur, mais aussi beaucoup plus souple pour l'utilisateur (c'est-à-dire vous).

Nous avons recueilli un certain nombre de suggestions des utilisateurs et des validateurs pour leur faciliter la vie. Bref, nous avons souhaité être à l'écoute pour améliorer notablement Vos tutos. Toutefois, la mise à jour s'est transformé en une montagne à gravir, et bien que karamilo ait posé de solides bases, il lui était difficile de trouver le temps et les moyens de terminer le travail.

Natim à la rescousse

Le nouveau Vos Tutos (initialement la version 3.1 mais finalement renommée en 3.5 vu le nombre important de changements) avait besoin de main d'oeuvre. Prévu pour l'été dernier, il aura fallu attendre cet été et l'arrivée de Natim en tant que stagiaire dans nos bureaux pour en découdre.

Natim, particulièrement motivé pour terminer Vos tutos, a donc pris en charge la suite du code très tôt au début de son stage. Le résultat a été payant. Bien que nous avions initialement prévu une sortie pour fin juillet (il y a toujours des retards dans ce genre de cas ), nous sommes plus qu'heureux aujourd'hui de vous annoncer qu'un mythe vient de prendre fin : Vos tutos 3.5 est sorti. Ouf.

Les nouveautés de Vos Tutos 3.5

L'accouchement aura été difficile, c'est le moins que l'on puisse dire. Comme je vous l'ai signalé plus tôt, il faut mettre ça sur la complexité du nouveau modèle de données du module.

Sous le capot, tout a changé. Le moteur qui gère Vos tutos est très différent aujourd'hui. La base de données est conçue différemment pour le stockage, d'une manière qui va nous permettre par la suite de faire des évolutions importantes plus rapidement. La structure à représentation intervallaire nous permet notamment une plus grande souplesse pour la gestion du tutoriel. Ci-dessous, voici la représentation d'un tutoriel tel que stocké en bases de données :



En réalité, ce schéma est très simplifié. Pour bien faire, il faudrait le représenter en 3 dimensions pour prendre en compte toutes les versions possibles de chacun des éléments du tutoriel (toute l'évolution du tutoriel dans le temps en somme).



Considérez donc que vous ne pouvez pas voir la plupart des changements. L'interface est sensiblement la même pour vous, mais il y a tout de même un nombre non négligeable de changements que vous allez pouvoir constater et que je me fais un plaisir ici de lister (de manière non exhaustive) :

• Plusieurs auteurs peuvent travailler simultanément sur un même tutoriel. Les tutoriels peuvent donc avoir plusieurs auteurs associés.
• Réhabilitation de l'import de tutoriels au format .tuto version 3.5.0 (allelujah !).
• Sauvegarde de toutes les anciennes versions du tutoriel, ce qui vous permet de revenir à une ancienne version si vous le désirez. Aucune modification n'est donc perdue.
• Navigation largement améliorée au sein des tutoriels grâce à une liste déroulante qui permet de sauter à n'importe quel chapitre ou sous-partie en 2 clics. L'arborescence lors de l'édition d'un tutoriel est enfin correcte et on peut remonter de niveau sans problème.
• La liste des tutoriels est améliorée : elle affiche désormais les icônes des chapitres et met mieux en valeur les big-tutoriels en affichant le détail de leurs parties.
• Le cadre en haut à droite présentant le tutoriel a été revu et corrigé pour présenter uniquement les principales informations sur le tutoriel, et permet d'afficher ou de masquer les informations détaillées.
• Une navigation transversale au sein du tutoriel, particulièrement agréable pour son auteur mais aussi pour les visiteurs : on peut aisément passer du tutoriel à ses commentaires, mais aussi à sa version éditable si on en est l'auteur. L'accès à la modification du tutoriel n'a jamais été aussi intuitif !
• Possibilité d'indiquer la difficulté d'un tutoriel.
• Possibilité de choisir la licence de votre tutoriel parmi les 6 licences Creative Commons, en plus de la licence de base (qui reste par défaut) qui indique que personne n'a le droit de copier votre tutoriel sans votre accord. En savoir plus sur les licences.
• Possibilité d'indiquer si un zCorrecteur a corrigé votre tutoriel. Le site zcorrecteurs.fr a d'ailleurs été mis à jour pour supporter le nouveau format .tuto qui a légèrement changé pour prendre en compte notamment la difficulté du tutoriel.
• Les big-tutoriels (comprenant plusieurs chapitres) sont désormais considérés comme des tutoriels et on ne fait plus la distinction en base de données avec les mini-tutoriels. De ce fait, les big-tutoriels peuvent désormais être commentés et notés dans leur entièreté, mais aussi avoir une icône et une difficulté d'ensemble.

Notez qu'il est techniquement possible de rendre un tutoriel éditable par tout le monde (tous les membres et tous les invités) à la manière d'un wiki, mais nous n'avons pas activé cette option dans un premier temps. Cela demande une préparation et une gestion particulières. Nous envisageons toutefois de faire un test dans un bac à sable ("sandbox") pour voir si cela peut produire des résultats intéressants sans altérer bien sûr les tutoriels déjà présents (d'où l'intérêt de faire ce test dans un lieu séparé appelé "bac à sable").



Tous les tutoriels déjà écrits sur l'ancienne version de Vos tutos ont été récupérés grâce à un script automatique fait maison pour l'occasion. Cela a demandé un travail considérable.
Normalement il ne devrait pas y avoir d'erreurs, mais il est toutefois possible de rencontrer des bugs sur d'anciens tutoriels.

La suite ?

Dans un premier temps, nous allons probablement avoir quelques bugs à corriger que les utilisateurs nous soumettront (merci au passage de n'indiquer que des vrais bugs, pas des comportements étranges). Si vous avez des suggestions, nous les analyserons toutes dans le forum suggestions.
Merci de vérifier que le bug que vous allez rapporter n'a pas déjà été rapporté par quelqu'un d'autre avant de poster !

Par la suite, une fois que Vos tutos 3.5.0 sera bien stabilisé, nous envisagerons d'apporter des modifications par petites doses. Nous en avons un certain nombre déjà en tête (notamment la possibilité d'analyser la différence entre 2 versions), mais tout viendra en son temps.

D'ici peu, nous allons aussi mettre en place la recherche sur les tutoriels, promise et demandée depuis longtemps. Il faut dans un premier temps décanter les premiers bugs, puis nous nous en occuperons. Nous vous tiendrons informés dans une news.

Remerciements

• Natim en premier lieu, car c'est lui qui a fait le plus gros du travail ces dernières semaines et c'est à lui que vous devez la sortie de Vos tutos 3.5.
• Karamilo, qui a posé les bases de Vos tutos 3.5 et qui a continué à assister Natim dans sa tâche (même s'il était à l'autre bout du monde ).
• Ziame et Arconis, capables de dénicher des bugs là où la main de l'Homme n'a jamais mis le pied, pour leurs bêta-tests tout au long de la création de Vos tutos.
• L'équipe du Site du Zéro pour les bêta-tests des derniers jours, et notamment les validateurs pour leurs conseils et suggestions sur les fonctionnalités à implémenter.
• Les zCorrecteurs, notamment Vincent1870, pour leur aide, leurs idées et leurs conseils.
• Bluestorm et ses collègues pour leurs conseils sur les licences et pour avoir rédigé en un temps record un tutoriel permettant de comprendre les enjeux des licences.