Documentar un proyecto de software suele quedarse en segundo plano, pero es una de las prácticas que más impacto tiene en la productividad de un equipo. Con GitHub Copilot Chat puedes generar documentación directamente desde tu editor de código, sin interrumpir tu flujo de trabajo y en cuestión de segundos.
¿Cómo explicar código que no conoces con GitHub Copilot?
Cuando llegas a un proyecto nuevo y nadie puede darte contexto sobre por qué se escribió cierta función, Copilot se convierte en tu mejor aliado. El proceso es muy sencillo:
- Selecciona el bloque de código que quieres entender.
- Abre GitHub Copilot Chat en tu editor.
- Usa la opción explicar (explain) [0:48].
- Opcionalmente, indica el idioma en que deseas la respuesta.
Copilot analiza la selección y devuelve una descripción detallada: el nombre de la función, sus características, qué recibe y qué retorna. En el ejemplo mostrado, se trata de una función que convierte un slug —como hello-world— en un título legible para un ser humano: "Hello World", sin guiones. Es la operación inversa de slugify, que transforma frases en cadenas aptas para URLs. Este patrón es muy común en sitios web con múltiples directorios y rutas dinámicas [1:18].
¿Cómo generar documentación automática desde tu editor?
Una vez que entiendes qué hace el código, el siguiente paso es dejar ese conocimiento registrado. Mantén seleccionado el fragmento y utiliza el comando generate docs en Copilot Chat [2:00].
- Copilot genera la documentación siguiendo un estándar reconocido.
- Incluye una descripción de la función, los parámetros que recibe (tipo y propósito) y el valor de retorno.
- Puedes insertar el resultado directamente en tu código con un clic.
Por ejemplo, la documentación generada indica que la función recibe un valor de tipo string —el slug— y retorna el texto legible correspondiente [2:38]. Si Copilot responde en español, puedes ajustar la conversación para que genere todo en inglés, que es lo recomendable en la mayoría de proyectos profesionales.
¿Qué estándar de documentación utiliza Copilot?
Copilot se adapta al lenguaje de programación y aplica convenciones comunes como JSDoc para JavaScript o docstrings en Python. No necesitas memorizar la sintaxis; la herramienta la genera por ti y tú solo validas que el contenido sea correcto.
¿Qué es la regla "pieza tocada, pieza mejorada"?
Este concepto proviene directamente del ajedrez: pieza tocada, pieza jugada [3:12]. Aplicado al desarrollo de software, significa que cada vez que modificas una parte del código —sin importar si eres el creador del proyecto o acabas de integrarte al equipo— deberías aprovechar para mejorarla.
- Añade documentación al fragmento que estás tocando.
- Escribe pruebas unitarias para esa pieza.
- Aplica pequeñas mejoras de calidad mientras trabajas en tu feature.
Esta estrategia permite reducir la deuda técnica de forma gradual, sin necesidad de dedicar sprints completos a reescribir código. Con el tiempo, el proyecto mejora orgánicamente con cada pull request [3:40].
¿Por qué combinar esta técnica con inteligencia artificial?
Herramientas como GitHub Copilot eliminan la fricción de documentar y escribir pruebas. Lo que antes tomaba varios minutos ahora se resuelve en segundos:
- Seleccionas el código.
- Copilot explica, documenta o sugiere tests.
- Tú revisas, ajustas e integras.
De esta forma, la IA no reemplaza tu criterio profesional, sino que acelera las buenas prácticas que ya conoces. Cada pieza de código que tocas queda mejor de como la encontraste, y eso marca una diferencia enorme a largo plazo.
Ahora cuéntanos: ¿ya estás aplicando la regla del ajedrez en tus proyectos? Comparte tu experiencia en los comentarios.
