Estrategias de diseño para documentos técnicos accesibles

Publicado el 5 enero, 2022

¿Qué es un pie de moño?

¿Sabes qué es un pie de moño? ¿Qué tal una camilla de madera? ¿Quizás sepa cómo utilizar un bloqueo de enchufe? Si no sabe la respuesta a alguna de estas preguntas, no se sienta mal. Hay solo unas pocas personas que saben qué son esas cosas, y la mayoría de ellas son las personas que realmente escribieron la documentación técnica en la que aparecen esos términos.

La redacción técnica se refiere a documentos como instrucciones de montaje, manuales de usuario y otros materiales de referencia especializados. El desafío para cualquier escritor técnico es comprender un producto o proceso casi tan bien como los ingenieros que lo construyeron y al mismo tiempo reducir ese material a una forma escrita que una persona común pueda entender.


Los documentos técnicos como las guías del usuario no son muy útiles a menos que sean accesibles.
Ilustración de una guía del usuario

Si el ejemplo que involucra el pie de moño, la camilla de madera y el bloqueo del enchufe parecía un poco exagerado, en realidad no lo es. Esas tres partes no son cosas que encontraría en un reactor nuclear, un avión o un rascacielos, sino parte de las instrucciones de montaje orientadas al consumidor para una cama tamaño queen. Este tipo de jerga hace que las instrucciones de montaje no sean muy accesibles para el consumidor.

Hacer que la redacción técnica sea más accesible

La creación de un documento técnico accesible comienza con un gran escritor técnico. Un documento técnico accesible es aquel que es fácil de entender y seguir a nivel del consumidor. Es importante recordar que la alta accesibilidad es más un “punto óptimo” que una línea de meta. La redacción técnica puede ser demasiado compleja, pero también demasiado simple. Todos hemos recibido documentos técnicos que solo incluían diagramas y pasos numerados. Una documentación técnica tan limitada puede resultar igualmente frustrante para los consumidores.

Ahora veamos algunas formas en que los escritores técnicos pueden encontrar esa ventana de accesibilidad.

Diseño

Cuando un escritor comienza a elaborar un documento técnico, hay pocos fundamentos comunes que se puedan aplicar en prácticamente cualquier industria o situación. Un documento técnico accesible es aquel que está enfocado con láser a un público objetivo. Términos como ” pie de moño ” o ” bloqueo de enchufe ” pueden ser perfectamente accesibles en un manual de referencia sobre cómo operar una central nuclear donde el lector es un ingeniero altamente calificado, pero no es accesible para el consumidor diario de un Cama de matrimonio. Los buenos escritores técnicos diseñan sus documentos para adaptarlos a sus lectores.

Una segunda piedra angular de la escritura técnica accesible es el uso apropiado de imágenes, diagramas u otras ayudas visuales. Un pie de moño en forma de texto es mucho menos accesible que una imagen o un diagrama de estas partes. Imágenes como esta eliminan la necesidad de que los consumidores intenten encontrar esta información por sí mismos de una fuente diferente.

Formato

¿Alguna vez ha sacado un inserto de producto gigante y aparentemente interminable para un producto o proceso relativamente sencillo? Sin embargo, si lo mira con atención, notará que es largo no por su voluminoso contenido, sino porque contiene documentación técnica en media docena de idiomas.

Lo más probable es que también esté escrito en algunas de las letras más pequeñas que pueda encontrar. Ninguno de estos elementos de formato hace mucho para que un documento técnico sea más accesible. Es mejor usar términos comunes, en un formato legible y sin información voluminosa y extraña. Aquí hay algunos ejemplos de “jerga” que se hace más accesible tanto en diseño como en formato:

Terminología inaccesibleTerminología más accesible
El usuario no podrá prestar, subarrendar, donar, descompilar ni ofrecer a la venta el software contenido en este documento.Acepta utilizar este software solo para usted. Acepta no alterar el software ni proporcionárselo a nadie más.
Para ensamblar el marco de la cama, coloque las patas de moño en la camilla de madera. Coloque bloqueos de tapones sobre las patas del moño.Conecte A (pie de moño) a B (camilla de madera). Una vez completado, use C (cierres de tapón) para cubrir los tornillos visibles. (Diagrama para acompañar.)
Si el módem de cable y / o enrutador requiere solución de problemas, comience por determinar si el problema es la capacidad de datos ascendente o la velocidad de datos descendente.Solucione problemas de conexión mirando las luces en el panel frontal. Debería ver una luz verde parpadeando debajo de las letras ” US ” y una luz ámbar parpadeando debajo de las letras ” DS ”.

El lenguaje más accesible es agradable, utiliza términos comunes y es más apropiado para su público objetivo. Por supuesto, debe asegurarse de que el formato sea legible y esté libre de errores gramaticales y / o ortográficos.

Resumen de la lección

La documentación técnica es una forma importante y común para que los fabricantes proporcionen a los consumidores información funcional sobre su producto o proceso. Aunque de naturaleza compleja, la documentación técnica debe ser accesible (comprensible y fácil de usar) para la audiencia destinataria.

El texto de la documentación técnica debe complementarse con imágenes o diagramas; sin embargo, las imágenes no deben reemplazar el texto por completo, ya que la documentación técnica limitada puede resultar igualmente frustrante para los consumidores cuando el texto es demasiado complicado. Al formatear la documentación técnica, debe ser legible, personal y libre de información superflua.

¡Puntúa este artículo!