Bienvenue sur Développement Agile

Référence sur le développement logiciel Agile. Nous traitons de conception, de programmation, de pratiques de génie logiciel, d'essais et d'autres sujets connexes.

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

Une roche dans le soulier

Publié par Jean-Francois Gilbert le jeudi 23 avril 2015 à 00:00

Course

Vous courez depuis un bon moment déjà et vous avez atteint votre vitesse de croisière. L'endorphine et le vent chaud du printemps provoquent en vous une douce euphorie. Tout va bien, vous filez le parfait bonheur! Soudain, vous la sentez vous piquer. Une petite roche s'est glissée dans votre soulier, puis à l'intérieur de votre bas. Au début, vous la remarquez à peine. Mais après un moment, l'inconfort fait place à la douleur. Vous pourriez décider de l'endurer et de continuer à courir. Après tout, vous avez la moitié du chemin de parcouru. Mais vous savez que la roche risque de vous couper. En modifiant un peu votre foulée, vous vous rendez compte que la roche se fait plus discrète. Cependant, après quelques kilomètres de plus, votre démarche inhabituelle créé une douleur musculaire pire que celle causée par la roche ! Parfois, la seule idée de prendre une pause de 2 minutes pour détacher notre soulier, retirer le bas et enlever le caillou nous horripile. Le rythme est bon, il ne faut surtout pas s'arrêter de courir ! Pourtant, on risque une blessure qui va nous ralentir encore plus.

Je vois souvent le même comportement dans des équipes de développement logiciel. On accumule de la dette technique. Le build fonctionne une fois sur deux. Des tests intégrés sont instables et on commence à les ignorer sans essayer de comprendre la cause du problème. Comme le coureur, l'équipe risque d'en souffrir beaucoup plus à long terme. Les tests n'étant plus fiables, on ignorera des symptômes évidents et la stabilité du logiciel s'en ressentira. Parfois ce sont des problèmes humains : l'ambiance dans l'équipe n'est plus bonne ou encore on accepte sans rien dire des comportements néfastes.

Ce n'est pas toujours plaisant de faire une pause dans le développement. Parfois on subit beaucoup de pression de nos supérieurs pour soutenir la cadence. Mais il faut vraiment le faire lorsque ça devient nécessaire. Les problèmes se règlent rarement d'eux-mêmes et il ne faut pas attendre que ça fasse mal pour s'y attarder. La rétrospective du sprint est le moment tout indiqué pour mettre en lumière les problèmes à corriger. On a souvent tendance à faire cet exercice un peu vite et à la légère. Il n'y a pourtant pas de meilleur moment pour discuter des embûches, que lorsque toute l'équipe est présente. C'est l'occasion de se questionner en tant qu'équipe et de relever les points agaçants qui vous empêchent de bien travailler. 

Une fois les irritants énumérés, c'est le moment de passer à l'action afin de les éliminer. À mon avis, ces actions devraient se retrouver dans le carnet du sprint autant que possible. Il faut les rendre visibles, les prioriser et les attaquer rapidement. L'équipe devrait s'engager à régler les problèmes de la même façon qu'elle s'engage à livrer de la valeur au client. Autrement, après quelques sprints une vilaine roche risque de réduire la capacité de l'équipe à satisfaire le client.

D'autres billets qui pourraient vous intéresser

 

Nettoyer votre code pour le rendre 5 S

Publié par David Beaumier, Jean-Francois Gilbert le lundi 20 avril 2015 à 08:13

Nous voilà rendus au 3ième concept de la méthode 5S : nettoyer (ou seiso en japonais). Comment ce principe, pensé à la base pour éviter la détérioration de la machinerie et des équipements, peut-il s’appliquer en développement logiciel?

Revenons pour une seconde aux fondements de la méthode 5S : une fois l’espace de travail ordonné (le premier S) et rangé (le second S), il devient beaucoup plus simple de le nettoyer puisque ce qui a besoin de nettoyage devient dès lors visible.  En développement, on pourrait penser à ces bouts de codes qui ont mal vieilli et qui handicapent d’une façon ou d’une autre le système. La fameuse dette technique, quoi!

