Prompt para crear documentación técnica clara para código o APIs

Necesito crear documentación técnica con IA a partir de código, endpoints o procesos reales.

Datos que debes usar:
- elemento a documentar: endpoint POST /api/orders para crear pedidos
- audiencia técnica: desarrolladores frontend que integran la API
- contexto técnico: Node.js, Express, autenticación con JWT y base de datos PostgreSQL
- restricciones: no inventar parámetros ni códigos de error no presentes en el código
- formato: referencia técnica con ejemplos de request y response

Entrega una respuesta breve, accionable y lista para revisar.
Mantén el tono adecuado al contexto, no inventes datos y señala cualquier información crítica que falte antes de aplicar el resultado.

Eres redactor técnico especializado en documentación para desarrollo de software. Necesito convertir información técnica en documentación clara, precisa y útil para la audiencia indicada.

Datos disponibles:
- elemento a documentar: endpoint POST /api/orders para crear pedidos
- audiencia técnica: desarrolladores frontend que integran la API
- contexto técnico: Node.js, Express, autenticación con JWT y base de datos PostgreSQL
- restricciones: no inventar parámetros ni códigos de error no presentes en el código
- formato: referencia técnica con ejemplos de request y response

Instrucciones:
1. Identifica el propósito del elemento y cuándo debe usarse.
2. Describe requisitos previos, entradas, salidas, dependencias y errores conocidos.
3. Crea ejemplos solo con información proporcionada o claramente inferible.
4. Marca cualquier parámetro, comportamiento o código de error que no esté confirmado.
5. Adapta el lenguaje al nivel técnico de la audiencia.
6. No inventes contratos, endpoints, librerías ni reglas de negocio.

Entrega:
- resumen funcional en lenguaje claro.
- documentación técnica estructurada.
- ejemplos de uso, request, response o llamada según corresponda.
- lista de errores, límites y casos borde.
- checklist para validar que la documentación está completa.
- preguntas pendientes para el equipo si falta información.

Criterio final:
La documentación debe permitir usar o mantener el elemento sin depender de explicaciones orales. Todo dato dudoso debe quedar marcado como pendiente de confirmación.

Modo avanzado:
1. Antes de redactar, separa datos confirmados, supuestos razonables y datos que faltan.
2. Adapta la respuesta al objetivo concreto: crear documentación técnica con IA a partir de código, endpoints o procesos reales.
3. Explica el criterio que usaste para priorizar estructura, tono, profundidad y formato.
4. Entrega una versión principal y, cuando sea útil, una versión alternativa más breve o más práctica.
5. Añade una tabla de revisión con: decisión tomada, motivo, riesgo y cómo comprobarlo.
6. Incluye errores comunes específicos de esta tarea y cómo evitarlos.
7. Si detectas información insuficiente, haz hasta 3 preguntas; si puedes avanzar, declara los supuestos y continúa.
8. No inventes datos, cifras, fuentes, políticas, experiencia, funcionalidades ni resultados no aportados.
9. Usa únicamente la información proporcionada por estas variables: endpoint POST /api/orders para crear pedidos, desarrolladores frontend que integran la API, Node.js, Express, autenticación con JWT y base de datos PostgreSQL, no inventar parámetros ni códigos de error no presentes en el código, referencia técnica con ejemplos de request y response.

Formato avanzado de entrega:
- resumen ejecutivo del enfoque.
- resultado principal listo para usar.
- versión alternativa o simplificada.
- tabla de decisiones y riesgos.
- puntos que conviene verificar manualmente.
- checklist final antes de aplicar el resultado.

Usa ChatGPT para convertir estos datos en una respuesta estructurada, clara y lista para revisar.

Objetivo: crear documentación técnica con IA a partir de código, endpoints o procesos reales.

Datos disponibles:
- elemento a documentar: endpoint POST /api/orders para crear pedidos
- audiencia técnica: desarrolladores frontend que integran la API
- contexto técnico: Node.js, Express, autenticación con JWT y base de datos PostgreSQL
- restricciones: no inventar parámetros ni códigos de error no presentes en el código
- formato: referencia técnica con ejemplos de request y response

Instrucciones:
1. Mantén la respuesta fiel a la información aportada.
2. No inventes datos, cifras, experiencia, políticas ni resultados.
3. Usa un formato claro y aplicable al caso.
4. Señala dudas o datos insuficientes antes de presentar conclusiones.
5. Pide una salida por secciones, una versión breve y una lista final de puntos a comprobar.

Entrega el resultado final listo para copiar o adaptar.

Usa Claude para trabajar el contexto con especial atención a matices, límites y coherencia editorial.

Objetivo: crear documentación técnica con IA a partir de código, endpoints o procesos reales.

Datos disponibles:
- elemento a documentar: endpoint POST /api/orders para crear pedidos
- audiencia técnica: desarrolladores frontend que integran la API
- contexto técnico: Node.js, Express, autenticación con JWT y base de datos PostgreSQL
- restricciones: no inventar parámetros ni códigos de error no presentes en el código
- formato: referencia técnica con ejemplos de request y response

Instrucciones:
1. Mantén la respuesta fiel a la información aportada.
2. No inventes datos, cifras, experiencia, políticas ni resultados.
3. Usa un formato claro y aplicable al caso.
4. Señala dudas o datos insuficientes antes de presentar conclusiones.
5. Pide que diferencie hechos aportados, supuestos razonables y datos que faltan antes de redactar.

Entrega el resultado final listo para copiar o adaptar.

Usa Gemini para organizar la respuesta, comparar opciones y mantener una estructura fácil de seguir.

Objetivo: crear documentación técnica con IA a partir de código, endpoints o procesos reales.

Datos disponibles:
- elemento a documentar: endpoint POST /api/orders para crear pedidos
- audiencia técnica: desarrolladores frontend que integran la API
- contexto técnico: Node.js, Express, autenticación con JWT y base de datos PostgreSQL
- restricciones: no inventar parámetros ni códigos de error no presentes en el código
- formato: referencia técnica con ejemplos de request y response

Instrucciones:
1. Mantén la respuesta fiel a la información aportada.
2. No inventes datos, cifras, experiencia, políticas ni resultados.
3. Usa un formato claro y aplicable al caso.
4. Señala dudas o datos insuficientes antes de presentar conclusiones.
5. Pide que marque elementos que deban verificarse manualmente si dependen de información externa o cambiante.

Entrega el resultado final listo para copiar o adaptar.