Living documentation au service de l'agilité

19 & 20 septembre 2023 - Paris, Niort
Living documentation au service de
l’agilité
Dorra Bartaguiz
PLATINUM SPONSOR
GOLD SPONSOR
SILVER SPONSOR
PARTENAIRE
DORRA BARTAGUIZ
• VP TECH (DIRECTION TECHNIQUE)
• CO-AUTEURE & ILLUSTRATRICE
• DIFFÉRENTS RÔLES
• DEV/ARCHI
• COACH/ FORMATRICE
• REVIEWER DE PROGRAMMEZ!
• PROF EN ÉCOLE D’INGÉ
Formation
Sessions intra
et inter-entreprise,
sur site ou à distance
Coaching
Mentoring et
accompagnement
sur le terrain
Projet
Engagement de moyens et
engagement de qualité
Conseil
Diagnostic et études
sur mesure
Nos domaines d’expertise
Attitudes et pratiques craft
NOS FORMATS D’INTERVENTION
PREMIÈRE JOURNÉE
DANS UNE ÉQUIPE
PETIT DÉJEUNER
https://www.pinterest.fr/pin/10907224090018175/
Accueil chaleureux Longue pause-café
le matin
Qui est qui ?
PETITES BLAGUES
Brise-glace
C’EST PARTI !
SUR MON BUREAU
DOC DU PROJET
https://www.pinterest.fr/pin/749497562969339085/
UNE JOURNÉE DE
LECTURE
ET PLEIN DE QUESTIONS
https://www.pinterest.fr/pin/375558056417732679/
DOCUMENTATION
SOURCE DE RÉPONSES OU QUESTIONS ?
SOURCE DE FRUSTRATION
SOURCE DE FRUSTRATION
QUI LA CONSOMME
A jour ?
Obsolète ?
SOURCE DE FRUSTRATION
QUI LA PRODUIT
Pas le
temps
Pas l’envie
SOURCE DE FRUSTRATION
POUR TOUT LE MONDE
Pas le
temps
Pas l’envie
A jour ?
Obsolète ?
BUT DE LA
DOCUMENTATION
TRANSMISSION
ACCESSIBILITÉ
MÉMOIRE DU FUTUR
CONFORME À L’ATTENDU
SHARED DOCUMENTS AREN’T
SHARED UNDERSTANDING
@JEFFPATTON
TRANSMISSION
TRANSMISSION
« Software Craft » Martraire, Thiéfaine, Bartaguiz, Hiegel, Fakih - Dunod
ACCESSIBILITÉ
https://wanderlustale.com/labbaye-dadmont-le-tresor-cache-de-lautriche/
MÉMOIRE DU
FUTUR
CONFORME À L’ATTENDU
REVENONS AU
MANIFESTE AGILE
AGILE MANIFESTO
• INDIVIDUALS AND INTERACTIONS OVER PROCESSES AND TOOLS
• WORKING SOFTWARE OVER COMPREHENSIVE DOCUMENTATION
• CUSTOMER COLLABORATION OVER CONTRACT NEGOCIATION
• RESPONDING TO CHANGE OVER FOLLOWING A PLAN
WE EMBRACE
DOCUMENTATION, BUT NOT
HUNDREDS OF PAGES OF
NEVER-MAINTAINED AND
RARELY-USED TOMES.
HTTPS://AGILEMANIFESTO.ORG/HISTORY.HTML
DOCUMENTATION MANUELLE
TROP D’ÉNERGIE GASPILLÉE
COMMENT ÉCONOMISER
L'ÉNERGIE ?
LIVING DOCUMENTATION
=
DOCUMENTATION
VIVANTE
CIBLE DE LA DOCUMENTATION
ENSEMBLE DES OPÉRATIONS, DES
MÉTHODES, ETC., QUI FACILITENT LA
COLLECTE, LE STOCKAGE, LA RECHERCHE
ET LA CIRCULATION DES DOCUMENTS ET
DE L'INFORMATION
HTTPS://WWW.LAROUSSE.FR/
DOCUMENTATION
MA DÉFINITION DE LA DOCUMENTATION
• CRISTALLISATION DE DISCUSSIONS CHOISIES ENTRE DEUX PARTIES
• CR DE RÉUNIONS, SPÉCIFICATION/CONTRAT ENTRE DEUX PARTIES…
• SIMPLIFICATION D’UNE INFORMATION POUR UNE POPULATION
• DÉFINITIONS, SCHÉMAS, EXEMPLES…
• UNE MÊME INFORMATION PEUT ÊTRE DÉCRITE DE PLUSIEURS FAÇONS
IDENTIFIER LA CIBLE DE LA
DOCUMENTATION
EXEMPLE EN CHIMIE
UNE DOC PAR RELATION
Schéma
DOCUMENTATION
VIVANTE ?
POPULARISÉ AVEC
HTML
Documentation
Scénarios
Gherkin
Specflow Living Doc/
Cucumber & Pickles
Exemples
Scénarios
Gherkin
Tests
automatisés
Documentation
générée
Besoin
Expliciter via
Formaliser en
Automatiser
Transformer
Présenter
SPECIFICATION BY EXAMPLE HELPS TEAMS
ESTABLISH A COLLABORATIVE SPECIFICATION
PROCESS THAT LOWERS PROBLEMS IN THE
MIDDLE OF AN ITERATION […] AND DOESN’T
REQUIRE MONTHS OF WRITING LONG
DOCUMENTS.
GOJKO ADZIC
« SPECIFICATION BY EXAMPLE »
LIVING DOCUMENTATION
=
EVERGREEN
DOCUMENTATION
DOCUMENTATION
SYSTÈME
SYSTÈME
DOCUMENTATION
LIVING DOCUMENTATION
=
PLUS DE TRANSPARENCE
Living documentation au service de l'agilité
EXEMPLE DE LIVING
DOCUMENTATION
CURRENCY CONVERTER
-
DÉMO GHERKIN
SCENARIO: SIMPLE CONVERSION ROUNDING TO CENTS
GIVEN THE EUR TO USD EXCHANGE RATE IS 1.1329
WHEN I CONVERT 10 EUR TO USD BY ROUNDING TO CENTS
THEN I GET 11.33 USD
EXEMPLE SCÉNARIO GHERKIN
GIVEN THE EUR TO USD EXCHANGE RATE IS 1.1329
[GIVEN("THE (.*) TO (.*) EXCHANGE RATE IS (.*)")]
PUBLIC VOID GIVENTHEEXCHANGERATEIS
(STRING SOURCECURRENCY, STRING TARGETCURRENCY, DECIMAL RATE)
EXEMPLE SCÉNARIO GHERKIN
EXEMPLE SCÉNARIO GHERKIN
LIVINGDOC
FEATURE-FOLDER <<REPERTOIRE_FEATURES>>
-T <<TEST_EXECUTION.JSON>>
--OUTPUT <<DOC.HTML>>
EXEMPLE SCÉNARIO GHERKIN
Living documentation au service de l'agilité
Living documentation au service de l'agilité
Living documentation au service de l'agilité
S’OCCUPER DE LA
DOCUMENTATION
VIVANTE
BESOIN DE SOINS
• CODE DE GÉNÉRATION DE DOC
» À ÉCRIRE
» À MAINTENIR
» SI EXTERNALISÉ, AVEC SES PROPRES TESTS
» À SIMPLIFIER : MINIMUM D’EFFORT
• PRÊT À ÊTRE SUPPRIMÉ
» PERSONNE N’EN A PLUS BESOIN
» IMPORTANCE DE SIMPLICITÉ
Exemples
Scénarios
Gherkin
Tests
automatisés
Documentation
générée
Besoin
Expliciter via
Formaliser en
Automatiser
Transformer
Présenter
Atelier :
Example mapping
Acteurs :
• DEV
• PO
• QA
LIVING DOCUMENTATION
=
PLUS DE COMMUNICATION
Living documentation au service de l'agilité
POPULARISÉ AVEC
HTML
Documentation
Scénarii
Gherkin
Specflow Living Doc/
Cucumber & Pickles
GÉNÉRALISÉ AU-DELÀ DES SPECS
Générateur
Code
Production
Base
Sprints
Documentation
Calendrier
Schéma
IT’S POSSIBLE TO GET THE SAME BENEFITS OF LIVING
DOCUMENTATION FOR ALL ASPECTS OF A
SOFTWARE DEVELOPMENT PROJECT: BUSINESS
BEHAVIORS, OF COURSE, BUT ALSO BUSINESS
DOMAINS, PROJECT VISION AND BUSINESS DRIVERS,
DESIGN AND ARCHITECTURE, LEGACY STRATEGIES,
CODING GUIDELINES, DEPLOYMENT AND
INFRASTRUCTURE.
CYRILLE MARTRAIRE
« LIVING DOCUMENTATION »
DÉMO ARCHI
EXEMPLE DE LIVING
DOCUMENTATION
CURRENCY CONVERTER
-
https://github.com/iAmDorra/CurrencyConverter/blob/master/CurrencyConverter.LivingDocumentation/HexagonalArchiDocument.cs
DÉMO GUIDED TOUR
EXEMPLE DE LIVING
DOCUMENTATION
CURRENCY CONVERTER
-
https://github.com/iAmDorra/
CurrencyConverter/blob/master/
CurrencyConverter.LivingDocumentation/
GuidedTourDocument.cs
DÉMO
MANUEL D’UTILISATION
EXEMPLE DE LIVING
DOCUMENTATION
CURRENCY CONVERTER
-
https://github.com/iAmDorra/CurrencyConverter/blob/master/
CurrencyConverter.Web.Tests/SeleniumTest.cs
PAR OÙ COMMENCER ?
Code
Production
Base
Sprints
Documentation
Calendrier
Schéma
IDENTIFIER LE BESOIN
• A LA RÉTRO, AU DAILY MEETING…
• IDENTIFIER LES PARTIES OBSCURES
• ETONNEMENT DES NOUVELLES ARRIVÉES
• LES ANCIENS MEMBRES AUSSI
• IDENTIFIER LES CONNAISSANCES NON PARTAGÉES
• CONNAISSANCES CHEZ UNE SEULE PERSONNE OU PETIT GROUPE
• LES POINTS DE BLOCAGE RÉCURRENTS
TROUVER UNE SOLUTION
• IDENTIFIER QUELLE DOCUMENTATION CRÉER
• IDENTIFIER LA CIBLE DE LA DOCUMENTATION
• CHERCHER À AUTOMATISER LA GÉNÉRATION
Ne pas le faire seul.e !
Utilisez la dynamique du groupe
LIVING DOCUMENTATION
=
PLUS DE COLLABORATION
Living documentation au service de l'agilité
STRATÉGIE DE
DOCUMENTATION
QUESTIONS À SE POSER
On me
demande
une doc ?
La cible
de la doc
est
précise ?
Ne pas faire de doc
Non
Oui
Non /A tout le monde
Oui
QUESTIONS À SE POSER
On a besoin
d’une doc
pour se
rassurer ?
Gérer le pb de
confiance avant !
Oui
Non
Cible identifiée
Tant mieux
Mieux collaborer
Le partage
peut passer
par de la
conversation/
collaboration
?
Oui
Non
QUESTIONS À SE POSER
La source de
l’information
est identifiée
?
L’information est
exploitable en
l’état ?
Ne pas faire de doc
Identifier la source avant
Non
Oui
Doc nécessaire et
irremplaçable par
de la conversation/
collaboration
Non
Augmenter/réorganiser
la source d’info
Oui
QUESTIONS À SE POSER
Information
exploitable
ou augmentée
L’information
est stable ?
L’information
est
redondante ?
Variabiliser les infos
Non, volatile
Oui, stable
Oui
Non
Générer de la doc
Vérifier la cohérence entre
sources
PRINCIPES DE LA
DOCUMENTATION
VIVANTE
Insightful
Low effort
Collaborative
Reliable
Réduction du temps lié à
la rédaction/mise à jour
de la documentation
Fiable, précise et
synchronisée avec le
livrable à tout moment.
Idée claire,
prise de décision
délibérée
Favoriser les échanges,
la construction collective
LIVING DOCUMENTATION
=
PLUS DE TRANSPARENCE
PLUS DE COMMUNICATION
PLUS DE COLLABORATION
MERCI
* TOUTES LES ILLUSTRATIONS SONT RÉALISÉES PAR MES SOINS
* HTTPS://GITHUB.COM/IAMDORRA/CURRENCYCONVERTER
VOS FEEDBACKS
1 sur 79

