Règles de rédaction pour l'apprentissage du développement web

Public cible

Le public cible de la section MDN Apprendre le développement web (aussi appelé Apprendre) est constitué de personnes qui ne sont pas expertes en développement front-end : cela inclut les étudiant·e·s, les développeur·euse·s web débutant·e·s ou en formation, les amateur·ice·s et les enseignant·e·s cherchant des bonnes pratiques à transmettre à leurs élèves.

Couverture des sujets

Apprendre propose un parcours structuré avec des objectifs d'apprentissage, conçu pour enseigner les compétences et pratiques fondamentales qui permettront aux lecteur·ice·s de devenir des développeur·euse·s front-end accompli·e·s. Les apprenant·e·s peuvent s'y fier pour obtenir des informations fiables pour leurs études, et les enseignant·e·s peuvent s'y appuyer pour définir les résultats attendus de leurs cours et programmes.

En conséquence, nous visons à limiter strictement le périmètre de Apprendre à :

• La mise en place, les compétences transversales et les connaissances de base dans nos modules de démarrage.
• Les technologies fondamentales nécessaires au début du parcours d'un·e développeur·euse web dans nos modules de base.
• Les sujets de « seconde vague » qui représentent les prochaines étapes utiles pour les débutant·e·s ayant maîtrisé les modules de base, dans nos modules d'extension.

Apprendre n'est pas destiné à accueillir sur MDN du contenu introductif sur tous les sujets. Cela signifie que les sujets de niche comme MathML et les jeux web, ainsi que les sujets avancés ou spécialisés comme les expressions régulières, les tests de performance, WebRTC et WebGPU, n'ont pas leur place dans Apprendre.

Si vous ne voyez pas un sujet traité dans Apprendre et que vous pensez qu'il devrait l'être, ne l'ajoutez pas directement : discutez-en d'abord avec nous (voir Suggérer du contenu).

Approche

Pour créer et mettre à jour le contenu d'apprentissage du développement web sur MDN, vous devez suivre la même approche que pour le reste de MDN à bien des égards. Vous devez suivre le même guide de style rédactionnel, guide de style de code et techniques.

Il existe cependant quelques différences :

• Style tutoriel : La plupart du contenu MDN est un mélange de documentation de référence et de guides ; Apprendre, en revanche, vise à proposer des tutoriels pratiques. Il n'existe pas de modèle strict pour chaque page, mais elles doivent être rédigées de façon à guider le·la lecteur·ice pas à pas, à travers des sections progressives et des encadrés « À vous de jouer ». Ces encadrés invitent à expérimenter et à écrire du code. Voir par exemple la section « À vous de jouer » en bas de notre page sur le moteur de recherche. Ils sont créés avec le markdown suivant :

  md

  > [!CALLOUT]
  >
  > **À vous de jouer**
  >
  > Essayez ceci...
  

• Défis : Le contenu Apprendre inclut régulièrement des défis pour vérifier que le·la lecteur·ice a bien compris les sujets abordés avant de passer à l'article suivant. Ils sont actuellement rédigés selon plusieurs styles, voir par exemple Défi : Structurer une page de contenu et Testez vos compétences : images HTML, mais nous comptons améliorer la cohérence et l'expérience de ces défis à l'avenir.

• Densité et exhaustivité : Le contenu MDN est généralement reconnu pour son exhaustivité. Le contenu Apprendre n'est volontairement pas aussi complet que le reste de MDN. Il est moins dense et plus accessible, pour permettre aux apprenant·e·s d'acquérir des compétences utiles et de progresser régulièrement sans se sentir submergé·e·s. Ils pourront approfondir plus tard. Le contenu Apprendre peut omettre des détails pour offrir une expérience d'apprentissage plus confortable, à condition de ne rien enseigner de trompeur ou de mauvaise pratique.

• Objectifs d'apprentissage stables : Les objectifs d'apprentissage en haut de chaque tutoriel résument ce que chaque tutoriel enseigne, et ensemble, ils forment un programme structuré pour le développement front-end. Il est essentiel que les objectifs d'apprentissage et le contenu enseigné restent stables et synchronisés, sinon le contenu ne peut pas servir de base fiable à un apprentissage formel (cours, certifications, etc.). Les changements d'objectifs doivent donc être rares et motivés. Si vous essayez d'ajouter du contenu qui n'est pas couvert par les objectifs associés (ou inversement), votre pull request sera fermée. Faites une suggestion d'abord.

Liens partenaires et intégrations

Comme indiqué dans nos règles sur les liens externes, MDN n'autorise généralement pas les liens externes (ou intégrations) qui semblent promouvoir des produits commerciaux ou mènent à du contenu payant. Cela vise à éviter que le contenu MDN ne perde en crédibilité ou ne devienne moins utile à cause de liens publicitaires.

Le contenu Apprendre de MDN fait cependant quelques exceptions. Nous autorisons des liens vers du contenu externe (parfois payant) provenant de partenaires de confiance. Ce sont des sites avec lesquels MDN a établi une relation de confiance, en examinant leur qualité, leur éthique et leur engagement envers les standards et bonnes pratiques du web, et en les aidant à mettre à jour leur contenu si besoin. Nous leur faisons confiance pour ne pas modifier leurs liens sans préavis, et pour que leur contenu soit sûr.

Les objectifs de ces liens partenaires sont :

• Fournir un accès à du contenu complémentaire qui prolonge ce qui est enseigné sur nos pages.
• Offrir des expériences d'apprentissage multimédia (vidéos, diaporamas, contenus interactifs) que l'équipe MDN n'a pas les moyens de produire. MDN est centré sur le texte, mais les utilisateur·ice·s apprécient parfois d'autres approches.
• Générer des revenus via des liens affiliés vers du contenu payant, que nous pouvons réinvestir pour améliorer MDN.

Cependant, nous :

• N'ajouterons ces liens que s'ils sont réellement utiles et ne compromettent pas l'intégrité du contenu MDN.
• Veillerons toujours à proposer une option gratuite à côté de tout contenu payant. Dans de nombreux cas, nous avons convaincu nos partenaires de rendre gratuit du contenu auparavant payant.
• Marquerons clairement le contenu partenaire avec la mention « Partenaire d'apprentissage MDN », pour bien les distinguer des autres liens.

Ordre des liens « Voir aussi »

Sur les pages Apprendre, les liens « Voir aussi » en bas de page doivent apparaître dans l'ordre suivant :

1. Liens internes.
2. Liens vers du contenu gratuit.
3. Liens vers du contenu mixte gratuit/payant.

Partenaires pédagogiques actuels

• Scrimba ^(angl.)