Uno de los usos más comunes e importantes de la escritura técnica es proporcionar instrucciones, esas explicaciones paso a paso de cómo montar, operar, reparar o hacer el mantenimiento rutinario de algo. Aunque parezcan intuitivas y sencillas de escribir, las instrucciones son algunos de los documentos peor escritos que se pueden encontrar. La mayoría de nosotros ha tenido probablemente muchas experiencias exasperantes con instrucciones mal escritas. Este capítulo le mostrará lo que los profesionales consideran las mejores técnicas para dar instrucciones.
Un conjunto eficaz de instrucciones requiere lo siguiente:
- Escritura clara, precisa y sencilla
- Un conocimiento profundo del procedimiento en todos sus detalles técnicos
- La capacidad de ponerse en el lugar del lector, la persona que intenta utilizar sus instrucciones
- La capacidad de visualizar el procedimiento en detalle y de plasmar esa conciencia en el papel
- La voluntad de probar sus instrucciones en el tipo de persona para la que las escribió.
Al principio de un proyecto para escribir un conjunto de instrucciones, es importante determinar la estructura o características del procedimiento concreto sobre el que se va a escribir. He aquí algunos pasos a seguir:
Haga un cuidadoso análisis de la audiencia y de la tarea
Al principio del proceso, defina la audiencia y la situación de sus instrucciones. Recuerde que definir una audiencia significa definir el nivel de familiaridad que tienen sus lectores con el tema.
Determine el número de tareas
¿Cuántas tareas hay en el procedimiento sobre el que está escribiendo? Utilicemos el término procedimiento para referirnos al conjunto de actividades de las que tratan tus instrucciones. Una tarea es un grupo semi-independiente de acciones dentro del procedimiento: por ejemplo, ajustar el reloj de un horno microondas es una tarea en el gran procedimiento general de operar un horno microondas.
Un procedimiento simple como cambiar el aceite de un coche contiene sólo una tarea; no hay agrupaciones semi-independientes de actividades. Un procedimiento más complejo como el uso de un horno microondas contiene varias tareas semi-independientes: ajustar el reloj; ajustar el nivel de potencia; usar el temporizador; limpiar y mantener el microondas, entre otras.
Algunas instrucciones tienen una sola tarea, pero tienen muchos pasos dentro de esa única tarea. Por ejemplo, imagine un conjunto de instrucciones para montar un columpio para niños. En mi experiencia, ¡hay más de 130 pasos! Eso puede ser un poco desalentador. Un buen método es agrupar los pasos similares y relacionados en fases, y empezar a renumerar los pasos en cada nueva fase. Una fase es entonces un grupo de pasos similares dentro de un procedimiento de una sola tarea. En el ejemplo del columpio, montar el marco sería una fase; anclar la cosa en el suelo sería otra; montar el columpio de caja sería aún otra.
3. Determine el mejor enfoque para la discusión paso a paso
Para la mayoría de las instrucciones, puede centrarse en las tareas, o puede centrarse en las herramientas (o características de las herramientas). En un enfoque de tareas (también conocido como orientación de tareas) a las instrucciones sobre el uso de un servicio de respuesta telefónica, usted tendría estas secciones:
- Grabar su saludo
- Reproducir sus mensajes
- Guardar sus mensajes
- Reenviar sus mensajes
- Borrar sus mensajes, y así sucesivamente
Estas son tareas-las cosas típicas que querríamos hacer con la máquina.
Por otra parte, en un enfoque de herramientas para las instrucciones sobre el uso de una fotocopiadora, probablemente habría secciones sobre cómo utilizar características específicas:
- Botón de copiar
- Botón de cancelar
- Botón de ampliar/reducir
- Botón de compaginar/grapar
- Botón de tamaño de copia, y así sucesivamente
Si diseñara un conjunto de instrucciones en este plan, escribiría los pasos para usar cada botón o característica de la fotocopiadora. Las instrucciones que utilizan este enfoque de herramientas son difíciles de hacer funcionar. A veces, el nombre del botón no coincide con la tarea a la que se asocia; a veces hay que utilizar más de un botón para realizar la tarea. Aun así, puede haber ocasiones en las que el enfoque de herramientas/características puede ser preferible.
4. Diseñar agrupaciones de tareas
El listado de tareas puede no ser todo lo que necesita hacer. Puede haber tantas tareas que deba agruparlas para que los lectores puedan encontrar las individuales más fácilmente. Por ejemplo, las siguientes son agrupaciones de tareas comunes en las instrucciones:
- Tareas de desembalaje y configuración
- Tareas de instalación y personalización
- Tareas de funcionamiento básico
- Tareas de mantenimiento rutinario
- Tareas de solución de problemas.
Secciones comunes en las instrucciones
Lo siguiente es un repaso de las secciones que encontrará comúnmente en las instrucciones. No asuma que cada una de ellas debe estar en las instrucciones reales que escriba, ni que tengan que estar en el orden presentado aquí, ni que éstas sean las únicas secciones posibles en un conjunto de instrucciones.
Para formatos alternativos, consulte las instrucciones de ejemplo.
Introducción: planifique cuidadosamente la introducción de sus instrucciones. Podría incluir cualquiera de los siguientes elementos (pero no necesariamente en este orden):
- Indicar las tareas o el procedimiento específico que se va a explicar, así como el alcance (lo que se cubrirá y lo que no)
- Indicar lo que la audiencia necesita en términos de conocimientos y antecedentes para entender las instrucciones
- Dar una idea general del procedimiento y de lo que consigue
- Indicar las condiciones en las que estas instrucciones deben (o no deben) utilizarse
- Dar una visión general del contenido de las instrucciones.
Advertencia general, precaución, avisos de peligro: las instrucciones a menudo deben alertar a los lectores sobre la posibilidad de arruinar su equipo, estropear el procedimiento y hacerse daño. Además, las instrucciones deben enfatizar a menudo los puntos clave o las excepciones. Para estas situaciones, se utilizan avisos especiales: nota, advertencia, precaución y aviso de peligro. Observe cómo se utilizan estos avisos especiales en las instrucciones de ejemplo mencionadas anteriormente.
Contexto técnico o teoría: al principio de ciertos tipos de instrucciones (después de la introducción), es posible que necesite una discusión de los antecedentes relacionados con el procedimiento. Para ciertas instrucciones, estos antecedentes son fundamentales; de lo contrario, los pasos del procedimiento no tienen sentido. Por ejemplo, es posible que haya tenido alguna experiencia con esos applets de software en los que usted define sus propios colores moviendo las barras deslizantes rojas, verdes y azules. Para entender realmente lo que estás haciendo, necesitas tener algo de experiencia con el color. Del mismo modo, se puede imaginar que, para ciertas instrucciones que utilizan cámaras, también podría ser necesario algo de teoría.
Equipo y suministros: observe que la mayoría de las instrucciones incluyen una lista de las cosas que necesita reunir antes de comenzar el procedimiento. Esto incluye el equipo, las herramientas que se utilizan en el procedimiento (como cuencos para mezclar, cucharas, moldes para pan, martillos, taladros y sierras) y los suministros, las cosas que se consumen en el procedimiento (como madera, pintura, aceite, harina y clavos). En las instrucciones, estos elementos suelen aparecer en una lista vertical simple o en una lista de dos columnas. Utilice la lista de dos columnas si necesita añadir algunas especificaciones a algunos o a todos los elementos -por ejemplo, nombres de marcas, tamaños, cantidades, tipos, números de modelo, etc.
Discusión de los pasos: cuando llegue a la redacción real de los pasos, hay varias cosas que hay que tener en cuenta: (1) la estructura y el formato de esos pasos, (2) la información complementaria que pueda ser necesaria, y (3) el punto de vista y el estilo general de redacción.
Estructura y formato: normalmente, nos imaginamos un conjunto de instrucciones con formato de listas verticales numeradas. Y, de hecho, la mayoría lo son. Normalmente, las instrucciones paso a paso tienen este formato. Sin embargo, hay algunas variaciones, así como algunas otras consideraciones:
- Los pasos de orden fijo son pasos que deben realizarse en el orden presentado. Por ejemplo, si usted está cambiando el aceite en un coche, el drenaje del aceite es un paso que debe venir antes de poner el nuevo aceite. Son listas numeradas (normalmente, listas numeradas verticales).
- Los pasos de orden variable son pasos que pueden realizarse prácticamente en cualquier orden. Buenos ejemplos son esas guías de resolución de problemas que te dicen que compruebes esto, comprueba aquello cuando estás intentando arreglar algo. Puede realizar este tipo de pasos prácticamente en cualquier orden. Con este tipo, la lista con viñetas es el formato apropiado.
- Los pasos alternativos son aquellos en los que se presentan dos o más formas de lograr lo mismo. Los pasos alternativos también se utilizan cuando pueden existir varias condiciones. Utilice listas con viñetas con este tipo, con OR insertado entre las alternativas, o el lead-in indicando que las alternativas están a punto de ser presentadas.
- Los pasos anidados pueden ser utilizados en los casos en que los pasos individuales dentro de un procedimiento son bastante complejos en sí mismos y necesitan ser divididos en subpasos. En este caso, se hace una sangría adicional y se secuencian los subpasos como a, b, c, y así sucesivamente.
- Las instrucciones «sin pasos». pueden utilizarse cuando realmente no se puede utilizar una lista vertical numerada o proporcionar una dirección directa de estilo instructivo al lector. Algunas situaciones deben ser tan generalizadas o tan variables que no se pueden enunciar los pasos.
Discusión complementaria: a menudo, no basta con decir a los lectores que hagan esto o aquello. Necesitan información explicativa adicional, como el aspecto que debería tener la cosa antes y después del paso; por qué deberían preocuparse por hacer este paso; qué principio mecánico hay detrás de lo que están haciendo; incluso una explicación más a nivel micro del paso: la discusión de las acciones específicas que componen el paso.
El problema de la discusión suplementaria, sin embargo, es que puede ocultar el paso real. Usted quiere que el paso real -las acciones específicas que el lector debe realizar- se destaque. No quiere que todo quede enterrado en un montón de palabras. Hay al menos dos técnicas para evitar este problema: puede dividir la instrucción del suplemento en párrafos separados; o puede poner en negrita la instrucción.
Estilo de escritura
Colocar los pasos clave del usuario en negrita puede ser una forma muy útil de señalar claramente lo que el lector debe hacer. A menudo, el verbo de comando está en negrita; a veces, la fuente en negrita resalta el componente clave del que se habla.
El uso de la voz pasiva en las instrucciones puede ser problemático. Por alguna extraña razón, algunas instrucciones suenan así: «Hay que pulsar el botón de pausa para detener la pantalla temporalmente». No sólo nos preocupa la salud mental del botón de pausa, sino que nos preguntamos quién debe pulsar esa cosa (¿ninjas?). Sería más útil indicar cuándo el lector debe «pulsar el botón de pausa». Considere este ejemplo: «El botón del temporizador se pone entonces a las 3:00». De nuevo, cabría preguntarse: «¿lo pone quién? ¿Los ninjas?». La persona que siga estas instrucciones podría pensar que se trata simplemente de una referencia a algún estado existente, o podría preguntarse: «¿Me están hablando a mí?». El uso de la tercera persona también puede llevar a la incomodidad: «El usuario debe pulsar el botón de pausa». Las instrucciones deben escribirse normalmente utilizando formas verbales de comando y usando el «usted» para dejar perfectamente claro lo que el lector debe hacer.
Ilustración de sus instrucciones
Tal vez más que en cualquier otra forma de escritura técnica, los gráficos son cruciales para las instrucciones. A veces, las palabras simplemente no pueden explicar el paso. Las ilustraciones suelen ser fundamentales para que los lectores puedan visualizar lo que deben hacer. Asegúrese de que los gráficos representen la imagen desde la perspectiva del lector.
Formateo de sus instrucciones
Dado que la gente rara vez quiere leer las instrucciones, pero a menudo tiene que hacerlo, formatee sus instrucciones para que sean reticentes a la lectura. Intente que su lector quiera leerlas, o al menos que no se resista a la idea de consultarlas. Un formato de alta legibilidad permitirá a los lectores que hayan resuelto algunas de las instrucciones por su cuenta saltar a la sección en la que están atascados. Utilice lo que ha aprendido sobre títulos, listas, elementos visuales y espacio pasivo para crear instrucciones eficaces y legibles:
Títulos: normalmente, querrá títulos para cualquier sección de antecedentes que pueda tener, la sección de equipo y suministros, un título general para la sección de instrucciones propiamente dicha y subtítulos para las tareas o fases individuales dentro de esa sección.
Listas: de forma similar, las instrucciones suelen hacer un uso extensivo de listas, en particular listas verticales numeradas para las explicaciones reales paso a paso. Las listas verticales simples o de dos columnas suelen ser buenas para la sección de equipos y suministros. Las listas de frases son buenas cuando se da una visión general de lo que va a suceder.
Avisos especiales: es posible que tenga que alertar a los lectores de las posibilidades de que puedan dañar su equipo, malgastar los suministros, hacer que todo el procedimiento falle, lesionarse a sí mismos o a otros, incluso de forma grave o mortal. Las empresas han sido demandadas por falta de estos avisos especiales, por avisos especiales mal redactados o por avisos especiales fuera de lugar. Ver avisos especiales para una discusión completa del uso apropiado de estos avisos especiales, así como su formato y colocación dentro de las instrucciones.
Al releer y revisar sus instrucciones, compruebe que hacen lo siguiente:
- Describa claramente el procedimiento exacto que se va a explicar
- Proporcione una visión general del contenido
- Indique los requisitos de la audiencia
- Utilice varios tipos de listas siempre que sea apropiado; en particular, utilice listas numeradas para los pasos secuenciales
- Utilice títulos y subtítulos para dividir las secciones y subsecciones principales en un orden lógico y coherente
- Utilice avisos especiales según corresponda
- Utilice gráficos para ilustrar las acciones y los objetos clave
- Provea una explicación adicional complementaria de los pasos según sea necesario
- Cree una sección que enumere el equipo y los suministros si es necesario.
Este capítulo ha sido adaptado de Online Technical Writing de David McMurrey, que está bajo una licencia internacional Creative Commons Attribution 4.0..