Recommandé

De la multiplicité des sources d’informations à la consolidation : avantages ... par
De la multiplicité des sources d’informations à la consolidation : avantages ...De la multiplicité des sources d’informations à la consolidation : avantages ...
De la multiplicité des sources d’informations à la consolidation : avantages ...Nuxeo
285 vues25 diapositives
DevOps et ALM : Application Lifecycle Management: Continuous Delivery avec Vi... par
DevOps et ALM : Application Lifecycle Management: Continuous Delivery avec Vi...DevOps et ALM : Application Lifecycle Management: Continuous Delivery avec Vi...
DevOps et ALM : Application Lifecycle Management: Continuous Delivery avec Vi...Adrien Clerbois
109 vues27 diapositives
Devops, un tour d'horizon - Eutelsat 2018 par
Devops, un tour d'horizon -  Eutelsat 2018Devops, un tour d'horizon -  Eutelsat 2018
Devops, un tour d'horizon - Eutelsat 2018Ludovic Piot
335 vues38 diapositives
TalkRendonsDDDauxDevs_AlpesCraft.pdf par
TalkRendonsDDDauxDevs_AlpesCraft.pdfTalkRendonsDDDauxDevs_AlpesCraft.pdf
TalkRendonsDDDauxDevs_AlpesCraft.pdfArnaud Thiéfaine
34 vues60 diapositives
Présentation 1er Comite de repérage régional par
Présentation 1er Comite de repérage régionalPrésentation 1er Comite de repérage régional
Présentation 1er Comite de repérage régionalbrigal
560 vues57 diapositives
Presentation lab de promotech offre de coworking - 15 fev 2012 par
Presentation lab de promotech   offre de coworking - 15 fev 2012Presentation lab de promotech   offre de coworking - 15 fev 2012
Presentation lab de promotech offre de coworking - 15 fev 2012PROMOTECH CEI
1.3K vues35 diapositives

