Genera documentación técnica con IA: ChatGPT vs Gemini

Mira, colega, si hay algo que nadie quiere hacer en un proyecto de software es documentar. Pero oye, toca. Y aquí es donde la IA entra como un puto salvavidas. He estado probando a fondo ChatGPT y Gemini para esto, y te cuento sin tapujos: no todos los prompts funcionan igual, y la calidad depende de cómo le pidas las cosas.

¿Cuál es mejor para documentar APIs?

Depende del nivel de detalle que busques. ChatGPT (con GPT-4) es más sólido para generar documentación estructurada tipo OpenAPI o Swagger, porque entiende mejor contextos largos y devuelve formatos muy limpios. Gemini, por su parte, es más rápido y directo, ideal para documentación interna o explicaciones rápidas que no necesitan ser perfectas. Eso sí, Gemini se vuelve más genérico si no le das ejemplos concretos.

Prompts que funcionan de verdad

Aquí van prompts que he ido refinando. Cópialos, pégame, y ahorra tiempo.

1. Documentar un endpoint de API

Contexto: API REST de gestión de usuarios. Endpoint POST /api/users, recibe JSON con nombre, email y rol. Devuelve 201 con el usuario creado o 400 si faltan campos.

Tarea: Genera documentación técnica en formato Markdown que incluya: descripción, parámetros, ejemplos de petición/respuesta y códigos de error.

Tono: Técnico pero claro, apto para desarrolladores junior.

2. Explicar lógica de un fragmento de código

Código:

def process_payment(user_id, amount):

 if amount <= 0:
 raise ValueError("Monto inválido")
 user = db.get_user(user_id)
 if not user:
 raise Exception("Usuario no encontrado")
 return payment_gateway.charge(user.card_token, amount)
Tarea: Genera documentación técnica que explique qué hace, posibles errores y casos de uso. Usa un tono profesional pero directo.
3. Crear un README para un proyecto
Proyecto: Microservicio en Node.js para enviar notificaciones push. Tiene 3 endpoints: register, send y status. Usa Redis como cola y Firebase.
Tarea: Escribe un README técnico con: descripción, requisitos, instalación, uso básico y ejemplos de configuración.
Estilo: Sin paja, ve al grano.
4. Resumir documentación extensa
Documentación original: [pega aquí un texto largo de docs técnicas]
Tarea: Resúmelo en 5 puntos clave. Incluye los endpoints principales, parámetros obligatorios y errores comunes.
Formato: Lista con viñetas, sin párrafos largos.
5. Traducir documentación de inglés a español técnico
Texto original: [pega aquí documentación en inglés]
Tarea: Traduce manteniendo el tono técnico y la precisión. No traduzcas términos como "endpoint", "payload" o "callback".
Formato: Conserva la estructura original (títulos, listas, código).

Mi veredicto sin filtros

Para documentar APIs o proyectos, ChatGPT gana por goleada si necesitas precisión y formato consistente. Gemini vale para borradores rápidos o cuando estás en medio del código y quieres documentar algo sobre la marcha, pero cuidado con las alucinaciones: a veces se inventa parámetros que no existen. Mi consejo: usa Gemini para un primer volcado, luego pásalo por ChatGPT para refinar. O haz como yo: promptea bien desde el principio con ejemplos reales de tu código.

Y tú, colega, ¿qué usas para documentar? ¿ChatGPT, Gemini o aún sigues escribiendo a mano como un cavernícola? Cuéntamelo en los comentarios.