BOOSTEZ VOTRE DESIGN, VOTRE ARCHITECTURE ET VOTRE INFRA

Living Documentation par l’auteur

Objectifs :

Comprendre l’approche Living Documentation

– Comprendre en quoi cette approche bouleverse la gestion des connaissances traditionnelles
– Découvrir les pratiques essentielles en théorie et par une mise en pratique
– Découvrir que la documentation est aussi un outil de feedback rapide
– Apprendre des moyens d’introduire cette approche dans votre environnement

Le transfert de connaissance est un enjeu majeur en développement logiciel. Cet enjeu est particulièrement aigu dans le long terme et avec du turnover dans les équipes. Pourtant, la documentation est souvent négligée, ou représente une quantité de travail importante. Et surtout, personne n’aime passer du temps à créer une documentation qui devient immédiatement obsolète !

L’approche Living Documentation (Documentation Vivante) représente une solution à la fois efficace et attractive, qui permet de maximiser le transfert et la conservation du savoir sans pour autant devenir une taxe élevée pour les membres de l’équipe. Surtout, c’est une approche qui permet l’accélération des rythmes de développement et de changements visés en Continuous Delivery, DevOps et toutes les approches agiles.

Si vous préférez coder plutôt qu’écrire de la documentation, vous aimerez la Living Documentation !

Programme :

Comprendre que la plupart des connaissances sont déjà représentées quelque part dans les artefacts, même sous une forme implicite.

• Réaliser que se parler et travailler ensemble peut être une forme de documentation suffisante, et en connaître les limites
• Apprendre à augmenter le code pour le rendre plus explicite pour une utilisation ultérieure par des humains et outils, par exemple pour baliser un Guided Tour au travers d’un système
• S’entraîner à faire la différence entre les connaissances stables ou volatiles, voir en quoi cela informe sur la façon dont on les manipule, et comment créer des documents Evergreen à zéro maintenance
• Apprendre à reconnaître les Shameful Comments qui suggèrent des améliorations du code
• Apprendre à visualiser la structure du design en générant un Living Diagram directement à partir du code, augmenté si nécessaire
• Découvrir comment un simple nuage de mots peut indiquer les défauts de votre modèle métier
• Apprendre à générer un Glossaire Vivant directement à partir du code
• Se familiariser avec les Architectural Decision Records pour aider à prendre de meilleures décisions, et en garder trace
• Réaliser que les Design Patterns aident à documenter des décisions de design très efficacement
• Comprendre les techniques fondamentales pour répondre à vos besoin spécifiques, et voir les pièges principaux à éviter
• Découvrir que la difficulté à mettre en oeuvre une documentation vivante est en soi un retour utile pour améliorer le système
• Apprendre à introduire le sujet de la documentation vivante dans votre projet et avec vos collègues

A savoir :

– La formation par l’auteur du livre de référence.
– Cette approche est décrite en détail dans le livre « Living Documentation » (ISBN-13: 978-0134689326) annoncé chez Addison-Wesley Professionals, écrit par Cyrille Martraire.
– Et pour démarrer dans de bonnes conditions, Arolla propose en exclusivité la formation par l’auteur. Même si vous n’avez pas lu le livre, au travers de présentations théoriques et d’exemples “les mains dans le code” vous apprendrez les points essentiels et les travers à éviter, et vous comprendrez comment optimiser votre approche de la documentation dans un projet en changement permanent.

Public :

Vous êtes développeur, architecte, team lead, testeur sachant coder ou bien coach ? Cette formation est pour vous !

Pré-requis :

– Tous les exemples se feront en Java (nécessite un poste de travail avec un IDE Java avec Maven installé), mais sont facilement extrapolables à d’autres univers, en particulier .Net.
– Avoir un minimum d’expérience dans la conception logicielle dans le cadre de projets d’entreprise.

Matériel pédagogique :

Cyrille Martraire distribuera les supports de la formation au format électronique PDF à la fin de la formation.

Prochaines sessions :

CONTACTEZ-NOUS

Prix : 1200 € HT

Durée : 1 jour

Méthodes pédagogiques :
60% théorique, 40% pratique

Offre inter-entreprise :
Petit-déjeuner – Déjeuner – Café et collation

Back to Top