Creación de manuales de instrucciones retóricamente eficaces

Manuales de instrucciones

Muchas personas asocian los manuales de instrucciones con electrodomésticos, accesorios de ordenador y productos que requieren montaje (por ejemplo, muebles). Dado que no los utilizamos con regularidad o que sólo los esperamos en determinados contextos, es fácil olvidar lo importantes que son. La calidad de un manual de instrucciones bien diseñado puede pasar desapercibida. Sin embargo, cuando nos frustra montar una estantería o un juguete, o cuando intentamos averiguar cómo cambiar o activar un determinado ajuste de un electrodoméstico, la importancia de un manual de instrucciones bien diseñado se hace evidente.

Comprensión de la situación retórica de los manuales de instrucciones

Los manuales de instrucciones, al igual que otros tipos de textos, están conformados por una situación retórica. Las decisiones que toman los escritores técnicos en cuanto al contenido y la forma dependen del propósito del manual de instrucciones, de la audiencia a la que va dirigido y del contexto en el que se utiliza el manual. Cuando escriba su propio manual de instrucciones, tenga en cuenta las siguientes ideas y cuestiones relativas a la situación retórica.

Propósito

En general, el propósito de un manual de instrucciones es familiarizar al usuario con el producto y/o guiarlo a través de una serie de pasos que conducen a la realización de una tarea. Sin embargo, cada manual de instrucciones también tendrá un resultado más específico. Identificar cuál es ese resultado específico le ayudará a tomar decisiones retóricas más eficaces sobre el contenido y el diseño. Pregúntese:

¿Cuáles son los resultados específicos que se pretenden obtener con las instrucciones? (por ejemplo, hacer un pastel desde cero, instalar un aire acondicionado, etc.)
Además de ayudar a los usuarios a alcanzar el/los principal/es resultado/s deseado/s, ¿hay otros propósitos a los que el manual sirve? (por ejemplo, ofrecer consejos para la resolución de problemas, enseñar a los usuarios a realizar tareas adicionales y sencillas necesarias para alcanzar el objetivo principal)

Público

Crear un perfil de su público (es decir, el usuario principal al que va dirigido el documento) es fundamental para tomar decisiones meditadas sobre el alcance, el contenido y el diseño. Considere estas preguntas sobre la audiencia antes de escribir:

¿Cuál es la familiaridad o la experiencia de la audiencia con respecto al tema del manual de instrucciones?
¿Cuál es el nivel de comodidad general de la audiencia con el aprendizaje de nuevas habilidades relacionadas con el software, las aplicaciones, las recetas, etc.?
¿Cuál es el enfoque «típico» de su audiencia para el aprendizaje? ¿Cómo abordará su manual de instrucciones el estilo de aprendizaje, los objetivos y las necesidades relacionadas con la tarea del público?

Contexto

Piense en el contexto como la situación temporal, social, tecnológica y cultural que rodea la creación y el uso del manual de instrucciones. Las siguientes preguntas le ayudarán a identificar el contexto:

¿Cuánto tiempo tendrá para completar este manual de instrucciones?
¿Hay limitaciones de tiempo para el usuario?
¿Qué limitaciones tecnológicas debe considerar para crear el manual de instrucciones? Considere sus habilidades con la tecnología y el nivel de acceso.
¿Cómo accederá su audiencia al manual? (por ejemplo, el público puede acceder al manual en línea a través de un sitio web de la empresa)
¿Qué herramientas o materiales adicionales supone que el público ya tiene? ¿Tendrán acceso a la tecnología o los materiales necesarios para seguir las instrucciones? (por ejemplo, para construir con éxito una estantería, el usuario necesitará un martillo, un destornillador y un área de trabajo abierta)
¿Desde qué perspectiva cultural está escribiendo el manual de instrucciones? ¿Compartirá el público este mismo contexto cultural? (por ejemplo, una receta alemana que requiere azúcar de vainilla, un ingrediente que no se encuentra fácilmente en los Estados Unidos, puede tener que ser modificada para los usuarios estadounidenses)

