Approches

Chaque exercice peut avoir des approches qui lui sont associées, lesquelles décrivent les différentes façons de résoudre un exercice.

Approche

Une approche doit explorer comment un exercice peut être résolu d'une certaine manière.

• Son contenu doit soit :
  • explorer une approche idiomatique
  • explorer une approche non idiomatique, mais intéressante
• Commencer par un exemple de code (complet)
  • Utiliser des exemples de code sans compter dans le reste du document
• N'hésite pas à approfondir le sujet
• Ajouter des liens vers des ressources utiles (par exemple de la documentation)
• L'extrait doit montrer le cœur de l'approche
  • Un maximum de 8 lignes peut être utilisé

Si tu veux comparer différentes approches, écris un article.

Vue d'ensemble des approches

• Donne du contexte au problème
  • Décris les points importants (par exemple les pièges) qui s'appliquent à toutes les approches
• Aborde les approches les plus idiomatiques
• Chaque approche doit commencer par un extrait qui l'illustre
• Garde le contenu assez général
  • Les informations détaillées doivent aller dans une page d'approche autonome
  • Renvoie vers la page d'approche autonome pour plus d'informations
• Explique comment choisir entre les approches
  • Quels sont les compromis ?
  • Certaines approches sont-elles mieux adaptées à des cas d'usage particuliers ?

Considérations générales

• Certains langages ont différentes façons d'écrire la même chose. Si une partie de cette syntaxe n'est disponible que dans des versions plus récentes du langage, envisage d'utiliser l'« ancienne » syntaxe. Cela rend plus probable que les apprenants comprennent le code.
  • Une syntaxe alternative peut être montrée dans le document d'approche.
• Si ton langage a un guide de style recommandé, suis ces recommandations (dans la mesure du possible).

Pour quels exercices écrire des approches ?

En général, les exercices d'entraînement se prêtent mieux à l'écriture d'approches, car ils peuvent généralement être résolus de plusieurs manières.

Pour les exercices d'apprentissage, discuter de l'approche exemplaire peut être intéressant. Par exemple, tu peux montrer comment le concept enseigné rend certain code plus facile à écrire.

Fichiers

Chaque approche doit ajouter les deux fichiers suivants :

• .approaches/<approach-slug>/content.md : description de l'approche (voir la documentation)
• .approaches/<approach-slug>/snippet.txt : extrait qui illustre l'approche (voir la documentation)

Il te faudra ensuite ajouter ou mettre à jour :

• .approaches/config.json : métadonnées des approches (voir la documentation)

Configurer l'extension des extraits

Tu peux aussi utiliser une extension personnalisée au lieu de l'extension .txt par défaut en définissant le champ approaches.snippet_extension dans le fichier config.json de ton parcours. Si ce champ est défini, le fichier d'extrait que tu dois ajouter doit s'appeler .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.