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 von 79

Recomendados

De la multiplicité des sources d’informations à la consolidation : avantages ... von
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 views25 Folien
DevOps et ALM : Application Lifecycle Management: Continuous Delivery avec Vi... von
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 views27 Folien
Devops, un tour d'horizon - Eutelsat 2018 von
Devops, un tour d'horizon -  Eutelsat 2018Devops, un tour d'horizon -  Eutelsat 2018
Devops, un tour d'horizon - Eutelsat 2018Ludovic Piot
337 views38 Folien
TalkRendonsDDDauxDevs_AlpesCraft.pdf von
TalkRendonsDDDauxDevs_AlpesCraft.pdfTalkRendonsDDDauxDevs_AlpesCraft.pdf
TalkRendonsDDDauxDevs_AlpesCraft.pdfArnaud Thiéfaine
34 views60 Folien
Présentation 1er Comite de repérage régional von
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 views57 Folien
Presentation lab de promotech offre de coworking - 15 fev 2012 von
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 views35 Folien

Más contenido relacionado

Similar a Living documentation au service de l'agilité

Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric... von
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 views15 Folien
Definition of Done - Agile Pays Basque - 23/09/2016 von
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
807 views49 Folien
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti... von
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 views18 Folien
Vis ma vie de chef de projet Drupal | Drupagora 2013, Paris von
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 views42 Folien
Appréhender et s'adapter aux mutations de l'économie numérique. von
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 views91 Folien
Bonnes pratiques pour développer son appli mobile von
Bonnes pratiques pour développer son appli mobileBonnes pratiques pour développer son appli mobile
Bonnes pratiques pour développer son appli mobilepolenumerique33
779 views68 Folien

Similar a Living documentation au service de l'agilité(20)

Agile Tour Paris 2014 : Ma stack d'outils Agiles, tout un programme !, Cedric... von 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 views
Definition of Done - Agile Pays Basque - 23/09/2016 von 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
ffaure32807 views
Jeunesse, pratiques et territoire : réflexions à partir des cahiers de l'acti... von 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 views
Vis ma vie de chef de projet Drupal | Drupagora 2013, Paris von 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 views
Appréhender et s'adapter aux mutations de l'économie numérique. von 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 views
Bonnes pratiques pour développer son appli mobile von 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 views
Impression 3D : Repenser les business models et la capture de valeur [Marcus ... von 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 views
Elasticsearch - Montpellier JUG von David Pilato
Elasticsearch - Montpellier JUGElasticsearch - Montpellier JUG
Elasticsearch - Montpellier JUG
David Pilato3.2K views
Prenez le contrôle de votre Stratégie Digitale Multicanal von 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 views
meetup - Workflow complet de CI/CD pour les geeks avec gitlab et kubernetes von 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 Leger663 views
20221027 - Agile Tour Bordeaux - L'odyssée vers le CI/CD: est-il possible de... von 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...
Jérôme Froville208 views
QR codes et codes à barres sous Delphi von pprem
QR codes et codes à barres sous DelphiQR codes et codes à barres sous Delphi
QR codes et codes à barres sous Delphi
pprem82 views
Webinar Nuxeo/Amexio : Comment bien choisir sa plateforme de gestion de contenu von 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 views
meetup devops aix marseille du 16/05/23 von 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 Leger89 views
Elasticsearch - OSDC France 2012 von David Pilato
Elasticsearch - OSDC France 2012Elasticsearch - OSDC France 2012
Elasticsearch - OSDC France 2012
David Pilato3.5K views
Développement distribué agile von Xavier Warzee
Développement distribué agileDéveloppement distribué agile
Développement distribué agile
Xavier Warzee1.8K views

Más de Dorra BARTAGUIZ

Sortons de la pyramide pour construire une stratégie de test von
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 views62 Folien
Devs, let's reclaim DDD! von
Devs, let's reclaim DDD!Devs, let's reclaim DDD!
Devs, let's reclaim DDD!Dorra BARTAGUIZ
50 views50 Folien
S'améliorer sans s'épuiser von
S'améliorer sans s'épuiserS'améliorer sans s'épuiser
S'améliorer sans s'épuiserDorra BARTAGUIZ
43 views44 Folien
Les classes abstraites c’est fini (et c’est la faute à TDD) von
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 views85 Folien
Design patterns von
Design patternsDesign patterns
Design patternsDorra BARTAGUIZ
937 views147 Folien
Slim down diet and tdd von
Slim down diet and tddSlim down diet and tdd
Slim down diet and tddDorra BARTAGUIZ
127 views55 Folien

Más de Dorra BARTAGUIZ(7)

Living documentation au service de l'agilité