Código · 24 de agosto de 2026
Documenta tu endpoint o función en minutos, sin escribirlo tú
Pega un endpoint o una función y recibe la documentación clara (parámetros, respuesta, ejemplos, errores) lista para tu equipo o tus usuarios.
Documentar tu propio código casi siempre se queda para "después", y ese "después" nunca llega. Este prompt convierte un endpoint o función en documentación clara y completa (parámetros, respuesta, errores, ejemplo real) lista para tu equipo o tus usuarios, sin que tengas que escribirla tú desde cero.
Para: ClaudeChatGPTClaude Code
Prompt completo
Actúa como un escritor técnico senior especializado en documentación de APIs y código, que prioriza la claridad y la precisión sobre sonar impresionante, y que nunca inventa un comportamiento que no está en el código que le diste. Te voy a pegar un endpoint o una función. Tu trabajo es generar la documentación completa, lista para publicar, sin inventar parámetros, tipos o comportamientos que no puedas confirmar en el código. Código o endpoint completo: [PEGA AQUÍ EL CÓDIGO, INCLUYENDO FIRMAS DE TIPOS SI LAS TIENES] Lenguaje o framework: [EJ. Node/Express, Python/FastAPI, función de JavaScript] Audiencia de la documentación: [EJ. otros devs de mi equipo, desarrolladores externos que consumen mi API, mi yo del futuro] Formato de salida: [EJ. Markdown para un README, comentario JSDoc/docstring, página de docs estilo Swagger] Contexto de negocio que debería mencionarse (opcional): [EJ. este endpoint es solo para usuarios autenticados, esta función corre en cada checkout] Entrégame: 1. Una descripción de una línea de qué hace, en lenguaje simple, sin jerga innecesaria. 2. La lista de parámetros o argumentos: nombre, tipo, si es obligatorio u opcional, y qué representa cada uno. 3. La forma exacta de la respuesta o del valor de retorno (con un ejemplo real de JSON o del tipo de dato), incluyendo casos de éxito. 4. Los errores o códigos de estado que puede devolver, y qué los provoca cada uno. 5. Un ejemplo de uso completo y copiable (llamada real con datos de ejemplo, no placeholders genéricos como "foo" o "bar"). 6. Si detectas un caso límite o un comportamiento ambiguo en el código que no está claro, señálalo como [revisar con el autor] en vez de asumir qué debería pasar. Reglas anti-alucinación: no inventes parámetros, tipos, códigos de error ni ejemplos de respuesta que no puedas derivar directamente del código que te di. Si algo no está claro en el código (por ejemplo qué pasa si un campo llega vacío), márcalo como [dato a verificar] en vez de inventarlo.
Enlace corto: wandabuilds.ai/p/wqZa
Vuelve mañana por otro, o mira todos los prompts.