Évidemment, pas besoin d’avoir fait les étapes 1 et 2 dans l’ensemble du code pour pouvoir passer au nettoyage. En procédant ainsi vous risqueriez même de salir de nouveau certains coins si l’application est d’une certaine envergure. Pourquoi ne pas directement cibler les morceaux qui sont connus pour dégager une odeur (virtuelle, on s’entend) nauséabonde? Probablement qu’il faudrait très peu de temps à l’équipe pour les identifier!

Nous vous proposons dans ce billet quelques suggestions pour procéder au nettoyage de votre base de code.

La règle des scouts

La bonne vieille règle des scouts, soit celle de laisser le campement plus propre au départ qu’à l’arrivée, peut être une bonne façon de procéder à un nettoyer graduel de votre code. En effectuant ici et là une extraction de méthode, un renommage ou en révisant une condition en introduisant un guard clause (quelqu’un a une bonne traduction à proposer?) votre équipe en viendra à rehausser la maintenabilité de la base de code. Et cela, sans impacter de façon significative son rythme de livraison habituel.

L’important dans toute opération de nettoyage de cette envergure est de se donner des objectifs atteignables, de mesurer la progression régulièrement (tous les sprints, par exemple) et d’ajuster le tir en fonction de ce que vous découvrirez. C’est surprenant de voir ce qu’on peut accomplir lorsqu’on rend visible la crasse qui se cache dans certains recoins du code!

Réingénierie (refactoring)

La réingénierie logicielle est la technique qui revient le plus souvent lorsqu’on parle de nettoyer du code existant.

La réingénierie logicielle est un processus ayant pour objectif de transformer et améliorer un logiciel à partir du modèle existant sans toutefois modifier son comportement externe.

Livre RefactoringtopatternMême si elle est simple à comprendre, c’est une technique qui demande beaucoup de pratique pour développer les bons réflexes et savoir bien doser son utilisation. Si vous débutez avec cette pratique, la lecture du livre Refactoring: Improving the Design of Existing Code de Martin Fowler s’avère toujours un bon point de départ (même après plus de 15 ans). Un catalogue des différents types de réingénierie est aussi disponible en ligne.

Le livre de Kerievsky s’adressera quant à lui aux personnes qui ont déjà un peu d’expériences avec la réingénierie et qui souhaitent voir comment cette technique peut être combinée avec les patrons de conception.

Scott Ambler et Pramod Sadalage ont même appliqué les principes de la réingénierie logicielle aux bases de données relationnelles dans leur livre Refactoring Databases: Evolutionary Database Design.  Vous n’aurez dorénavant plus aucune excuse pour ne pas nettoyer votre schéma de base de données!

Outils disponibles

Il existe aujourd’hui des fonctionnalités de réingénierie dans pratiquement tous les IDEs. Sinon, des extensions plus avancées peuvent vous aider, tel que Resharper sous Visual Studio. Ces outils vous sauveront du temps, tout en évitant les erreurs typiques associées aux opérations manuelles de rechercher/remplacer.

Des outils spécialisés pour les SGBDR, tels que Liquibase ou SQL Server Data Tools vous aideront à produire les scripts de mise à jour requis pour offrir une cure de jeunesse à vos bases de données. La vidéo ci-dessous vous permettra d'avoir un aperçu de l'utilisation de Liquibase.

Identifier les candidats potentiels au nettoyage

Encore une fois, les techniques du management visuel peuvent venir à notre rescousse pour vous aider à identifier les bouts de code qui sont de bons candidats à la réingénierie. Par exemple, l'extension Microsoft CodeLens Code Health Indicator (pour Visual Studio Ultimate) permet d’obtenir plusieurs mesures sur la maintenabilité du code et l’indicateur visuel vous indiquera si vous êtes face à un bout de code qui rencontre les exigences (en tout cas, celles de Microsoft). On peut même voir si la modification courante améliore ou non le code et ajuster le tir au besoin. Ça réduit de beaucoup la boucle de rétroaction.

Codehealth

SourceMonitor est un autre outil qui peut aider à identifier les classes qui ont besoin d’un peu d’amour. Bien qu’il ne soit pas directement intégré à un IDE, SourceMonitor a l’avantage de supporter plusieurs langages de programmation, tels que C++, C, C#, VB.NET, Java et Delphi. Il permet de cibler un sous-ensemble plus ou moins grand de votre base de code et produit les métriques de différentes façons, tel que démontré ci-dessous. Il est aussi possible d'en automatiser l'utilisation de façon à prendre des mesures sur une base régulière.

