Parcours · Débutant à intermédiaire

Documenter

Choisir le bon document, l'écrire clair, le schématiser en code et le faire vivre jusqu'au site publié

2 niveaux
9 modules
40 leçons
38 quiz
18h

Commencer Leçon : Documenter : créer une documentation qui survit

Recommandé avant de commencer : Git

À propos de ce parcours · premier niveau : 25 leçons, 5 semaines environ

Bienvenue sur votre parcours Documenter. Cette page liste l'intégralité de la formation : un premier niveau pour écrire une documentation utile (Markdown, ADR, schémas C4, revue et fraîcheur), un second pour la publier en site statique, puis des modules facultatifs sur les documents d'exploitation et les présentations en Markdown.

Oui, le parcours est long. Personne ne le suit d'une traite : il se découpe en niveaux. Le premier, « Écrire une documentation utile », compte 25 leçons d'environ 25 minutes : à une par jour ouvré, 5 semaines environ, et il a son propre résultat. Chaque module apporte une compétence utilisable dès le lendemain, et votre progression vous attend dans ce navigateur et sur les appareils reliés à votre compte facultatif.

Atteindre un objectif

Ce parcours rassemble l’ensemble de nos contenus sur ce domaine. Votre parcours personnalisé peut n’en utiliser qu’une partie.

Compétences 11 (+1 en partie) 11 par quiz · 0 en lab · 0 avec preuve
Métiers Administrateur Linux Ingénieur DevSecOps Ingénieur CI/CD Ingénieur plateforme Ingénieur fiabilité (SRE)

Progression 0 / 40 (0%)

Connaissance Non mesurée Votre premier quiz apparaîtra à la fin d’une leçon.
Pratique Non mesurée Les labs mesurent votre capacité à faire. Vous n’avez pas besoin de DSOXLab pour commencer une formation.
Preuve Non mesurée Les challenges et examens pratiques vérifient que vous savez agir sans procédure détaillée.

Cochez les leçons ici, ou avec « Marquer comme lu » en fin de leçon. La progression reste dans ce navigateur ; rien n’est envoyé au serveur, sauf si vous reliez ce navigateur à un compte facultatif.

01 Présentation 0 / 1
- cours Documenter : créer une documentation qui survit 10 min

Écrire une documentation utile

0 / 25 leçons 0 / 5 modules

Vous livrez, pour un service inconnu, un README, un ADR, un diagramme C4 en code et une page pratique que quelqu'un d'autre peut suivre, et vous savez relire une page pour en lister les défauts.

Validation du niveau : aucune épreuve de validation définie pour ce niveau.

Outiller et publier

0 / 7 leçons 0 / 1 modules

Votre documentation passe un pipeline de contrôle (syntaxe, style, liens, build strict), se publie en site statique et décrit son API en OpenAPI valide.

07 Publier un site de documentation 0 / 7

Validation du niveau : aucune épreuve de validation définie pour ce niveau.

Hors niveaux · Approfondissements

08 Documents d'exploitation 0 / 5

Hors niveaux · Approfondissements

09 Présenter 0 / 2
- cours quiz optionnel Slidev : créer des présentations techniques en Markdown 35 min
- cours quiz optionnel Créer des présentations interactives avec Reveal.js 25 min