Maquetación y diseño de documentos técnicos

Redacción de documentos técnicos

Seamos realistas, una de las ventajas de la escritura técnica es que no se espera que las palabras en sí estén compuestas con ningún tipo de floritura. En cambio, redacción técnicadebe centrarse en los hechos de la situación y casi desaparecer, permitiendo al lector comprender directamente lo que sea que el escritor deseaba impartir. Obviamente, no siempre sucede así. Incluso los documentos mejor diseñados pueden sufrir una serie de problemas que no tienen nada que ver con el autor. El lector de un documento técnico puede estar cansado, empapado de sudor o incluso desinteresado. Sin embargo, el escritor reflexivo puede tomar algunas medidas para minimizar la posibilidad de una mala lectura. En esta lección, veremos la importancia de asegurarnos de que un documento esté bien diseñado. También veremos la importancia del diseño visual, el cumplimiento de las expectativas y la legibilidad general de un texto.

Importancia del diseño visual

Permítame hacerle una pregunta. Digamos que le dan dos páginas de texto idéntico. Uno tiene 300 palabras en un bloque de texto gigante, sin encabezados, sin saltos de párrafo. Mientras tanto, la otra página tiene la información perfectamente dividida en secciones y subsecciones, con títulos grandes y en negrita para ayudarlo a descubrir para qué sirve cada sección del texto. ¿Qué documento crees que la gente preferiría leer? Mejor aún, y más importante para la redacción técnica, ¿de qué documento cree que las personas podrían retener mejor la información? Asegurarse de que su documento esté bien diseñado es una parte crucial del formateo de documentos técnicos. Después de todo, este estilo de escritura se trata de impartir el significado del texto al lector, así que ¿por qué no hacerlo fácil? Uso abundante de títulos, saltos de sección,

Cumpliendo con las expectativas

Elija cualquier documento técnico y lo más probable es que pueda saber qué es con solo mirarlo. Obviamente, un manual para un nuevo proceso puede pesar más que, digamos, una nota, pero incluso los documentos de una sola página tienen un cierto aspecto. Las cartas tienen bloques para direcciones, los memorandos tienen grandes líneas de asunto y los currículums tienen el nombre del solicitante en la parte superior. Sabemos al instante cuáles son debido a su diseño. Imagínese escribir una carta al estilo de un currículum. Como puedes imaginar, es bastante incómodo escribir, y mucho menos leer. Sin embargo, cuando tomamos uno de esos documentos, sabemos cuál es porque se ajusta a nuestras expectativas. Una cifra muy citada es que los gerentes de contratación solo miran un currículum durante unos segundos antes de tomar una decisión. Al colocar información en los lugares esperados, aumenta la probabilidad de que sea su educación,

Legibilidad

Finalmente, está la cuestión del texto en sí. Volvamos al ejemplo de los dos documentos, uno que estaba bien formateado con encabezados y otro que no. Ahora, démosle un giro. Tomemos el ejemplo de un bloque de texto y conviértalo en una fuente legible, digamos, Times New Roman, en un tamaño de 12 puntos con muchos términos en negrita siempre que ocurra algo importante. Mientras tanto, el documento con todos los encabezados y saltos de párrafo ahora está en una fuente con volantes absolutamente ilegible en un tamaño de 5 puntos. Además, no tiene ninguno de los términos audaces del primero. Ahora, antes, habría elegido la página con todos los encabezados, pero en esta, es simplemente ilegible. Como resultado, me veo obligado a leer el gran bloque de texto.

Lo mismo ocurre con los currículums. Al poner en negrita, poner en cursiva o subrayar cierto texto, podemos hacerlo resaltar. Digamos que estaba solicitando un trabajo de programación. Sin embargo, tu especialidad fue el arte de estudio. Dicho esto, su tesis fue sobre la exploración del arte en el código de computadora y cómo algunos lenguajes de programación fueron escritos para ser más agradables estéticamente. En resumen, probablemente esté tan familiarizado con la codificación como alguien con un menor en el campo. Ahora, si se postulara para ese trabajo sin resaltar nada de ese trabajo sobre su tesis, su currículum se tiraría a la basura. Sin embargo, debido a que lo hizo, el lector definitivamente se enfocará en él. Eso significa que es mucho más probable que lo llamen para una entrevista.

Resumen de la lección

En esta lección, analizamos la importancia de un formato y diseño adecuados para los documentos técnicos . Primero nos enfocamos en la importancia de los encabezados y los saltos de párrafo antes de pasar a la cuestión de asegurarnos de que un documento se ajusta a las expectativas. Finalmente, analizamos la importancia de resaltar los términos clave, así como mantener la fuente legible y en un tamaño apropiado.

Rodrigo Ricardo Editor y fundador