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