Standardiser ses activités de développement

Publié par David Beaumier, Jean-Francois Gilbert le mercredi 29 avril 2015 à 14:33

Pour ce 4ième billet de la série sur l’application de la méthode des 5S en développement logiciel nous aborderons l’aspect standardisation (ou Seiketsu en japonais). Ce principe vise principalement à :

  • Standardiser les meilleures pratiques;
  • S’assurer que chaque processus est appuyé sur une façon de faire éprouvée et connue;
  • Maintenir le niveau de qualité dans l’ensemble des activités;
  • Préserver l’ordre et la propreté (les 3 premiers s).

On ne parlera donc pas des normes telles que CMMI, Macroscope ou ITIL dans ce billet. La standardisation dont on parle est à un niveau beaucoup plus tactique et se trouvera complémentaire à vos processus.

Établir les règles

Clean CodePeu importe les conventions, normes et orientations que vous choisirez, l’important est qu’elles soient suivies. Certains membres de l’équipe pourraient préférer une approche différente et ils ont tout à fait le droit. Cela ne devrait toutefois pas les autoriser à contourner les règles communes. Pour favoriser l’adoption de ces règles et faire en sorte qu’elles soient accordées au « nous » il est toujours préférable de les choisir collectivement que de les imposer.

Un des bons points de départ peut être que chaque membre de l’équipe fasse la lecture (ou la relecture) du livre Clean Code de Bob Martin. Même s’il date d’un peu plus de 6 ans, ce livre demeure une référence incontournable pour qui veut produire du code de qualité. J’ai été agréablement surpris de voir qu’il était toujours dans le top 20 des meilleurs vendeurs en développement logiciel.

Adopter un standard de programmation

Bon nombre de ces standards ont déjà été écrits. Vous pourriez donc vous sauver bien du travail en adoptant une convention existante. Par exemple :

Si vous choisissez d’en bâtir un qui soit spécifique à votre équipe, essayez tout de même de respecter les conventions habituelles de votre langage (les nouveaux équipiers vous en seront très reconnaissants). Adoptez aussi un style concis : énoncez la règle et évitez les longues justifications.

N’oubliez pas le code qui tourne autour des bases de données. Sans standard les artéfacts peuvent devenir rapidement aussi différents les uns des autres que le sont les flocons de neige. Encore plus vrai si vous utilisez des artéfacts contenant de la logique (fonctions, procédures stockées, etc.). L'uniformisation de votre base de données viendra aussi vous simplifier la vie si vous souhaitez éventuellement intégrer un ORM car la conversion OO-SGBD s'appui sur une convention.

Au-delà des conventions

La standardisation va bien au-delà des simples conventions.  Ce souci d’uniformisation devrait transparaître dans l’ensemble de votre application.  Prenons l’exemple de Sonos, ce système intelligent de haut-parleurs sans-fil. Sonos propose une application servant à contrôler votre système sur les plateformes les plus répandues (Android, iOS, Mac et Windows). L'entreprise s'est efforcée de standardiser l'expérience utilisateur entre toutes ces plateformes, ce qui fait que vous bénéficierez d'un « look and feel » cohérent que vous utilisez la version iOS ou Windows. En plus, Sonos a réussi cette standardisation tout en tirant profit des capacités particulières à chaque plateforme.

Dans votre application, la standardisation devrait donc transparaître autant de l’intérieur (le code) que du point de vue du client. Voici quelques exemples de standardisation dans un applicatif :

  • Établir un vocabulaire uniforme du domaine d’affaire et s’y référer constamment;
  • Définir des abstractions-clé arrimées avec le domaine d’affaires et en promouvoir l’utilisation dans le vocabulaire autant que dans le code;
  • Favoriser la création de classes réutilisables;
  • Bâtir des mécanismes de déploiement automatisés;
  • Proposer une expérience utilisateur uniforme dans tous les modules.

