Identifier les différents types de documentation et d'artéfacts documentaires

Produire une documentation vivante

Produire une documentation suffisante (juste assez) et juste à temps

Produire une documentation au bon endroit et facile à trouver

Décrire des modèles par des diagrammes descriptifs, dans un langage ubiquitaire (Ubiquitous Language)

Rédiger des fiches de décisions d'architecture (Architectural Decision Record - ADR)

Critiquer et valider la pertinence et la qualité de leur documentation en fonction du message, du public cible et des exigences normatives et réglementaires (conformité)

Architectes et concepteurs.trices (fonctionnels ou logiciel), analystes, développeurs.euses, pilotes, toute autre personne qui a à rédiger de la documentation en lien avec le développement logiciel et ScrumMaster / chargé.e de projet qui veut encadrer son équipe par rapport à la documentation

CONCEPTS CLÉS

Introduction : Le problème avec la documentation traditionnelle
Types de documentation
Utilité de la documentation, objectifs et documentation responsable
Introduction à la théorie de la communication et survol de la théorie concernant la création et la gestion de la connaissance
Principes liés à la documentation vivante : Intention, KISS, DRY, #NoDocumentation * Documentation fiable, à effort minimal, collaborative et instructive * Langage ubiquitaire standardisé
Séparation de la documentation entre les espaces « Problème », « Solution » et « Livraison » : Artéfacts documentaires types d'un système * Responsabilités des membres de l'équipe face à la documentation
Anti-patrons de documentation vivante

OUTILS ET FORMATS

Format et support de la documentation : Documentation in situ : carnets de produit, dépôt de code source, espaces de collaboration, etc. * Concepts et exemples de Documentation as Code * Introduction à Markdown * Outils de création de diagrammes (Diagrams as Code)
Fiches de décisions d'architecture (Architectural Decision Record) et son journal
Introduction au modèle C4

MISES EN SITUATION

Exemples de domaines de documentation et visualisations
Fonctionnalités, éléments du carnet de produit comme les épopées, les récits, et les anomalies (Product - Backlog Item (epics, stories, bugs)),
Exigences techniques ou non fonctionnelles (Non-Functional Requirements) et éléments de sécurité
Parcours utilisateurs (journey) vs Story Mapping
Architecture émergente, solution changeante au gré des récits utilisateur, confirmation du besoin par des représentations à basse fidélité (wireframe)
Modèles pertinents
Éléments de documentation conforme

CONCLUSION

Documentation vivante et pragmatique : une documentation utile, de qualité, pertinente, à jour, facile et rapide à écrire, facile à trouver
Adoption, adhésion et premiers pas
Transition de la documentation traditionnelle à la documentation vivante
Mise en place graduelle d'un modèle de documentation, étape par étape

Attestation de participation

3,5h par jour