Cada ejercicio puede tener enfoques asociados, que describen las diferentes formas en que se puede resolver un ejercicio.
Enfoque
Un enfoque debe explorar cómo se puede resolver un ejercicio de una manera determinada.
- Su contenido debe hacer una de dos cosas:
- Explorar un enfoque idiomático
- Explorar un enfoque no idiomático, pero interesante
- Empezar con un ejemplo de código (completo)
- Usar ejemplos de código con generosidad en el resto del documento
- No dudes en profundizar en el tema
- Enlazar 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 diferentes enfoques, escribe un artículo.
Panorama general de los enfoques
- Dar contexto al problema
- Describir puntos importantes (por ejemplo, trampas) que aplican a todos los enfoques
- Analizar los enfoques más idiomáticos
- Cada enfoque debe empezar con un fragmento de código que lo ilustre
- Mantener el contenido a un nivel bastante alto
- La información detallada debe ir en una página de enfoque independiente
- Enlazar a la página de enfoque independiente para obtener más información
- Analizar cómo elegir entre los enfoques
- ¿Cuáles son las compensaciones?
- ¿Hay enfoques que se adapten mejor a casos de uso específicos?
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, considera usar la sintaxis «antigua». Así es más probable que los estudiantes entiendan el código.
- La sintaxis alternativa se puede mostrar en el documento del enfoque
- Si tu lenguaje tiene una guía de estilo recomendada, sigue esas pautas (cuando sea posible)
¿Para qué ejercicios escribir enfoques?
En general, los Ejercicios de práctica son más adecuados para escribir enfoques, ya que por lo general se pueden resolver de varias maneras.
Para los Ejercicios de concepto, puede ser interesante analizar 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.
Archivos
Cada enfoque debe agregar los siguientes dos archivos:
-
.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 agregar 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 archivo config.json de tu track.
Si lo defines, el archivo de fragmento que debes agregar debe llamarse .approaches/<approach-slug>/snippet.<approaches.snippet_extension>.