Sourcemonitor

Et vous, quels sont les techniques et outils qui vous permettent de nettoyer votre code? Quels approches ont été les plus bénéfiques pour votre équipe?

Mise à jour

Voici les liens pour consulter les autres articles.

D'autres billets qui pourraient vous intéresser

Agile comme un enfant

Publié par Marc Allard le mardi 14 avril 2015 à 08:12

Quand il était responsable de l’«expérience des usagers» chez Palm, l’entreprise pionnière de l’ordinateur de poche, Peter Skillman a inventé un exercice de design surnommé le «challenge de la guimauve». Le défi consiste à bâtir la plus haute tour possible avec 20 spaghettis, un mètre de ruban adhésif et un bout de ficelle. Les participants disposent de 18 minutes pour construire la tour, sur laquelle ils doivent être capables de faire tenir une guimauve. 

Durant cinq ans, au début des années 2000, Skillman a observé des tas de groupes, divisés en équipes de quatre, se livrer à l’exercice. Il a notamment réuni des ingénieurs en télécoms taïwanais, des étudiants en administration et des enfants de la maternelle. Sans trop de surprise, les ingénieurs se sont distingués et les étudiants en administration se sont plantés. 

Mais devinez qui a fait mieux que tout le monde? Les enfants, qui ont réussi à bâtir une tour de 1 pouce plus élevé que les ingénieurs.

Skillman a raconté cette anecdote lors d’une présentation filmée qu’il a donnée dans une conférence sur la création technologique en 2007. Dans la salle se trouvait Megan McCardle. Cette journaliste, auteure et ex-étudiante en administration a écrit un livre publié en 2014 intitulé «The Up Side of Down», dans lequel elle entame son premier chapitre en revenant sur le challenge de la guimauve.

Comment les enfants ont-ils réussi à battre les ingénieurs ? nous demande McCardle. «Par le simple processus de l’expérimentation et de l’itération, écrit-elle. Ils ne se sont pas laissé freiner par des assomptions sur les règles du jeu — ils ont été le seul groupe à demander plus de spaghetti. Et parce qu’ils avaient plus de spaghettis, ils n’ont pas eu à perdre du temps à réfléchir au look de la tour ou à qui devrait écrire l’énoncé de vision. Ils se sont juste lancés et ont commencé à créer, laissant de côté tout ce qui ne marchait pas.» 

D’une certain façon, les enfants se sont montrés très agiles. Ils ont épousé la philosophie du kaïzen, cette pratique japonaise de l'amélioration en continu qui mise sur de petits changements fréquents plutôt qu’une longue planification élaborée à partir d’une idée unique. Quand on y pense, les jeunes enfants sont des adeptes naturels du kaïzen. Avant de comprendre le langage, les bébés sont l’incarnation même de l’amélioration en continu, se développant essentiellement à coups d’essais et d’erreurs. Les tout-petits bénéficient des enseignements de leurs parents, mais leur inclinaison pour l’expérimentation reste intacte, comme en témoignent tant de traces de crayon-feutre sur des murs blancs. 

En fait, cette inclinaison ne s’effrite qu’à mesure où les enfants commencent à craindre ce qui n’effrayait pas encore trop nos champions de la tour en spaghetti : la peur de l’échec.

The Up Side Of DownComme l’explique Megan McCardle, dans la vie ou au travail, c’est souvent cette peur qui est le plus gros obstacle à l’amélioration. Or, le challenge de la guimauve le montre bien : «si tu n’as pas beaucoup de temps de devant toi, le plus important c’est que tu échoues», dit Skillman à son audience. «Tu échoues plus tôt pour pouvoir réussir plus rapidement». L’essai/erreur est le style naturel d’apprentissage du cerveau, qui forge des connexions efficaces une fois qu’il a éliminé toutes celles qui ne le sont pas, explique McCardle.

J’ai lu quelque part qu’un génie, c’est quelqu’un qui déjà a commis toutes les erreurs. Bien sûr, précise McCardle, il ne s’agit pas d’échouer pour le plaisir d’échouer ou de prendre des risques inconsidérés. L’idée est de prendre beaucoup de petits risques calculés, parce que ça reste la seule façon de voir ce qui fonctionne vraiment. 

