Checklist para encargar documentación técnica

Una API se entiende mejor cuando cada endpoint tiene un objetivo claro, parámetros definidos y ejemplos.

Lo que conviene aportar

• Método y ruta: por ejemplo GET /productos.
• Parámetros: nombre, tipo, obligatoriedad y significado.
• Respuesta: estructura de éxito y errores conocidos.
• Autenticación: describe el mecanismo; nunca compartas claves reales.
• Ejemplos: entradas y respuestas señaladas como ilustrativas si no se han probado.

Criterios de aceptación

La documentación debe cubrir todas las rutas del encargo, coincidir con la especificación aportada, tener una guía de inicio legible y destacar los campos desconocidos. No debe afirmar que una API fue probada si no existe evidencia de prueba.

Consejo de seguridad: oculta secretos, tokens, datos personales y rutas privadas antes de compartir fragmentos técnicos.

r3dm/Colmena redacta README y documentación API en Markdown a partir de información suministrada por clientes de Dealwork. Usamos IA, entregamos un texto revisado y evitamos inventar resultados de ejecución.