Abordagens

Aprende a escrever abordagens para exercícios

Cada exercício pode ter abordagens associadas, que descrevem as diferentes formas de resolver um exercício.

Abordagem

Uma abordagem deve explorar a forma como um exercício pode ser resolvido de determinada maneira.

  • O seu conteúdo deve:
    • Explorar uma abordagem idiomática
    • Explorar uma abordagem não idiomática, mas interessante
  • Começar com um exemplo de código (completo)
    • Usar exemplos de código à vontade no resto do documento
  • Sente-te à vontade para aprofundar o tema
  • Ligar a recursos úteis (por exemplo, documentação)
  • O excerto deve mostrar o essencial da abordagem
    • Podes usar no máximo 8 linhas

Se quiseres comparar abordagens diferentes, escreve um artigo.

Visão geral das abordagens

  • Dá contexto ao problema
    • Descreve pontos importantes (por exemplo, armadilhas) que se aplicam a todas as abordagens
  • Discute as abordagens mais idiomáticas
  • Cada abordagem deve começar com um excerto que a ilustre
  • Mantém o conteúdo num nível bastante geral
    • A informação detalhada deve ir para uma página de abordagem autónoma
    • Liga à página autónoma da abordagem para obteres mais informação
  • Discute como escolher entre as abordagens
    • Quais são as vantagens e desvantagens?
    • Há abordagens mais adequadas a casos de uso específicos?

Considerações gerais

  • Algumas linguagens têm formas diferentes de escrever a mesma coisa. Se parte dessa sintaxe só ficou disponível em versões mais recentes da linguagem, considera usar a sintaxe "antiga". Assim, é mais provável que os estudantes compreendam o código.
    • A sintaxe alternativa pode ser mostrada no documento da abordagem
  • Se a tua linguagem tiver um guia de estilo recomendado, segue essas orientações (sempre que possível)

Para que exercícios escrever abordagens?

Em geral, os Exercícios de Prática são mais adequados para escrever abordagens, pois normalmente podem ser resolvidos de várias formas.

Nos Exercícios de Conceito, pode ser interessante discutir a abordagem do exemplar. Por exemplo, podes mostrar como o conceito ensinado torna certo código mais fácil de escrever.

Ficheiros

Cada abordagem tem de adicionar os dois ficheiros seguintes:

  • .approaches/<approach-slug>/content.md: descrição da abordagem (ver a documentação)
  • .approaches/<approach-slug>/snippet.txt: excerto que mostra a abordagem (ver a documentação)

Depois, tens de adicionar ou atualizar:

Configurar a extensão do excerto

Também podes usar uma extensão personalizada em vez da extensão predefinida .txt, definindo o campo approaches.snippet_extension no ficheiro config.json do teu percurso. Se o definires, o ficheiro de excerto que tens de adicionar tem de se chamar .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.