Compétence · Documentation · Documenter un service ou un projet
Faire vivre une documentation : propriétaire, revue, fraîcheur
Attribuer un propriétaire à chaque document, inscrire la documentation dans la définition de terminé, relire une page pour y repérer les défauts et planifier sa revue ou son archivage.
Commencer la leçon 1Le domaine Documentation
- 4 leçons
- ~1 h 45 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 · aucun prérequis
Une compétence de base : vous pouvez commencer tout de suite.
Conseillé avant · 2
Cette compétence, pour vous
Faire vivre une documentation : propriétaire, revue, fraîcheur
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 ~1 h 45, dans l'ordre du programme. Chaque leçon se termine par son quiz.
Le programme
4 leçons · ~1 h 45
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.
Pour aller plus loin
Des pages de référence : elles appuient la compétence sans l'enseigner, et ne comptent pas dans votre parcours.
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
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
- 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