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

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

Construire et publier une documentation contrôlée en CI

Faire vérifier une documentation par un pipeline (markdownlint, Vale, liens, build strict) et la publier en site statique, puis réparer ce que le pipeline signale.

Commencer la leçon 1Le domaine Documentation

• 3 leçons
• ~1 h 25 de lecture
• 7 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

• Rédiger une page technique claire, accessible et vérifiable

Selon l'outil choisi, il faut en plus :

• Astro Starlight (par défaut)

  rien de plus

• MkDocs

  rien de plus

• Docusaurus

  rien de plus

• Hugo

  rien de plus

• Antora

  • Rédiger un document technique en AsciiDoc : structure, attributs, blocs et conversion

Conseillé avant · 4

• Faire vivre une documentation : propriétaire, revue, fraîcheur
• Collaborer sur un dépôt distant et débloquer un conflit
• Écrire un premier pipeline et lire ses échecs
• Écrire et relire un document YAML correct et sans ambiguïté

Cette compétence, pour vous

Construire et publier une documentation contrôlée en CI

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çons

Comment l'apprendre

Cette compétence s'apprend avec l'outil de votre choix ; vos préférences décident de la voie suivie dans votre parcours. Chaque voie liste ses leçons dans l'ordre du programme.

Avec Astro Starlight

3 leçons · ~1 h 25 par défaut

1. 1Choisir ses outils de documentation· 25 min
2. 2Créer un site de documentation avec Astro Starlight· 35 min
3. 3Créer une collection de postmortems SRE avec Astro Starlight· 25 min

Avec MkDocs

2 leçons · ~1 h 00

1. 1Choisir ses outils de documentation· 25 min
2. 2MkDocs : créer un site de documentation DevOps· 35 min

Avec Docusaurus

2 leçons · ~45 min

1. 1Choisir ses outils de documentation· 25 min
2. 2Docusaurus : créer un site de documentation moderne· 20 min

Avec Hugo

2 leçons · ~55 min

1. 1Choisir ses outils de documentation· 25 min
2. 2Hugo : créer un site de documentation DevOps· 30 min

Avec Antora

2 leçons · ~1 h 00

1. 1Choisir ses outils de documentation· 25 min
2. 2Antora : créez vos sites docs statiques· 35 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

7 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

• Ingénieur CI/CD
• Ingénieur plateforme

Enseignée par

• Documenter

Outil au choix : Astro Starlight ou MkDocs ou Docusaurus ou Hugo ou Antora.

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
• 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 →