El enfoque de este capítulo es uno de los usos más importantes de la escritura técnica: las instrucciones. Como sabe, las instrucciones son esas explicaciones paso a paso de cómo hacer algo: cómo construir, operar, reparar o mantener cosas.
Asegúrese de ver los ejemplos.
Escribir instrucciones
Uno de los usos más comunes y uno de los más importantes de la escritura técnica son las instrucciones, esas explicaciones paso a paso de cómo hacer cosas: ensamblar algo, operar algo, reparar algo o hacer el mantenimiento rutinario de algo. Pero para algo aparentemente tan fácil e intuitivo, las instrucciones son algunos de los documentos peor escritos que se pueden encontrar. Al igual que yo, es probable que hayas tenido muchas experiencias exasperantes con instrucciones mal escritas. Lo que sigue en este capítulo puede que no sea una guía a prueba de tontos y tontos para escribir instrucciones, pero le mostrará lo que los profesionales consideran las mejores técnicas.
En definitiva, una buena redacción de instrucciones requiere:
- Una redacción clara y sencilla
- Un conocimiento profundo del procedimiento en todos sus detalles técnicos
- Su capacidad para ponerse en el lugar del lector, la persona que intenta utilizar sus instrucciones
- Su capacidad para visualizar el procedimiento con gran detalle y plasmar esa conciencia en el papel
- Por último, su voluntad de ir más allá y probar sus instrucciones en el tipo de persona para la que las escribió.
A estas alturas, es probable que haya estudiado los encabezamientos, las listas y los avisos especiales: escribir un conjunto de instrucciones con estas herramientas probablemente parezca obvio. Basta con dividir la discusión en listas verticales numeradas y añadir algunas notas especiales en los puntos obvios y ya está. Bueno, no del todo, pero es un buen comienzo. Este capítulo explora algunas de las características de las instrucciones que pueden hacerlas más complejas. A su vez, puede utilizar estas consideraciones para planificar sus propias instrucciones.
Algunos preliminares
Al principio de un proyecto para escribir instrucciones, es importante determinar la estructura o las características del procedimiento concreto sobre el que va a escribir.
Público y situación. Al principio del proceso, defina el público y la situación de sus instrucciones. Recuerde que definir una audiencia significa definir su nivel de familiaridad con el tema, así como otros detalles de este tipo. Consulte la discusión sobre los públicos y los pasos a seguir para definirlos.
Lo más importante es que, si está en un curso de escritura, tendrá que escribir una descripción de su público y adjuntarla a sus instrucciones. Esto permitirá a su instructor evaluar sus instrucciones en términos de su idoneidad para el público al que van dirigidas. Y recuerde también que en un curso de escritura técnica es preferible escribir para audiencias no especializadas, un reto mucho mayor para usted como escritor.
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 sus 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 de microondas contiene un montón de tales tareas semi-independientes: ajustar el reloj; ajustar el nivel de potencia; utilizar el temporizador; limpiar y mantener el microondas, entre otros. (Las instrucciones sobre el uso de una cámara están organizadas por tareas.)
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 la estructura sería una fase; anclar la cosa en el suelo sería otra; montar el columpio de caja sería otra.
Mejor acercamiento a la discusión paso a paso. Otra consideración, que tal vez no puedes determinar al principio, es cómo enfocar tus instrucciones. Para la mayoría de las instrucciones, usted 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) para 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. Para una mayor discusión, ver el capítulo sobre el análisis de tareas.
Por otro lado, en un enfoque de herramientas para las instrucciones sobre el uso de una fotocopiadora, habría estas secciones improbables:
- botón de copiar
- botón de cancelar
- botón de ampliar/reducir
- botón de compaginar/grapar
- botón de copiar-tamaño, y así sucesivamente
Si se diseñara un conjunto de instrucciones en este plan, se escribirían los pasos para utilizar 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. Aún así, puede haber ocasiones en las que el enfoque de herramientas/características puede ser preferible.
Grupaciones de tareas. Enumerar las 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 resolución de problemas; y así sucesivamente
Secciones comunes en las instrucciones
Lo siguiente es una revisión 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 tienen que estar en el orden presentado aquí, ni que estas son las únicas secciones posibles en un conjunto de instrucciones.
Mientras lee lo siguiente sobre las secciones comunes en las instrucciones, revise las instrucciones de ejemplo.
Vista esquemática de las instrucciones. Recuerde que este es un modelo típico o común para el contenido y la organización-muchos otros son posibles.
Introducción. Planifique cuidadosamente la introducción de sus instrucciones. Asegúrese de que hace cualquiera de las siguientes cosas (pero no necesariamente en este orden) que se aplican a sus instrucciones particulares:
- Indique las tareas específicas o el procedimiento que se explicará, así como el alcance de la cobertura (lo que no se cubrirá).
- Indique lo que la audiencia necesita en términos de conocimiento y antecedentes para entender las instrucciones.
- Dar una idea general del procedimiento y de lo que se consigue.
- Indicar las condiciones en las que se deben (o no se deben) utilizar estas instrucciones.
- Dar una visión general del contenido de las instrucciones.
Véase la sección sobre introducciones para más información.
Advertencias generales, precauciones, avisos de peligro. Las instrucciones a menudo deben alertar a los lectores sobre la posibilidad de estropear 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, por supuesto), usted puede necesitar una discusión de los antecedentes relacionados con el procedimiento. Para ciertas instrucciones, estos antecedentes son críticos; 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 se podría necesitar algo de teoría.
Equipamiento 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 usan en el procedimiento (como tazones 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 todos los elementos -por ejemplo, nombres de marcas, tamaños, cantidades, tipos, números de modelo, etc.
Discusión de los pasos. Cuando se llega a la redacción real de los pasos, hay varias cosas a 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 escritura.
Estructura y formato. Normalmente, nos imaginamos un conjunto de instrucciones con un formato de listas verticales numeradas. Y, de hecho, la mayoría lo están. 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. Se trata de 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 localización de averías que te dicen que compruebes esto, comprueba aquello cuando estás intentando arreglar algo. Puedes hacer este tipo de pasos en prácticamente 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.
- Pasos anidados. En algunos casos, los pasos individuales dentro de un procedimiento pueden ser 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.
- Instrucciones «sin pasos». Y por último, existen instrucciones que realmente no pueden utilizar la lista vertical numerada y que hacen poco, si es que hacen alguna instrucción directa al lector. Algunas situaciones deben ser tan generalizadas o tan variables que no se pueden indicar los pasos.
Véase el capítulo sobre listas para el estilo y el formato de estas posibilidades.
Discusión suplementaria. 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 -discusión de las acciones específicas que componen el paso.
El problema con 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 la instrucción en negrita.
Poner en negrita los pasos reales del usuario en las instrucciones. El texto en negrita ayuda a distinguir la acción real de la información complementaria.
Estilo de escritura. La forma de escribir las instrucciones, frase por frase, puede parecer contradictoria con lo que le han enseñado las clases de escritura anteriores. Sin embargo, fíjese en cómo se escriben las instrucciones del «mundo real»: utilizan mucho el tipo de escritura imperativa (orden, o dirección directa); utilizan mucho el «tú». Eso es totalmente apropiado. Lo que se busca es dirigirse al lector, captar toda su atención. Por eso, las frases de estilo instructivo suenan así: «Ahora, pulse el botón de pausa del panel frontal para detener la pantalla temporalmente» y «Debe tener cuidado de no…»
Un problema particular es el uso de la voz pasiva en las instrucciones. 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 se supone que debe pulsar esa cosa (¿me estás hablando a mí?). O considera este ejemplo: «El botón del temporizador se pone a las 3:00». De nuevo, como la persona que sigue estas instrucciones, podría pasar por alto esto; podría pensar que es simplemente una referencia a algún estado existente, o podría preguntarse: «¿Me están hablando a mí?». Casi tan malo es usar la tercera persona: «El usuario debe pulsar el botón de pausa». De nuevo, es el viejo doble juego: miras alrededor de la habitación y te preguntas: «¿Quién, yo?». (Para más detalles, véase el problema de la voz pasiva.)
Otro de los problemas típicos del estilo de escritura en las instrucciones es que la gente parece querer omitir los artículos: «Pulse el botón de pausa en el panel frontal para detener la visualización de la información temporalmente» o «Terrícola, por favor proporcione la dirección de la pizzería más cercana». ¿Por qué hacemos esto? ¿Acaso queremos ser robots en secreto? En cualquier caso, asegúrese de incluir todos los artículos (a, an, the) y otras palabras de este tipo que normalmente usaríamos en las instrucciones.
Los gráficos en las instrucciones
Probablemente más que en cualquier otra forma de escritura (excepto quizá en los cómics), 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.
En un curso de escritura técnica, las instrucciones pueden requerir que se incluyan ilustraciones u otro tipo de gráficos, lo que normalmente se utiliza en las instrucciones. El problema, por supuesto, puede ser que no tenga acceso a gráficos que sean adecuados para sus instrucciones particulares, y que no se sienta muy seguro de sus habilidades artísticas. Hay formas de superar estos problemas. Echa un vistazo a las sugerencias de los gráficos. En ese capítulo, verá no sólo sugerencias para crear gráficos, sino también requisitos sobre su formato.
Formato en las instrucciones
Cabezales. En sus instrucciones, haga un buen uso de los encabezados. Normalmente, querrá encabezados para cualquier sección de antecedentes que pueda tener, la sección de equipo y suministros, un encabezado general para la sección de instrucciones propiamente dicha, y subencabezados para las tareas o fases individuales dentro de esa sección. Echa un vistazo a los ejemplos al principio de este capítulo. Vea los encabezados para los requisitos comunes.
Listas. Del mismo modo, las instrucciones suelen utilizar mucho las listas, en particular las 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 numeradas son buenas cuando se da una visión general de lo que va a suceder. Vea las listas de requisitos comunes.
Avisos especiales. En las instrucciones, usted debe alertar a los lectores sobre las posibilidades en las que pueden dañar su equipo, desperdiciar los suministros, hacer fracasar todo el procedimiento, lesionarse a sí mismos o a otros -incluso de forma grave o mortal. Las empresas han sido demandadas por la falta de estos avisos especiales, por avisos especiales mal redactados o por avisos especiales fuera de lugar. Vea los avisos especiales para una discusión completa sobre el uso apropiado de estos avisos especiales, así como su formato y colocación dentro de las instrucciones.
Indentación de avisos en las instrucciones. En el primer ejemplo, fíjese en que el aviso está sangrado con respecto al texto del paso anterior. En el segundo ejemplo, fíjese en que el aviso grave se coloca al principio, antes de cualquiera de los pasos.
Números, abreviaturas y símbolos. Las instrucciones también utilizan muchos números, abreviaturas y símbolos. Para obtener directrices sobre estas áreas.
Lista de comprobación para la revisión de instrucciones
Cuando relea y revise sus instrucciones, esté atento a problemas como los siguientes:
- Asegúrese de proporcionar instrucciones reales-explicaciones sobre cómo construir, operar o reparar algo.
- Escriba una buena introducción-en ella, indique el procedimiento exacto que se va a explicar, indique los requisitos de la audiencia y proporcione una visión general del contenido.
- Asegúrese de utilizar los distintos tipos de listas siempre que sea apropiado. En particular, utilice listas verticales numeradas para los pasos secuenciales.
- Utilice títulos para marcar todas las secciones principales y subtítulos para las subsecciones. (Recuerde que no es necesario el encabezamiento «Introducción» entre el título y el primer párrafo. Recuerde que no debe utilizar encabezados de primer nivel en esta tarea; comience con el segundo nivel.)
- Utilice avisos especiales según corresponda.
- Asegúrese de utilizar el estilo y el formato para todos los encabezados, listas, avisos especiales y gráficos que se presentan en estos capítulos. Si eso es un problema, póngase en contacto con su instructor.
- Utilice gráficos para ilustrar cualquier acción u objeto clave.
- Provea una explicación adicional complementaria de los pasos según sea necesario.
- Recuerde crear una sección que enumere el equipo y los suministros, si es necesario.
Agradecería sus pensamientos, reacciones, críticas con respecto a este capítulo: su respuesta-David McMurrey.