0 Prérequis Cette compétence 1 Débloquées

Compétence · Documentation · Documenter un service ou un projet

Représenter un système en diagrammes as code lisibles sans l'image

Dessiner en Mermaid ou D2 les vues contexte et conteneurs C4 d'un système, versionnées avec le code et doublées d'un texte qui les rend compréhensibles sans l'image.

Commencer la leçon 1Le domaine Documentation

• 6 leçons
• ~2 h 40 de lecture
• 6 quiz
• 0 lab de preuve

Le chemin

D'où elle vient, où elle mène

Ce qu'il faut savoir avant, où vous en êtes sur cette compétence, et ce qu'elle ouvre ensuite. Votre état se calcule dans votre navigateur, à partir de ce que vous avez lu et réussi.

Avant · aucun prérequis

Une compétence de base : vous pouvez commencer tout de suite.

Conseillé avant · 2

• Rédiger une page technique claire, accessible et vérifiable
• Lire un schéma d'architecture : rôle, flux, état et dépendances de chaque brique

Cette compétence, pour vous

Représenter un système en diagrammes as code lisibles sans l'image

Calcul en cours

Elle débloque · 1 compétence

• Modéliser une architecture au-delà du contexte : composants, vues dynamiques et de déploiement, modèle unique en code

Leçons

Comment l'apprendre

6 leçons, soit ~2 h 40, dans l'ordre du programme. Chaque leçon se termine par son quiz.

Le programme

6 leçons · ~2 h 40

Partie 1 · Modéliser une architecture 3 leçons · ~1 h 15

1. 1Modèle C4 : clarifiez vos architectures· 25 min
2. 2Diagramme de contexte C4 : votre système et son environnement· 25 min
3. 3Diagramme de conteneurs C4 : ce qui s'exécute et se déploie· 25 min

Partie 2 · Représenter en code 3 leçons · ~1 h 25

1. 4Diagrammes as code : pourquoi et quel outil· 25 min
2. 5Mermaid : flux, séquences et états rendus par la forge· 30 min
3. 6D2 : conteneurs imbriqués et moteurs de mise en page· 30 min

Au-delà des leçons

S'évaluer, pratiquer, passer l'épreuve

Lire une leçon ne confirme rien. Une compétence se confirme par un quiz réussi, se travaille en lab guidé, et se met à l’épreuve par un challenge ou une mission ; un résultat de lab importé n’est pas vérifié par le site.

S'évaluer

6 quiz

En fin de leçon : réussis à 70 %, ils confirment la compétence.

Pratiquer

Aucun lab guidé

Aucun lab guidé ne la fait encore pratiquer.

Épreuve

Aucune épreuve

Ni challenge, ni mission avec une preuve pour l'instant.

Autour

Qui la demande, qui l'enseigne

Demandée par

Aucun métier publié ne la demande encore.

Enseignée par

• Documenter

Même bloc · Documenter un service ou un projet

• Choisir le type de document et son lecteur avant d'écrire
• Rédiger une page technique claire, accessible et vérifiable
• Doter un dépôt de son README, de son CHANGELOG et de ses ADR
• Faire vivre une documentation : propriétaire, revue, fraîcheur
• Construire et publier une documentation contrôlée en CI
• Documenter du code : commentaires qui disent pourquoi, docstrings, référence générée
• Modéliser une architecture au-delà du contexte : composants, vues dynamiques et de déploiement, modèle unique en code
• Rédiger un document technique en AsciiDoc : structure, attributs, blocs et conversion
• Construire une présentation technique en Markdown ou en HTML, versionnée et exportée

×

📖 Voir la documentation →