Cada ejercicio puede tener enfoques asociados, que describen las distintas formas en que se puede resolver un ejercicio.
Enfoque
Un enfoque debería explorar cómo se puede resolver un ejercicio de una forma concreta.
- Su contenido debe hacer una de estas dos cosas:
- Explorar un enfoque idiomático
- Explorar un enfoque no idiomático, pero interesante
- Empezar con un ejemplo de código (completo)
- Usa ejemplos de código con generosidad en el resto del documento
- No dudes en profundizar en el tema
- Enlaza recursos útiles (por ejemplo, documentación)
- El fragmento de código debe mostrar el núcleo del enfoque
- Se pueden usar un máximo de 8 líneas
Si quieres comparar distintos enfoques, escribe un artículo.
Visión general de los enfoques
- Da contexto al problema
- Describe los puntos importantes (por ejemplo, las trampas) que se aplican a todos los enfoques
- Comenta los enfoques más idiomáticos
- Cada enfoque debe empezar con un fragmento de código que lo ilustre
- Mantén el contenido a un nivel bastante general
- La información detallada debe ir en una página de enfoque independiente
- Enlaza la página de enfoque independiente para obtener más información
- Comenta cómo elegir entre los enfoques
- ¿Cuáles son las ventajas y desventajas?
- ¿Hay enfoques más adecuados para casos de uso concretos?
Consideraciones generales
- Algunos lenguajes tienen distintas formas de escribir lo mismo. Si parte de esa sintaxis solo está disponible en versiones más recientes del lenguaje, plantéate usar la sintaxis «antigua». Así es más probable que los estudiantes entiendan el código.
- La sintaxis alternativa puede mostrarse en el documento del enfoque
- Si tu lenguaje tiene una guía de estilo recomendada, sigue sus pautas (siempre que sea posible)
¿Para qué ejercicios escribir enfoques?
En general, los ejercicios de práctica son más adecuados para escribir enfoques, ya que normalmente se pueden resolver de varias formas.
En los ejercicios de concepto, puede ser interesante comentar el enfoque del ejemplar. Por ejemplo, podrías mostrar cómo el concepto que se enseña hace que cierto código sea más fácil de escribir.
Ficheros
Cada enfoque debe añadir los dos ficheros siguientes:
-
.approaches/<approach-slug>/content.md: descripción del enfoque (consulta la documentación)
-
.approaches/<approach-slug>/snippet.txt: fragmento de código que muestra el enfoque (consulta la documentación)
Después tendrás que añadir o actualizar:
Configurar la extensión del fragmento
También puedes usar una extensión personalizada en lugar de la extensión .txt predeterminada si defines el campo approaches.snippet_extension en el fichero config.json de tu track.
Si lo defines, el fichero de fragmento que tienes que añadir debe llamarse .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.
