Cuándo usarla

Recurre a ella cuando un socio, un cliente o un equipo interno necesite una referencia que pueda leer sin conexión, adjuntar a un contrato o guardar junto con una versión. Tus lectores son desarrolladores que copiarán desde la página, así que el PDF conserva el texto seleccionable y los ejemplos de código mantienen su formato.

Qué incluye

• Secciones de descripción general y autenticación, con campos para completar el proyecto, la persona responsable, la fecha y el correo de soporte.
• Una entrada de endpoint con una tabla de parámetros que muestra tipo, si es obligatorio y descripción, además de un ejemplo con curl.
• Una tabla de campos de respuesta y una tabla de errores con el estado, su significado y la acción a seguir.

Consejos para un mejor documento

• Usa tokens de ejemplo en cada muestra y nunca una clave real. Indica el lenguaje en cada bloque de código para que MDPress aplique el resaltado de sintaxis.
• Cuando documentes más de unos pocos endpoints, activa el índice con números de página para que los lectores salten directo al que necesitan.