Notas:
- Este capítulo, así como el resto de este libro de texto de redacción técnica, se centra en las habilidades de redacción técnica. El contenido técnico aquí no está garantizado como exitoso, preciso ni actualizado.
- Este capítulo ha sido traducido con OpenAI ChatGPT. Por favor, informe cualquier problema de idioma a admin@mcmassociates.io.
- Haga clic aquí para ayudar a David McMurrey a pagar el alojamiento web: ¡Done la cantidad que pueda! Online Technical Writing seguirá siendo gratuito.
El enfoque de este capítulo es uno de los usos más importantes de la redacción técnica: las instrucciones. Como sabe, las instrucciones son explicaciones paso a paso de cómo hacer algo: cómo construir, operar, reparar o dar mantenimiento a cosas.
Asegúrese de revisar los ejemplos.
¿Va a escribir un conjunto de instrucciones para el trabajo o para una clase de redacción técnica? Pruebe esta guía de planificación de instrucciones.
Redacción de instrucciones
Uno de los usos más comunes y uno de los más importantes de la redacción técnica son las instrucciones: esas explicaciones paso a paso de cómo hacer cosas: ensamblar algo, operar algo, reparar algo o realizar el mantenimiento rutinario de algo. Pero, para algo que aparentemente es tan fácil e intuitivo, las instrucciones son algunos de los documentos peor escritos que se pueden encontrar. Al igual que yo, probablemente haya tenido muchas experiencias frustrantes con instrucciones mal redactadas. Lo que sigue en este capítulo puede no ser una guía infalible para escribir instrucciones, pero le mostrará lo que los profesionales consideran las mejores técnicas.
En última instancia, una buena redacción de instrucciones requiere:
- Redacción clara y sencilla
- Una comprensión exhaustiva del procedimiento en todos sus detalles técnicos
- Su capacidad para ponerse en el lugar del lector, la persona que intenta usar sus instrucciones
- Su capacidad para visualizar el procedimiento con gran detalle y plasmar esa comprensión en el papel
- Finalmente, su disposición a ir un paso más allá y probar sus instrucciones con el tipo de persona para quien las escribió.
A estas alturas, probablemente ya haya estudiado encabezados, listas y avisos especiales; redactar un conjunto de instrucciones con estas herramientas probablemente parezca obvio. ¡Simplemente divida la explicación en listas verticales numeradas y agregue algunos avisos especiales en los puntos evidentes y listo! Bueno, no del todo, pero es un excelente comienzo. Este capítulo explora algunas de las características de las instrucciones que pueden hacerlas más complejas. A su vez, puede usar estas consideraciones para planificar sus propias instrucciones.
Infografía generada por NotebookLM de este capítulo
Algunos aspectos preliminares
Al comienzo de un proyecto para redactar instrucciones, es importante determinar la estructura o las características del procedimiento específico sobre el que va a escribir.
Audiencia y situación. Al inicio del proceso, defina la audiencia 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 similares. Consulte la discusión sobre audiencias y los pasos para definirlas.
Lo más importante es que, si está en un curso de redacción, deberá escribir una descripción de su audiencia y adjuntarla a sus instrucciones. Esto permitirá que su instructor evalúe sus instrucciones en términos de su adecuación para la audiencia prevista. Y recuerde también que en un curso de redacción técnica es preferible escribir para audiencias no especializadas, lo cual representa un reto mucho mayor para usted como redactor.
Número de tareas. ¿Cuántas tareas hay en el procedimiento sobre el que está escribiendo? Usemos el término procedimiento para referirnos al conjunto completo de actividades que sus instrucciones pretenden explicar. Una tarea es un grupo semiindependiente de acciones dentro del procedimiento: por ejemplo, configurar el reloj de un horno de microondas es una tarea dentro del procedimiento general de operar un horno de microondas.
Un procedimiento sencillo como cambiar el aceite de un automóvil contiene solo una tarea; no hay agrupaciones semiindependientes de actividades. Un procedimiento más complejo como usar un horno de microondas contiene muchas de estas tareas semiindependientes: configurar el reloj, establecer el nivel de potencia, usar el temporizador, limpiar y dar mantenimiento al microondas, entre otras. (Las instrucciones para usar una cámara están organizadas por tareas.)
Algunas instrucciones tienen solo una tarea, pero muchos pasos dentro de esa única tarea. Por ejemplo, imagine un conjunto de instrucciones para ensamblar un columpio infantil. En mi propia experiencia, ¡había más de 130 pasos! Eso puede resultar un poco abrumador. Un buen enfoque es agrupar pasos similares y relacionados en fases, y reiniciar la numeración de los pasos en cada nueva fase. Una fase, entonces, es 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; anclarla al suelo sería otra; ensamblar el columpio tipo caja sería otra más.
Use la orientación por tareas. Enfóquese en las tareas que sus lectores desean realizar; use formulaciones del tipo cómo hacer o con gerundio en los encabezados.
Mejor enfoque para la explicación paso a paso. Otra consideración, que quizá no pueda determinar al inicio, es cómo enfocar sus instrucciones. Para la mayoría de las instrucciones, puede enfocarse en las tareas o puede enfocarse en las herramientas (o en las características de las herramientas).
En un enfoque por tareas (también conocido como orientación por tareas) para instrucciones sobre el uso de un servicio de contestador telefónico, tendría estas secciones:
- grabar su saludo
- reproducir sus mensajes
- guardar sus mensajes
- reenviar sus mensajes
- eliminar sus mensajes, y así sucesivamente
Estas son tareas: las cosas típicas que querríamos hacer con la máquina. Para una discusión adicional, consulte el capítulo sobre análisis de tareas.
Por otro lado, en un enfoque por herramientas para instrucciones sobre el uso de una fotocopiadora, habría estas secciones poco probables:
- botón de copiar
- botón de cancelar
- botón de ampliar/reducir
- botón de intercalar/grapar
- botón de tamaño de copia, y así sucesivamente
Si diseñara un conjunto de instrucciones con este plan, escribiría pasos para usar cada botón o característica de la fotocopiadora. Las instrucciones que usan este enfoque por herramientas son difíciles de hacer funcionar. A veces, el nombre del botón no coincide del todo con la tarea a la que está asociado; a veces hay que usar más de un solo botón para lograr la tarea. Aun así, puede haber ocasiones en las que el enfoque por herramientas o características sea preferible.
Agrupaciones de tareas. Enumerar tareas puede no ser todo lo que necesita hacer. Puede haber tantas tareas que deba agruparlas para que los lectores puedan encontrar las individuales con mayor facilidad. Por ejemplo, las siguientes son agrupaciones comunes de tareas en instrucciones:
- tareas de desempaque y configuración
- tareas de instalación y personalización
- tareas básicas de operación
- tareas de mantenimiento rutinario
- tareas de solución de problemas; y así sucesivamente
Secciones comunes en las instrucciones
Lo siguiente es una revisión de las secciones que comúnmente encontrará en las instrucciones. No suponga 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 estas sean las únicas secciones posibles en un conjunto de instrucciones.
Mientras lee lo siguiente sobre las secciones comunes en las instrucciones, revise los ejemplos de instrucciones.
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 haga cualquiera de las siguientes cosas (pero no necesariamente en este orden) que se apliquen a sus instrucciones particulares:
- Indicar las tareas específicas o el procedimiento que se explicará, así como el alcance de la cobertura (lo que no se cubrirá).
- Indicar lo que la audiencia necesita en términos de conocimientos y antecedentes para comprender las instrucciones.
- Dar una idea general del procedimiento y de lo que logra.
- Indicar las condiciones en las que estas instrucciones deben (o no deben) usarse.
- Ofrecer una visión general del contenido de las instrucciones.
Consulte la sección sobre introducciones para una discusión adicional.
Avisos generales de advertencia, precaución y peligro. Las instrucciones a menudo deben alertar a los lectores sobre la posibilidad de dañar su equipo, arruinar el procedimiento o lesionarse. Además, las instrucciones suelen enfatizar puntos clave o excepciones. Para estas situaciones, se utilizan avisos especiales: avisos de nota, advertencia, precaución y peligro. Observe cómo se usan estos avisos especiales en los ejemplos de instrucciones mencionados anteriormente.
Antecedentes técnicos o teoría. Al inicio de ciertos tipos de instrucciones (después de la introducción, por supuesto), puede necesitar una discusión de antecedentes relacionada con el procedimiento. Para algunas instrucciones, estos antecedentes son fundamentales; de lo contrario, los pasos del procedimiento no tienen sentido. Por ejemplo, quizá haya tenido experiencia con esos applets de software en los que se definen colores propios ajustando barras deslizantes de rojo, verde y azul. Para entender realmente lo que está haciendo, necesita tener antecedentes sobre el color. De manera similar, puede imaginar que, para ciertas instrucciones sobre el uso de cámaras, también podría ser necesaria 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 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 normalmente se enumeran en una lista vertical simple o en una lista de dos columnas. Use la lista de dos columnas si necesita agregar especificaciones a algunos o a todos los elementos; por ejemplo, marcas, tamaños, cantidades, tipos, números de modelo, etc.
Explicación de los pasos. Cuando llega a la redacción real de los pasos, hay varias cosas que debe 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 imaginamos un conjunto de instrucciones formateado como listas verticales numeradas. Y la mayoría lo están. Normalmente, usted da formato a sus instrucciones paso a paso de esta manera. Sin embargo, existen algunas variaciones, así como otras consideraciones:
- Pasos de orden fijo son pasos que deben realizarse en el orden presentado. Por ejemplo, si está cambiando el aceite de un automóvil, drenar el aceite es un paso que debe venir antes de agregar el aceite nuevo. Estos se presentan como listas numeradas (generalmente listas verticales numeradas).
- Pasos de orden variable son pasos que pueden realizarse prácticamente en cualquier orden. Buenos ejemplos son esas guías de solución de problemas que le indican que revise esto y aquello cuando intenta arreglar algo. Puede realizar este tipo de pasos prácticamente en cualquier orden. Para este tipo, la lista con viñetas es el formato apropiado.
- Pasos alternativos son aquellos en los que se presentan dos o más formas de lograr lo mismo. Los pasos alternativos también se usan cuando pueden existir diversas condiciones. Use listas con viñetas para este tipo, con O insertado entre las alternativas, o con un enunciado introductorio que indique que se presentarán alternativas.
- Pasos anidados. En algunos casos, los pasos individuales dentro de un procedimiento pueden ser bastante complejos por sí mismos y necesitan desglosarse en subpasos. En este caso, se aplica una mayor sangría y se secuencian los subpasos como a, b, c, y así sucesivamente.
- Instrucciones "sin pasos". Y, por último, existen instrucciones que realmente no pueden usar listas verticales numeradas y que hacen poco o ningún direccionamiento directo del lector al estilo instructivo. Algunas situaciones deben ser tan generalizadas o tan variables que no se pueden establecer pasos.
Consulte el capítulo sobre listas para conocer el estilo y el formato de estas posibilidades.
Explicación complementaria. A menudo, no basta con simplemente decirles a los lectores que hagan esto o aquello. Necesitan información explicativa adicional, como cómo debería verse el objeto antes y después del paso; por qué debería importarles realizar este paso; qué principio mecánico está detrás de lo que están haciendo; incluso una explicación a un nivel más micro del paso, es decir, una discusión de las acciones específicas que componen el paso.
El problema con la explicación complementaria, sin embargo, es que puede ocultar el paso real. Usted quiere que el paso real —las acciones específicas que el lector debe realizar— destaque. No quiere que quede enterrado en un montón de palabras. Existen al menos dos técnicas para evitar este problema: puede separar la instrucción del complemento en párrafos distintos; o puede poner la instrucción en negritas.
Uso de negritas para los pasos reales del usuario en las instrucciones. El texto en negritas ayuda a distinguir la acción real de la información complementaria.
Evite la redacción telegráfica: omitir artículos “entendidos” (el, la, los, un, una). Es cierto, los robots escriben así, pero nosotros no tenemos por qué hacerlo.)
Estilo de redacción. La forma en que realmente redacta las instrucciones, oración por oración, puede parecer contradictoria con lo que le han enseñado clases de redacción anteriores. Sin embargo, observe cómo se escriben las instrucciones del “mundo real”: utilizan muchos imperativos (órdenes o tratamiento directo); usan mucho el “usted”. Eso es totalmente apropiado. Usted quiere captar de frente a su lector, obtener toda su atención. Por esa razón, las oraciones de estilo instructivo suenan así: “Ahora, presione el botón Pausa en el panel frontal para detener temporalmente la pantalla” y “Debe tener cuidado de no …”.
Un problema particular implica el uso de la voz pasiva en las instrucciones. Por alguna extraña razón, algunas instrucciones suenan así: “El botón Pausa debe ser presionado para detener temporalmente la pantalla”. No solo nos preocupa la salud mental del botón Pausa, sino que también nos preguntamos quién se supone que debe presionar la cosa (¿me está hablando a mí?). O considere este ejemplo: “Luego se ajusta el botón Temporizador a 3:00”. De nuevo, como persona que sigue estas instrucciones, podría pasar esto por alto; podría pensar que simplemente se hace 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 entonces presionar el botón Pausa”. Otra vez, ocurre el viejo doble vistazo: mira alrededor del cuarto y se pregunta: “¿Yo?”. (Para más detalle, consulte el problema de la voz pasiva).
Otro de los problemas típicos del estilo de redacción en las instrucciones es que las personas parecen querer omitir los artículos: “Presione botón Pausa en panel frontal para detener visualización de información temporalmente” o “Terrícola, proporcione dirección de la pizzería más cercana”. ¿Por qué hacemos esto? ¿Acaso todos queremos secretamente ser robots? En fin, asegúrese de incluir todos los artículos (un, una, el, la, etc.) y otras palabras similares que normalmente usaríamos en las instrucciones.
Gráficos en las instrucciones
Probablemente más que en cualquier otra forma de escritura (excepto quizá 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 la capacidad de los lectores de visualizar lo que se supone que deben hacer.
En un curso de redacción técnica, es posible que se le exija incluir ilustraciones u otros tipos de gráficos en las instrucciones, lo que normalmente se usaría en ese tipo de documentos. 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 demasiado seguro de sus habilidades artísticas. ¡Hay maneras de superar estos problemas! Consulte las sugerencias en gráficos. En ese capítulo, verá no solo sugerencias para crear gráficos, sino también requisitos sobre su formato.
Formato en las instrucciones
Encabezados. En sus instrucciones, haga buen uso de los encabezados. Normalmente, querrá encabezados para cualquier sección de antecedentes que tenga, la sección de equipo y suministros, un encabezado general para la sección de instrucciones propiamente dichas y subtítulos para las tareas o fases individuales dentro de esa sección. Observe los ejemplos al comienzo de este capítulo. Consulte encabezados para conocer los requisitos comunes.
Listas. De manera similar, las instrucciones suelen hacer un uso intensivo de las listas, en particular de las listas verticales numeradas para las explicaciones paso a paso. Las listas verticales simples o las listas de dos columnas suelen ser adecuadas para la sección de equipo y suministros. Las listas dentro de la oración son útiles siempre que se ofrezca una vista general de lo que vendrá. Consulte listas para conocer los requisitos comunes.
Avisos especiales. En las instrucciones, debe alertar a los lectores sobre posibilidades en las que puedan dañar su equipo, desperdiciar suministros, provocar que todo el procedimiento falle, o lesionarse a sí mismos u a otros, incluso de manera grave o fatal. Las empresas han sido demandadas por la falta de estos avisos especiales, por avisos especiales mal redactados o por avisos especiales colocados en lugares inapropiados. Consulte avisos especiales para una discusión completa sobre el uso adecuado de estos avisos, así como sobre su formato y colocación dentro de las instrucciones.
Números, abreviaturas y símbolos. Las instrucciones también utilizan muchos números, abreviaturas y símbolos. Consulte las pautas sobre estas áreas.
Sangría de los avisos en las instrucciones. En el primer ejemplo, observe cómo el aviso está sangrado con respecto al texto del paso precedente. En el segundo ejemplo, observe que el aviso grave se coloca al comienzo, antes de cualquiera de los pasos.
Indicaciones de IA para instrucciones
Las listas de verificación, que normalmente no se leen, pueden usarse como fuente para indicaciones de IA con algunas modificaciones. Copie lo siguiente, péguelo en un sistema de IA como Google Gemini y vea qué pudo haber pasado por alto.
Nota: Todas las referencias al contenido, formato y estilo de las cartas de solicitud o de sus componentes pueden encontrarse en el libro de texto en línea de redacción técnica.
Cuando quiera usar IA para evaluar un proyecto de redacción, preséntese, dígale a la IA quién es y qué desea. Déle a la IA un punto de referencia para realizar evaluaciones, como un libro de texto en línea. Luego publique lo que desea que la IA revise en su evaluación.
Modifique la introducción para que se ajuste a su identidad.
|
Indicaciones de IA: Instrucciones Hola, IA. Le solicito que evalúe instrucciones escritas por un estudiante universitario de segundo año en Estados Unidos. A continuación se presenta un resumen de los capítulos del libro de texto sobre instrucciones y avisos para usarlos como base de su evaluación. (Información de identificación ocultada):
|
Agradecería sus ideas, reacciones y críticas con respecto a este capítulo: su respuesta—David McMurrey.
