# Documentación de la API

Todas las API deberían documentarse en RAML o Swagger, consulte Architecture-Documentation-Guidelines](Architecture-Documentation-Guidelines.md)

Títulos de sección

• No numere los títulos; por ejemplo, "Prepare and Fulfill", no "C - Prepare and Fulfill"
• Asegúrese de que los títulos de sección (# ) coincidan con el título correspondiente en el PDF completo (generado a partir del archivo de configuración de dactyl (opens new window))
• No incluya la palabra "documentación" en los títulos

# Recuperabilidad

• En las secciones que contienen muchas subsecciones de endpoints o métodos, incluya un índice al comienzo de la sección
• No diga la palabra proyecto; utilice componente, microservicio, interfaces, etc.

# Lenguaje

En lugar de la palabra "proyecto", utilice un sustantivo específico como componente, microservicio o interfaz.

# Procedimientos

• Introduzca los procedimientos con títulos H3 (###) o H4 (####) (no H2 (##)).
• No utilice números en los títulos de las secciones de procedimientos.
• Utilice el marcado de lista ordenada para los pasos de los procedimientos. Por ejemplo:
• Paso 1
• Paso 2
• Paso 3