Une équipe qui gère les dépendances entre les fichiers Javascript à l’aide d’une approche déclarative (telle que proposée par RequireJS) se trouve à standardiser ses façons de faire tout en améliorant la qualité du code et en offrant une meilleure vitesse d’exécution pour l'utilisateur.

Détecter les écarts

Si vous souhaitez maintenir le niveau de qualité à long terme, rien de mieux que de mettre en place des points de contrôle fréquents, idéalement automatisés. Dès que vous trouvez un écart par rapport à la cible, trouvez un moyen que cette situation ne se reproduise pas. Avec le temps vous bâtirez un solide harnais de sécurité.

Un plugiciel comme Checkstyle (pour Eclipse), Rubocop en Ruby ou FxCop (la fonctionnalité Static Code Analysis de Visual Studio) permet de vérifier si les standards de programmation sont respectés. Il est possible de choisir quelles règles doivent s’appliquer et même d’en développer des personnalisées, si besoin est.

Checkstyle

Il est même possible d’appliquer des vérifications automatisées au niveau du respect des principes d’architecture. Visual Studio offre la possibilité de valider que les dépendances entre les différents projets de votre solution respectent les choix que vous avez faits au niveau du diagramme d’architecture. Cette validation peut même être intégrée au processus d’intégration continue. Vous aurez rapidement une rétroaction si un équipier contourne le modèle établi. Beaucoup plus intéressant que de le réaliser quelques semaines plus tard!

Regarder le processus dans son ensemble

Le principe de standardisation aura avantage à s’appliquer au-delà des activités de « codage ». Si vous ne l’avez pas déjà fait, pourquoi ne pas illustrer votre processus de développement dans son ensemble. Cela vous permettra de voir les grandes activités qui le composent et creuser pour voir quels sont les standards existants pour chacune d’elles.

Par exemple, est-ce que la gestion du carnet est standardisée? Est-ce que la formule « En tant que <acteur> je veux <besoin> afin de <bénéfice d’affaires> » est systématiquement utilisée pour vos stories? Les critères d’acceptation sont-ils définis avant la cérémonie de planification? Est-ce que le carnet de produit est révisé (backlog grooming) sur une base régulière? Ce sont toutes des activités qui auront avantage à être standardisées selon votre réalité.

Il en sera de même pour les activités de déploiement (le fameux DevOps) ou de prise en charge des demandes des clients. En fait, standardiser ce type d’activités aura un double bénéfice en offrant à vos clients une expérience beaucoup plus uniforme et prévisible.

Enseigner et diffuser

Vous aurez beau établir les meilleurs standards, développer des procédures simples et précises et offrir des outils hors-pairs, si les membres de votre équipe ne savent pas qu’ils existent ou comment les utiliser, vous risquez de ne pas être plus avancés!

Il existe une foule d’outils disponibles pour consigner ce genre d’information. Peu importe l’outil que vous choisirez (tel qu’un wiki, par exemple), assurez-vous que l’outil en question offre un bon moteur de recherche et encouragez les gens à s’y référer et, surtout, à garder le contenu à jour.

Prévoyez aussi accompagner les gens de votre équipe. Il se peut que le p’tit nouveau oublie d’appliquer certaines des règles de conception (pourtant inscrites dans le wiki) et un rappel amical peut faire toute la différence. La programmation en paire ou les revues de conception sont des façons de guider les équipiers dans l’application des standards.

Contrôler et adapter

La standardisation n’est pas une activité dogmatique et elle ne vise pas à réduire la capacité d’innovation de votre équipe. Il ne faut pas hésiter à remettre en question les façons de faire afin de ne pas tomber dans le piège du « c'est de même que ça se fait depuis toujours ici ». On le sait, en informatique la technologie et les outils évoluent à vitesse grand V. Les façons de faire doivent s'adapter. Les rétrospectives d’équipe sont un bon moment de se questionner sur les standards existants et proposer des changements qui seraient bénéfiques.

Mise à jour

Voici les liens pour consulter les autres articles.

D'autres billets qui pourraient vous intéresser

blog comments powered by Disqus

0 Comments:

Post a comment

Comments have been closed for this post.