Using Knowledge of Rhetorical Situation to Make Effective Rhetorical Choices

Aunque la mayoría de los manuales de instrucciones se basan en algunas convenciones estándar, cada manual de instrucciones debe ser adaptado para lograr un propósito específico para una audiencia particular dentro de un contexto determinado. La siguiente sección presenta algunas características comunes de los manuales de instrucciones, a la vez que tiene en cuenta la situación retórica y cómo ésta puede requerir la desviación de ciertas convenciones.

Alcance

La situación retórica ayuda a determinar la cantidad de detalles a incluir en un manual de instrucciones. Por ejemplo, el alcance de un manual de instrucciones para montar un escritorio es fácil de determinar porque sólo tiene un resultado: montar el escritorio. Sin embargo, un manual de instrucciones para una cámara réflex digital de un solo objetivo (DSLR) puede estar dirigido tanto a los usuarios amateurs como a los más experimentados, y es posible que deba incluir instrucciones para realizar tareas básicas (por ejemplo, instalar la batería y la tarjeta de memoria), así como tareas más avanzadas (por ejemplo, ajustar la configuración para entornos de disparo específicos), Ajuste de la configuración para entornos de disparo específicos).

Contenido

Algunas secciones estándar de los manuales de instrucciones incluyen un encabezamiento, una introducción, una serie de pasos, una conclusión y una parte posterior, aunque algunos manuales pueden no utilizar todas estas secciones o etiquetarlas de esta manera. Por ejemplo, los manuales más largos y complejos suelen tener una parte delantera y una parte trasera más extensas. Sin embargo, la mayoría de las instrucciones contienen una introducción que proporciona la información necesaria para completar los pasos de forma segura y eficiente. La introducción puede incluir una explicación sobre quién debe llevar a cabo la tarea (tal vez el usuario deba dominar una determinada habilidad), los materiales necesarios, las precauciones que debe tomar el usuario (consejos de seguridad u otras advertencias) y, en algunos casos, una estimación de la duración del proceso (algo habitual en las recetas). En algunos casos, es necesario incluir una explicación de por qué el usuario debe seguir las instrucciones. Por ejemplo, las instrucciones para cambiar el aceite de un coche pueden explicar por qué la tarea es necesaria para el buen funcionamiento del vehículo.

A continuación de este material introductorio se encuentra la secuencia de instrucciones paso a paso. Véase el siguiente apartado sobre «Lenguaje» para saber cómo redactar pasos claros y eficaces. Por último, un manual de instrucciones puede incluir una «Guía de resolución de problemas» o una sección de «Consejos» para ayudar a los usuarios a abordar los problemas más comunes que pueden encontrar mientras siguen las instrucciones o después de completar el proceso.

Lenguaje

Las preguntas sobre «Audiencia» y «Contexto» anteriores pueden servir de guía para elegir un lenguaje eficaz. Las siguientes subsecciones incluyen explicaciones de las características lingüísticas comunes de los manuales de instrucciones junto con consejos para escribir de forma clara y concisa en este género.

Modo imperativo

Las instrucciones, al igual que las órdenes, suelen utilizar el modo imperativo. Para escribir en este modo, diríjase directamente al público utilizando la voz activa y verbos específicos. ¿Cuál de las siguientes proporciona el paso instructivo más claro?

«Pulse el botón rojo para empezar a jugar»
«Cuando se pulse el botón rojo, el juego empezará»
«El operador debe pulsar el botón»

Aunque un usuario probablemente podría entender cualquiera de estas frases, la primera proporciona la explicación más clara de la acción que debe realizar el usuario. La segunda, de construcción pasiva, no especifica quién debe pulsar el botón. El tercer ejemplo se refiere a un sujeto vago, el «operador», que puede confundir al usuario.

Elección de palabras

Cuando se escriben instrucciones, es importante considerar cuidadosamente la elección de palabras porque en algunos casos, la seguridad del usuario está en riesgo. Por ello, hay que procurar que sean claras y concisas. Para tomar decisiones eficaces sobre la elección de palabras, tenga en cuenta el nivel de conocimientos y el bagaje cultural de su público principal. Puede que sea necesario

