Approcci

Ogni esercizio può avere degli approcci associati, che descrivono i diversi modi in cui un esercizio può essere risolto.

Approccio

Un approccio dovrebbe esplorare come un esercizio può essere risolto in un certo modo.

• I suoi contenuti dovrebbero:
  • Esplorare un approccio idiomatico
  • Esplorare un approccio non idiomatico, ma interessante
• Iniziare con un esempio di codice (completo)
  • Usare generosamente esempi di codice nel resto del documento
• Sentiti libero di approfondire l'argomento
• Collegare risorse utili (ad esempio la documentazione)
• Lo snippet dovrebbe mostrare il nucleo dell'approccio
  • Si possono usare al massimo 8 righe

Se vuoi confrontare approcci diversi, scrivi un articolo.

Panoramica degli approcci

• Dare contesto al problema
  • Descrivere i punti importanti (ad esempio le insidie) che valgono per tutti gli approcci
• Discutere gli approcci più idiomatici
• Ogni approccio dovrebbe iniziare con uno snippet che lo illustra
• Mantenere il contenuto a un livello piuttosto generale
  • Le informazioni dettagliate dovrebbero andare in una pagina dedicata all'approccio
  • Collegare la pagina dedicata all'approccio per maggiori informazioni
• Discutere come scegliere tra gli approcci
  • Quali sono i compromessi?
  • Ci sono approcci più adatti a casi d'uso specifici?

Considerazioni generali

• Alcuni linguaggi hanno modi diversi di scrivere la stessa cosa. Se parte di quella sintassi è disponibile solo nelle versioni più recenti del linguaggio, valuta di usare la sintassi «vecchia». Così è più probabile che gli studenti capiscano il codice.
  • La sintassi alternativa può essere mostrata nel documento dell'approccio
• Se il tuo linguaggio ha una guida di stile consigliata, segui quelle linee guida (dove possibile)

Per quali esercizi scrivere gli approcci?

In generale, gli esercizi pratici sono più adatti per scrivere gli approcci, perché di solito si possono risolvere in diversi modi.

Per gli esercizi di concetto, potrebbe essere interessante discutere l'approccio della soluzione esemplare. Ad esempio, potresti mostrare come il concetto insegnato rende più facile scrivere certo codice.

File

Ogni approccio deve aggiungere i due file seguenti:

• .approaches/<approach-slug>/content.md: descrizione dell'approccio (vedi la documentazione)
• .approaches/<approach-slug>/snippet.txt: snippet che mostra l'approccio (vedi la documentazione)

Poi dovrai aggiungere o aggiornare:

• .approaches/config.json: metadati per gli approcci (vedi la documentazione)

Configurare l'estensione dello snippet

Puoi anche usare un'estensione personalizzata invece dell'estensione predefinita .txt, impostando il campo approaches.snippet_extension nel file config.json del track. Se lo imposti, il file dello snippet che devi aggiungere deve chiamarsi .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.