IA para programadores
Cómo usar IA para documentar código sin generar ruido
Documentar con IA funciona si documentas decisiones, no obviedades. Flujo, prompts y revisión para docs que de verdad se leen.
La IA es excelente redactando documentación, pero terrible decidiendo qué merece documentarse. El truco está en usarla para explicar decisiones y casos límite, no para parafrasear el nombre de las funciones.
Qué pedirle a la IA
- README de un módulo a partir de su código y sus tests.
- Ejemplos de uso para funciones públicas.
- Tabla de errores posibles y cómo resolverlos.
Prompt que funciona
Documenta esta función para un desarrollador que NO
conoce el proyecto. Explica el porqué, no el qué.
Incluye: ejemplo de uso, errores que puede lanzar y
un caso límite que el autor debería conocer.Revisión imprescindible
La IA puede inventar comportamientos que parecen razonables. Verifica cada afirmación contra el código y borra sin piedad cualquier párrafo que no aporte información que el código no diga ya.
Fuentes
#documentación#tutorial#código
Volver