Contenu connexe

Similaire à Living documentation au service de l'agilité

Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric... par
Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...
Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...ENSIBS
3K vues15 diapositives
Definition of Done - Agile Pays Basque - 23/09/2016 par
Definition of Done - Agile Pays Basque - 23/09/2016Definition of Done - Agile Pays Basque - 23/09/2016
Definition of Done - Agile Pays Basque - 23/09/2016ffaure32
806 vues49 diapositives
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti... par
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...Nathalie Caclard
1.1K vues18 diapositives
Vis ma vie de chef de projet Drupal | Drupagora 2013, Paris par
Vis ma vie de chef de projet Drupal | Drupagora 2013, ParisVis ma vie de chef de projet Drupal | Drupagora 2013, Paris
Vis ma vie de chef de projet Drupal | Drupagora 2013, ParisActency
4.5K vues42 diapositives
Appréhender et s'adapter aux mutations de l'économie numérique. par
Appréhender et s'adapter aux mutations de l'économie numérique. Appréhender et s'adapter aux mutations de l'économie numérique.
Appréhender et s'adapter aux mutations de l'économie numérique. Thibaut Brousse
1.2K vues91 diapositives
Bonnes pratiques pour développer son appli mobile par
Bonnes pratiques pour développer son appli mobileBonnes pratiques pour développer son appli mobile
Bonnes pratiques pour développer son appli mobilepolenumerique33
779 vues68 diapositives

