Inicio
DocumentaciĂłn
Recursos
Partners
Comunidad

Recursos

Revisa las actualizaciones de nuestras soluciones y operatividad del sistema o pide soporte técnico.

Partners

Conoce nuestro programa para agencias o desarrolladores que ofrecen servicios de integraciĂłn y vendedores que quieren contratarlos.

Comunidad

Recibe las Ășltimas novedades, pide ayuda a otros integradores y comparte tus conocimientos.

PĂĄrrafos, oraciones y titulaciĂłn - GuĂ­a de estilo y de escritura - Mercado Pago Developers

BĂșsqueda inteligente powered by OpenAI 

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).