Tecnología · 3o de Secundaria

Ideas de aprendizaje activo

Documentación y Buenas Prácticas de Código

La documentación y las buenas prácticas de código requieren aplicación inmediata para ser significativas. Los estudiantes aprenden mejor cuando practican en situaciones reales y reciben retroalimentación concreta, no solo teoría. Estas habilidades se consolidan mediante actividades colaborativas donde el código cobra sentido al ser revisado, discutido y refactorizado entre pares.

• Aprendizajes Esperados SEP
• SEP NEM Fase 6: Saberes y Pensamiento Científico, Contenido: Comunicación y representación técnica
• SEP NEM Fase 6: Saberes y Pensamiento Científico, Contenido: Procesos técnicos

• 25–45 min
• Parejas → Toda la clase
• 4 actividades

Actividad 01

• Enseñanza entre Pares
• 30 min · Parejas

Parejas: Revisión Mutua de Código

Cada par intercambia un programa corto sin documentación. Identifican partes confusas, agregan comentarios y convenciones de estilo, luego discuten mejoras. Finalmente, prueban el código refactorizado para verificar funcionalidad.

¿Por qué es crucial documentar el código, incluso para proyectos pequeños?

Consejo de Facilitación

Durante la Revisión Mutua de Código, pida a las parejas que intercambien sus anotaciones antes de corregir, para que comparen perspectivas y discutan diferencias entre sus observaciones.

Qué observar

Entregue a cada pareja de estudiantes un fragmento de código sin documentar o con estilo inconsistente. Pida a cada estudiante que revise el código de su compañero, identificando al menos dos puntos de mejora en cuanto a comentarios y formato, y que escriba una sugerencia concreta para cada uno.

• Comprender
• Aplicar
• Analizar
• Crear
• Autogestión
• Habilidades de Relación

Actividad 02

• Enseñanza entre Pares
• 45 min · Grupos pequeños

Grupos Pequeños: Desafío de Convenciones

Proporciona código desordenado con errores de estilo. Los grupos lo corrigen aplicando reglas de indentación, nombres claros y comentarios. Comparten versiones finales y votan la más legible.

¿Cómo influye un código bien estructurado y comentado en el trabajo colaborativo?

Consejo de Facilitación

En el Desafío de Convenciones, asigne roles específicos a cada integrante del grupo para que uno documente mientras otro refactoriza, fomentando la participación activa de todos.

Qué observar

Presente en pantalla dos versiones de un mismo algoritmo simple: una bien comentada y con formato claro, y otra sin comentarios y mal indentada. Pregunte a los estudiantes: ¿Cuál código es más fácil de entender? ¿Por qué? Anote las respuestas clave en el pizarrón.

• Comprender
• Aplicar
• Analizar
• Crear
• Autogestión
• Habilidades de Relación

Actividad 03

• Enseñanza entre Pares
• 35 min · Toda la clase

Clase Completa: Evaluación Colectiva

Proyecta fragmentos de código variados. La clase discute en voz alta su calidad de documentación usando una rúbrica simple. Votan y justifican calificaciones para llegar a consenso.

¿Cómo evaluar la calidad de la documentación de un fragmento de código existente?

Consejo de Facilitación

En la Evaluación Colectiva, seleccione fragmentos de código con errores comunes pero no obvios, para que la clase identifique soluciones sin pistas demasiado evidentes.

Qué observar

Pida a los estudiantes que escriban en un papel una breve explicación (2-3 frases) sobre por qué es importante añadir comentarios al código, incluso si el programa es corto. Solicite también que nombren una convención de estilo que hayan aprendido y por qué es útil.

• Comprender
• Aplicar
• Analizar
• Crear
• Autogestión
• Habilidades de Relación

Actividad 04

• Enseñanza entre Pares
• 25 min · Individual

Individual: Documentación Personal

Cada estudiante documenta un algoritmo previo suyo. Incluyen comentarios explicativos y aplican convenciones. Luego, lo suben a una carpeta compartida para retroalimentación opcional.

¿Por qué es crucial documentar el código, incluso para proyectos pequeños?

Qué observar

Entregue a cada pareja de estudiantes un fragmento de código sin documentar o con estilo inconsistente. Pida a cada estudiante que revise el código de su compañero, identificando al menos dos puntos de mejora en cuanto a comentarios y formato, y que escriba una sugerencia concreta para cada uno.

• Comprender
• Aplicar
• Analizar
• Crear
• Autogestión
• Habilidades de Relación

Algunas notas para enseñar esta unidad

Enseñar documentación y estilo no se trata de memorizar reglas, sino de desarrollar un ojo crítico. Los docentes deben modelar el proceso: mostrar código propio mal documentado y refactorizarlo en tiempo real, explicando cada decisión. Evite corregir solo errores técnicos; destaque cómo la falta de claridad genera frustración en equipos reales. La investigación muestra que los estudiantes internalizan mejor las prácticas cuando ven su impacto inmediato en la colaboración.

Al finalizar las actividades, los estudiantes aplican convenciones de estilo de manera consistente, documentan código con claridad y reconocen errores comunes en la legibilidad. La evidencia de aprendizaje incluye fragmentos de código mejorados, comentarios precisos y justificaciones fundamentadas sobre las prácticas utilizadas.

---

Cuidado con estas ideas erróneas

• Durante la Revisión Mutua de Código, algunos estudiantes pueden pensar que la documentación solo es necesaria para códigos largos o complejos.

  En esta actividad, entregue a cada pareja un fragmento de código breve pero con decisiones lógicas poco claras (como usar 'contador' en lugar de 'intentosFallidos'). Pida que identifiquen en qué parte se confunden sin comentarios y propongan una solución concreta, demostrando que incluso proyectos pequeños requieren documentación para evitar malentendidos.

• Durante el Desafío de Convenciones, algunos estudiantes pueden creer que más comentarios largos siempre son mejores.

  En esta actividad, incluya un fragmento de código con comentarios excesivos que repiten lo que el código ya expresa (como 'suma = a + b // suma los valores de a y b'). Pida a los grupos que discutan en qué casos los comentarios son redundantes y cómo reescribirlos para que sean útiles, enfocándose en explicar el propósito, no el procedimiento.

• Durante la Evaluación Colectiva, algunos estudiantes pueden considerar que las convenciones de estilo son opcionales si el código funciona.

  En esta actividad, presente dos versiones del mismo algoritmo: una con indentación inconsistente y nombres de variables ambiguos, y otra con estilo uniforme. Pida a la clase que simule ser un equipo trabajando en el mismo proyecto y vote cuál versión aceptarían en un repositorio compartido, revelando que la legibilidad afecta directamente la colaboración.

---

Metodologías usadas en este resumen

• Enseñanza entre Pares