Similaire à Living documentation au service de l'agilité(20)

Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric... par ENSIBS
Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...
Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric...
ENSIBS3K vues
Definition of Done - Agile Pays Basque - 23/09/2016 par ffaure32
Definition of Done - Agile Pays Basque - 23/09/2016Definition of Done - Agile Pays Basque - 23/09/2016
Definition of Done - Agile Pays Basque - 23/09/2016
ffaure32806 vues
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti... par Nathalie Caclard
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti...
Nathalie Caclard1.1K vues
Vis ma vie de chef de projet Drupal | Drupagora 2013, Paris par Actency
Vis ma vie de chef de projet Drupal | Drupagora 2013, ParisVis ma vie de chef de projet Drupal | Drupagora 2013, Paris
Vis ma vie de chef de projet Drupal | Drupagora 2013, Paris
Actency4.5K vues
Appréhender et s'adapter aux mutations de l'économie numérique. par Thibaut Brousse
Appréhender et s'adapter aux mutations de l'économie numérique. Appréhender et s'adapter aux mutations de l'économie numérique.
Appréhender et s'adapter aux mutations de l'économie numérique.
Thibaut Brousse1.2K vues
Bonnes pratiques pour développer son appli mobile par polenumerique33
Bonnes pratiques pour développer son appli mobileBonnes pratiques pour développer son appli mobile
Bonnes pratiques pour développer son appli mobile
polenumerique33779 vues
Impression 3D : Repenser les business models et la capture de valeur [Marcus ... par Thierry Rayna
Impression 3D : Repenser les business models et la capture de valeur [Marcus ...Impression 3D : Repenser les business models et la capture de valeur [Marcus ...
Impression 3D : Repenser les business models et la capture de valeur [Marcus ...
Thierry Rayna2.7K vues
Elasticsearch - Montpellier JUG par David Pilato
Elasticsearch - Montpellier JUGElasticsearch - Montpellier JUG
Elasticsearch - Montpellier JUG
David Pilato3.2K vues
Prenez le contrôle de votre Stratégie Digitale Multicanal par Cyril Reinhard
Prenez le contrôle de votre Stratégie Digitale MulticanalPrenez le contrôle de votre Stratégie Digitale Multicanal
Prenez le contrôle de votre Stratégie Digitale Multicanal
Cyril Reinhard1.3K vues
meetup - Workflow complet de CI/CD pour les geeks avec gitlab et kubernetes par Frederic Leger
meetup - Workflow complet de CI/CD pour les geeks avec gitlab et kubernetesmeetup - Workflow complet de CI/CD pour les geeks avec gitlab et kubernetes
meetup - Workflow complet de CI/CD pour les geeks avec gitlab et kubernetes
Frederic Leger659 vues
20221027 - Agile Tour Bordeaux - L'odyssée vers le CI/CD: est-il possible de... par Jérôme Froville
20221027 - Agile Tour Bordeaux - L'odyssée vers le CI/CD: est-il possible  de...20221027 - Agile Tour Bordeaux - L'odyssée vers le CI/CD: est-il possible  de...
20221027 - Agile Tour Bordeaux - L'odyssée vers le CI/CD: est-il possible de...
QR codes et codes à barres sous Delphi par pprem
QR codes et codes à barres sous DelphiQR codes et codes à barres sous Delphi
QR codes et codes à barres sous Delphi
pprem80 vues
Webinar Nuxeo/Amexio : Comment bien choisir sa plateforme de gestion de contenu par Nuxeo
Webinar Nuxeo/Amexio : Comment bien choisir sa plateforme de gestion de contenuWebinar Nuxeo/Amexio : Comment bien choisir sa plateforme de gestion de contenu
Webinar Nuxeo/Amexio : Comment bien choisir sa plateforme de gestion de contenu
Nuxeo704 vues
meetup devops aix marseille du 16/05/23 par Frederic Leger
meetup devops aix marseille du 16/05/23meetup devops aix marseille du 16/05/23
meetup devops aix marseille du 16/05/23
Frederic Leger88 vues
Elasticsearch - OSDC France 2012 par David Pilato
Elasticsearch - OSDC France 2012Elasticsearch - OSDC France 2012
Elasticsearch - OSDC France 2012
David Pilato3.5K vues
Développement distribué agile par Xavier Warzee
Développement distribué agileDéveloppement distribué agile
Développement distribué agile
Xavier Warzee1.8K vues

Plus de Dorra BARTAGUIZ

Sortons de la pyramide pour construire une stratégie de test par
Sortons de la pyramide pour construire une stratégie de testSortons de la pyramide pour construire une stratégie de test
Sortons de la pyramide pour construire une stratégie de testDorra BARTAGUIZ
79 vues62 diapositives
Devs, let's reclaim DDD! par
Devs, let's reclaim DDD!Devs, let's reclaim DDD!
Devs, let's reclaim DDD!Dorra BARTAGUIZ
50 vues50 diapositives
S'améliorer sans s'épuiser par
S'améliorer sans s'épuiserS'améliorer sans s'épuiser
S'améliorer sans s'épuiserDorra BARTAGUIZ
43 vues44 diapositives
Les classes abstraites c’est fini (et c’est la faute à TDD) par
Les classes abstraites c’est fini (et c’est la faute à TDD)Les classes abstraites c’est fini (et c’est la faute à TDD)
Les classes abstraites c’est fini (et c’est la faute à TDD)Dorra BARTAGUIZ
560 vues85 diapositives
Design patterns par
Design patternsDesign patterns
Design patternsDorra BARTAGUIZ
937 vues147 diapositives
Slim down diet and tdd par
Slim down diet and tddSlim down diet and tdd
Slim down diet and tddDorra BARTAGUIZ
127 vues55 diapositives

Plus de Dorra BARTAGUIZ(7)

Dernier

Caprinov2023 Distribution quotidienne des fourrages quelles stratégies pour ... par
Caprinov2023 Distribution quotidienne des fourrages  quelles stratégies pour ...Caprinov2023 Distribution quotidienne des fourrages  quelles stratégies pour ...
Caprinov2023 Distribution quotidienne des fourrages quelles stratégies pour ...Institut de l'Elevage - Idele
16 vues25 diapositives
GAV2023 - Les systèmes bovins viande à l'épreuve des défis : les dynamiques d... par
GAV2023 - Les systèmes bovins viande à l'épreuve des défis : les dynamiques d...GAV2023 - Les systèmes bovins viande à l'épreuve des défis : les dynamiques d...
GAV2023 - Les systèmes bovins viande à l'épreuve des défis : les dynamiques d...Institut de l'Elevage - Idele
120 vues23 diapositives
GAV2023 - Méthane 2030 - Une démarche collective française à destination de t... par
GAV2023 - Méthane 2030 - Une démarche collective française à destination de t...GAV2023 - Méthane 2030 - Une démarche collective française à destination de t...
GAV2023 - Méthane 2030 - Une démarche collective française à destination de t...Institut de l'Elevage - Idele
115 vues14 diapositives
Caprinov2023 Réussite à l’IA des chèvres : effet de la diversité des trajecto... par
Caprinov2023 Réussite à l’IA des chèvres : effet de la diversité des trajecto...Caprinov2023 Réussite à l’IA des chèvres : effet de la diversité des trajecto...
Caprinov2023 Réussite à l’IA des chèvres : effet de la diversité des trajecto...Institut de l'Elevage - Idele
38 vues20 diapositives
GAV2023 - L’albédo (α) des prairies : un levier d'atténuation du changement c... par
GAV2023 - L’albédo (α) des prairies : un levier d'atténuation du changement c...GAV2023 - L’albédo (α) des prairies : un levier d'atténuation du changement c...
GAV2023 - L’albédo (α) des prairies : un levier d'atténuation du changement c...Institut de l'Elevage - Idele
106 vues18 diapositives
Caprinov2023 Ruminal par
Caprinov2023 RuminalCaprinov2023 Ruminal
Caprinov2023 RuminalInstitut de l'Elevage - Idele
20 vues22 diapositives

Dernier(20)

Living documentation au service de l'agilité