definir términos complejos.
escribir los acrónimos la primera vez que se presentan (por ejemplo cámara réflex digital de lente única, DSLR).
evitar el uso de símiles, metáforas, jerga o sustituciones que puedan confundir a los usuarios.
utilizar un lenguaje sencillo, ya que en algunos casos pueden surgir graves consecuencias legales cuando un conjunto de instrucciones no es claro. Para más información sobre el lenguaje sencillo, véase http://www.plainlanguage.gov/index.cfm
incluir traducciones de las instrucciones a varios idiomas.
utilizar títulos y subtítulos breves e informativos

Consistencia y paralelismo

Estructura paralela, o paralelismo, significa utilizar la misma estructura gramatical para presentar información o ideas. El paralelismo se utiliza a menudo para mejorar la legibilidad y crear consistencia.

Esta lista numérica de instrucciones contiene un paso que rompe la estructura paralela. ¿Cuál de estos pasos parece diferente de los demás?

Retire el tornillo para abrir el compartimento de las pilas.
Inserte las pilas siguiendo la imagen del compartimento.
Ahora puede cerrar el compartimento, y atornillarlo para cerrarlo.

El paso tres rompe la estructura paralela de la lista porque no empieza con un verbo directivo.

¿Los siguientes epígrafes utilizan la estructura paralela? ¿Por qué o por qué no?

«Instalación de las pilas»
«Apagado/encendido del dispositivo»
«Cómo cargar el dispositivo»

Diseño

El diseño del documento se refiere a la forma en que se organiza y presenta la información. Dado que los elementos visuales requieren menos tiempo de procesamiento, los usuarios suelen fijarse en la calidad del diseño -y responder a ella- antes que en la calidad del contenido. Incluso si decide no incluir imágenes o gráficos, deberá tener en cuenta el diseño. Esto incluye, como mínimo, la elección del diseño, el orden de la información, el tamaño de la fuente, el tipo de letra, los títulos, el color y el espacio en blanco. Los elementos de diseño deben guiar al usuario a través del manual sin problemas. Esto significa hacer que el documento sea escaneable; un documento escaneable permite a los usuarios navegar por el contenido para localizar información específica. Al igual que con cualquier documento, las decisiones relativas al diseño deben tener en cuenta la audiencia, el propósito y la facilidad de uso en general.

Consistencia/Repetición

Usar un elemento de diseño de manera uniforme a lo largo de todo el documento guía a los usuarios dándoles una idea de lo que pueden esperar (por ejemplo, el mismo tipo de letra y tamaño para todos los títulos; el mismo diseño de página a página).

Contraste

Utilizar un elemento de diseño para resaltar información o características específicas del manual (por ejemplo, poner una palabra en mayúsculas para enfatizarla; colocar un recuadro o un borde alrededor de un elemento; cambiar los colores para enfatizarlo). El contraste es principalmente eficaz cuando un documento utiliza la coherencia en general. Si hay una falta de consistencia, es más difícil crear contraste.

Alineación

Organizar los elementos de una página con alineación horizontal y/o vertical crea jerarquía y estructura, y puede utilizarse para ayudar a lograr equilibrio, contraste o consistencia. Por ejemplo, este documento utiliza la alineación vertical para crear una jerarquía entre el nombre de un elemento de diseño, que está alineado a la izquierda, y su descripción, que está sangrada.

Equilibrio

Distribuir los elementos uniformemente en un espacio determinado. Para conseguirlo, hay que tener en cuenta el peso de cada elemento, es decir, la tendencia del ojo a gravitar hacia un elemento. Por ejemplo, dado que una imagen pesa más que el texto, las decisiones sobre la colocación de la imagen deben considerar cómo equilibrar su peso con respecto a otros elementos para evitar la confusión visual.

Espacio en blanco

