Skip to Content
MoodleConventions de rédaction

Conventions de rédaction de cette documentation

Chaque chapitre (NN-slug.md) suit ce template :

  1. Titre H1, puis encadré résumé :

    ⏱️ TL;DR — 5 à 10 puces qui résument tout le chapitre.

  2. ## 🎯 Objectifs — « à la fin de ce chapitre, vous saurez… » (3 à 6 puces).
  3. Corps détaillé — prose pédagogique en français, nombreux exemples concrets (code complet copiable, chemins de fichiers en en-tête des blocs, scénarios réalistes).
  4. Diagrammes — blocs ```mermaid (flowchart, sequenceDiagram, erDiagram, stateDiagram) pour les architectures/flux/relations, ASCII pour les arborescences de fichiers. Pas d’images binaires : Mermaid est rendu nativement par GitHub et VS Code.
  5. Encadrés récurrents :
    • > ⚠️ **Piège** : — erreur classique et comment l’éviter.
    • > 💡 **Pour un dev React** : — analogie avec l’écosystème Next.js/React.
    • > 📚 **Aller plus loin** : — liens vers la doc officielle.
  6. ## ✏️ Exercices — 3 à 6 exercices progressifs et concrets, chacun avec sa solution repliée dans <details> <summary>✅ Solution</summary>…</details>.
  7. ## 🧠 Quiz de révision — 5 questions, réponses repliées dans <details>.
  8. Lien vers le chapitre suivant en dernière ligne.

Les fichiers 00-index.md font exception : sommaire de la partie, résumé d’une phrase par chapitre, et « ce que vous saurez faire à la fin de cette partie ».

Référence technique : Moodle 5.2 (avril 2026, PHP 8.3+, Bootstrap 5, racine web public/ depuis 5.1). Tout écart de version est signalé dans le texte.