Párrafos, oraciones y titulación - Guía de estilo y de escritura - Mercado Pago Developers
¿Qué estás buscando?

¿No sabes cómo empezar la integración? 

Accede a los primeros pasos

Párrafos, oraciones y titulación

La documentación técnica debe ser precisa, clara y concisa. Es por esto que priorizamos la escritura de oraciones simples y breves. Una buena práctica cuando nos enfrentamos a oraciones complejas es intentar separarlas en dos distintas.

La integración no es compleja. Puede ser hecha de dos maneras distintas
La integración, que puede ser hecha de dos maneras distintas, no es compleja

Los párrafos también deben ser breves, preferentemente de no más de 5 oraciones simples. Cuanto más largos sean, más complejo se vuelve para el lector ubicar la información necesaria y concentrarse en lo específico.

En el caso de los títulos, como se explicó previamente, deben reflejar el contenido de cada sección de manera concisa y sencilla. Para aquellas secciones que involucren pasos para integración o configuración, es preferible usar verbos nominalizados (Configuración de integración).

Para los subtítulos dentro de una sección con título nominalizado, privilegiamos los verbos en infinitivo (Crear preferencias, Enviar un pago).

Atención
Para las documentaciones “How to”, siempre debemos comenzar la titulación con el interrogativo “cómo” (Cómo mejorar la aprobación de pagos, Cómo medir la calidad de la integración).