C’est ce qui j’ai essayé récemment avec ma fille de 4 ans, qui n’arrivait pas à zipper son manteau. Durant une semaine, je lui ai laissé le temps chaque matin d’essayer de le faire toute seule. Ensemble, on a pris le risque qu’elle s’impatiente et se fâche et qu’on arrive beaucoup plus tard à la garderie — ce qui est effectivement arrivé. Mais au bout d’une semaine, à force d’essais et d’erreurs, elle a compris le fonctionnement du zipper et, depuis, c’est un dossier clos! 

La semaine prochaine, je pense qu’elle sera mûre pour la tour de spaghettis.

D'autres billets qui pourraient vous intéresser

 

Appliquer les principes du « 5 S » dans votre code – Ranger

Publié par David Beaumier, Jean-Francois Gilbert le jeudi 9 avril 2015 à 07:45

Dans ce second article de la série sur l’application de la méthode 5S en développement logiciel nous abordons le second concept : ranger (ou Seiton, en japonais). On peut résumer le concept de cette façon : « Une place pour chaque chose, et chaque chose à sa place » (source : Wikipedia).

Le but derrière cette notion de rangement est de s’assurer que les équipiers ne perdent pas de temps de travail à chercher les éléments dont ils ont besoin dans le cadre de leur travail. Dans le cas du développement logiciel il peut s’agir autant des classes communes, d’utilitaires pour effectuer certaines opérations que de documentation sur les patrons de conception. Quoi de plus frustrant que de chercher pendant plusieurs minutes où a été déposé l’utilitaire qui permet de convertir une base de données!

Vous trouverez ci-dessous quelques suggestions pour optimiser le rangement dans votre équipe de développement logiciel.

Bien structurer votre projet

Le découpage (dossiers) de votre projet devrait s’appuyer sur le vocabulaire du domaine d’affaires. Il est important d’avoir une uniformité dans le langage utilisé et cela doit se refléter dans le code aussi. Si on parle de « gestion des accès » dans votre application on ne devrait pas retrouver un dossier « autorisations » dans le projet.

Dans un projet Web, il peut être aussi intéressant de penser à une structure qui permette de rapidement distinguer les artéfacts selon qu’ils s’appliquent à la structure du document (html), aux styles (CSS) ou au code (JS).

Assurer une cohérence physique des dossiers et des paquetage

Des outils comme Resharper vous indiqueront s’il existe des écarts entre les dossiers physiques et le nom des paquetages (namespaces dans ce cas-ci). Avec le temps, on peut avoir renommé quelques dossiers, mais avoir oublié de faire les ajustements dans le code.

5S Ranger Resharpernamespacelocation

Valider la dépendance entre les paquetages

 La dépendance entre les paquetages devrait,  elle aussi, respecter le découpage fonctionnel. Ces dépendances sont souvent exprimées en UML sous forme de diagramme de paquetages.

Les fonctionnalités de Dependency Graph et de CodeMap de Visual Studio permettent de dresser une cartographie des dépendances qui vous permettra de valider que celles-ci sont conformes à la cible.

5S Ranger Dependencygraph

5S Ranger Vscodemap

Des outils comme JArchitect peuvent produire diverses métriques sur le niveau de dépendance entre les différentes parties du code. Celles-ci vous permettront de vérifier si les principes architecturaux ont été respectés et vous éviteront d’avoir un couplage trop fort entre les entités de votre système, ce qui a tendance à rendre l'entretien et la réingénierie plus difficile à long terme.

5S Ranger Dependencymatrix

N’oubliez pas la documentation

On ne parle pas ici de la documentation du code source en lui-même (bien qu’elle soit importante), mais plutôt de celle qui forme la base de connaissances de votre équipe. Comment un nouvel équipier saura quel outil utiliser pour produire un script de mise à jour de la base de données relationnelle? Où trouvera-t-il les règles de nomenclatures à respecter?

Que vous utilisiez un wiki ou un autre outil de gestion documentaire, assurez-vous d’y consigner les informations importantes. Souvent, un bref résumé et quelques liens pertinents permettent de conserver une documentation suffisante sur un sujet. Comme le disait Albert Einstein, « Ne mémorisez pas une information que l’on peut facilement retrouver ».

Mise à jour

Voici les liens pour consulter les autres articles.

D'autres billets qui pourraient vous intéresser

Archive