Crear documentación clara y consistente es uno de los mayores retos en cualquier proyecto de software. La buena noticia es que los modelos de inteligencia artificial generativa como ChatGPT y Claude pueden convertirse en tus mejores aliados para generar descripciones, documentación técnica, tutoriales y guías completas a partir de simples indicaciones en lenguaje natural. No se trata solo de pedir código: puedes transformar ideas en documentos estructurados e incluso traducir código a texto y viceversa.
¿Cómo generar documentación de un proyecto con ChatGPT?
El primer ejercicio consiste en pedirle a ChatGPT que genere documentación sin código, usando únicamente lenguaje natural [01:10]. El prompt inicial solicita una descripción general para una aplicación de gestión de tareas que permita crear, editar y eliminar tareas, organizarlas en proyectos y asignar fechas de vencimiento.
El resultado inicial fue solo una descripción general, no una documentación completa. Aquí se evidencia un punto fundamental: la calidad de tu prompt determina la calidad de la respuesta. Al agregar una segunda instrucción — "convierte esta descripción con requerimientos en la documentación del proyecto" — el resultado cambió por completo [02:05].
- La salida incluyó una descripción general bien estructurada.
- Requerimientos funcionales organizados en bullet points: creación, edición, eliminación de tareas y organización por proyectos.
- Requerimientos no funcionales que no estaban explícitos en el prompt original.
- Tecnologías recomendadas y futuras mejoras.
Esto demuestra que iterar sobre el prompt es clave. No basta con una sola instrucción; refinar la solicitud permite obtener resultados progresivamente más precisos y útiles.
¿Qué tan detallada es la documentación técnica que genera Claude?
Para comparar, se le pidió a Claude una documentación técnica para una función específica llamada create task [03:15]. A diferencia del ejercicio anterior, aquí se proporcionó el nombre de la función, los parámetros que recibe y un breve contexto: permite a los usuarios crear una nueva tarea.
Claude generó un resultado con un nivel de detalle significativamente mayor:
- Descripción general de la función create task.
- Sintaxis basada exactamente en lo proporcionado en el prompt.
- Parámetros organizados en una tabla, un formato mucho más adecuado para documentación profesional [04:00].
- Valor de retorno con una predicción de cómo podría ser la salida de la función.
- Excepciones y validaciones que no fueron indicadas explícitamente.
¿Qué elementos adicionales incluyó Claude?
Además de lo básico, Claude agregó elementos que enriquecen la documentación de forma considerable [04:30]:
- Ejemplos de uso con bloques de código funcional.
- Escenarios como crear una tarea sin fecha de vencimiento.
- Condiciones especiales y validaciones.
- Consideraciones de rendimiento y mejores prácticas.
- Limitaciones y compatibilidad.
Este resultado es especialmente valioso porque generó casi toda la lógica de la aplicación a partir de la documentación técnica. Es una forma inversa de construir software: primero la documentación, luego el código [05:10].
¿Por qué es importante iterar el prompt en cada herramienta?
Cada modelo responde de manera diferente al mismo tipo de solicitud. ChatGPT entregó una documentación más orientada a texto y visión de proyecto, mientras que Claude se enfocó en detalle técnico, código y estructura tabular. Ninguno es mejor que el otro de forma absoluta; depende del tipo de documentación que necesites.
Las variables que determinan la calidad de la salida son tres:
- El contexto que proporcionas en el prompt.
- El nivel de detalle que solicitas para la respuesta.
- La iteración constante para refinar lo que la herramienta te devuelve.
Prueba estas técnicas en tus propios proyectos y experimenta con diferentes formulaciones. Cada ajuste en tu prompt puede marcar la diferencia entre una respuesta genérica y una documentación profesional lista para usar. ¿Ya has probado alguna de estas herramientas para documentar tu código? Comparte tu experiencia.
