Compétence · Documentation · Documenter un service ou un projet
Modéliser une architecture au-delà du contexte : composants, vues dynamiques et de déploiement, modèle unique en code
Découper un conteneur en composants et savoir quand s'arrêter, dessiner les vues complémentaires C4 (paysage, dynamique, déploiement), décrire un modèle unique en Structurizr DSL exporté vers Mermaid ou C4-PlantUML, et écrire séquences, composants et déploiement en PlantUML contrôlé en CI.
Commencer la leçon 1Le domaine Documentation
- 4 leçons
- ~2 h 00 de lecture
- 4 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 · 1 prérequis
Conseillé avant · 1
Cette compétence, pour vous
Modéliser une architecture au-delà du contexte : composants, vues dynamiques et de déploiement, modèle unique en code
Calcul en cours
Elle débloque · rien encore
Aucune autre compétence ne la demande : c'est une compétence de bout de chemin.
Le chemin des bases De la base la plus en amont jusqu'à cette compétence : ce qui est en place, ce qu'il reste à lire.
Leçons
Comment l'apprendre
4 leçons, soit ~2 h 00, dans l'ordre du programme. Chaque leçon se termine par son quiz.
Le programme
4 leçons · ~2 h 00
Partie 1 · Modéliser une architecture 3 leçons · ~1 h 30
Partie 2 · Représenter en code 1 leçon · ~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
4 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.
Test de positionnement
Préparation des questions…
Le détail de vos réponses
Pour chaque question posée : votre réponse, la bonne réponse, son explication et la page à relire.
Autour
Qui la demande, qui l'enseigne
Demandée par
Aucun métier publié ne la demande encore.
Enseignée par
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
- Représenter un système en diagrammes as code lisibles sans l'image
- 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
- 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