Utilizar el espacio en blanco para crear un documento profesional y equilibrado. Más que indicar el color del espacio, este elemento de diseño se refiere a una ausencia de imágenes y texto. El espacio en blanco ayuda a distinguir entre los elementos individuales y los grupos de elementos (es decir, las secciones del manual) y facilita el escaneo de los documentos.

Agrupación/Proximidad

Colocar imágenes o contenidos relacionados cerca unos de otros. Por ejemplo, agrupar las imágenes de todos los materiales necesarios para completar una tarea determinada.

Color

Seleccionar los colores para crear contraste y énfasis, para guiar a los lectores a través del espacio y para diseñar un documento visualmente agradable. Debe tener en cuenta el conjunto del documento para crear un esquema de color coherente. Por ejemplo, si desea utilizar el azul en su documento, querrá asegurarse de que se utiliza de forma coherente y que complementa otros colores del documento. Esto es especialmente importante cuando se integran gráficos y/o imágenes en color.

Imágenes

Elegir las imágenes apropiadas para el contexto y el propósito del manual. Debe considerar si las imágenes están destinadas a ser independientes o a complementar las instrucciones escritas. Hay que tener en cuenta los tipos de imágenes, como los dibujos, las fotos y las ilustraciones gráficas, y si se necesitan llamadas o anotaciones adicionales para destacar partes específicas de la imagen. Las imágenes deben elegirse para complementar otros elementos de diseño del manual.

Conclusión

Un buen manual de instrucciones comienza con una cuidadosa consideración de la situación retórica: propósito, audiencia y contexto. Esta información es clave para tomar decisiones adecuadas y eficaces sobre el contenido, el lenguaje y el diseño. En una línea de tiempo ideal, los redactores técnicos tienen la oportunidad de realizar pruebas de usabilidad, que están diseñadas para evaluar si un documento cumple su propósito. Una vez que su manual de instrucciones haya sido probado, incorporará los comentarios recibidos para finalizar su diseño y contenido.

Ejercicio 1 – Familiarícese con los manuales de instrucciones

El siguiente sitio web contiene varios ejemplos de manuales de instrucciones de código abierto. Siga este enlace, navegue por la lista y elija un manual para examinarlo en profundidad. Hojee el manual para familiarizarse con su contenido y diseño. A continuación, en una nota dirigida a tu instructor o a tus compañeros de clase, aborda lo siguiente.

Identifica la situación retórica

¿Quién es el público? Cómo sabe quién es el público? Qué puede suponer sobre la audiencia basándose en el contenido y las opciones de diseño del manual?
¿Cuál es el propósito del documento? ¿Cómo sabe que es el propósito principal (es decir, qué opciones de contenido y diseño señalan el propósito)?
¿Qué contexto informa el contenido escrito y el diseño de este manual?

Examine las opciones de composición

Describa el alcance general y la organización del manual. ¿Qué grado de detalle tiene el manual? ¿Qué abarca? ¿Cómo está organizada la información?
¿Se cubren todas las «características estándar» del contenido en este manual? ¿Por qué o por qué no? ¿Existen características adicionales? ¿Cuáles son y cuál es su propósito?
Localice y describa ejemplos de elección de lenguaje eficaz. Explique por qué los considera eficaces.
Localice y describa ejemplos de diseño eficaz. Explique por qué los considera eficaces.
Si usted fuera el autor de este manual, ¿qué habría hecho de forma diferente y por qué?

Ejercicio 2 – Planificación de un manual de instrucciones

Imagine que está escribiendo un manual de instrucciones para un proceso o producto con el que está familiarizado y aborde las siguientes indicaciones.

Identifique la situación retórica

Seleccione un público y cree una declaración de perfil de 23 frases de perfil
Identificar el propósito específico de su manual de instrucciones
Enumerar cualquier información contextual importante a tener en cuenta

Crear un plan

Enumerar las secciones que incluirá
Identificar los factores más importantes a tener en cuenta para su audiencia y propósito (e.g., uso del lenguaje, incorporación de imágenes, tamaño del texto, etc.)
Cree un esquema que muestre la disposición del documento, identifique la ubicación de las secciones escritas y muestre dónde se incorporarían las imágenes.