Por favor, haga clic aquí para ayudar a David McMurrey a pagar el alojamiento web: ¡done la cantidad que pueda!
La Redacción Técnica en Línea seguirá siendo gratuita.
El enfoque de este capítulo es uno de los usos más importantes de la redacción técnica: las instrucciones. Como ya sabe, las instrucciones son explicaciones paso a paso de cómo hacer algo: cómo construir, operar, reparar o dar mantenimiento a objetos.
Asegúrese de revisar los ejemplos.
¿Está escribiendo 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 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 mantenimiento rutinario. Pero para algo que parece tan fácil e intuitivo, las instrucciones son algunos de los documentos peor redactados que existen. Al igual que yo, probablemente haya tenido muchas experiencias frustrantes con instrucciones mal escritas. Lo que sigue en este capítulo no pretende ser una guía infalible para redactar 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 profunda del procedimiento en todos sus detalles técnicos
- La capacidad de ponerse en el lugar del lector, la persona que intenta usar sus instrucciones
- La capacidad de visualizar el procedimiento con gran detalle y plasmar esa comprensión por escrito
- Finalmente, la disposición de ir un paso más allá y probar sus instrucciones con el tipo de persona para quien fueron escritas
A estas alturas, probablemente ya haya estudiado encabezados, listas y avisos especiales; escribir un conjunto de instrucciones con estas herramientas seguramente parece obvio. Simplemente divida el análisis en listas numeradas verticales 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 de este capítulo generada por NotebookLM
- 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
A continuación se presenta un repaso de las secciones que normalmente encontrará en las instrucciones. No suponga que cada una de ellas debe estar en las instrucciones reales que usted escriba, ni que tienen que aparecer en el orden que se presenta aquí, ni que estas sean las únicas secciones posibles en un conjunto de instrucciones.
Mientras lee lo siguiente sobre 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 del contenido y la organización—son posibles muchos otros.
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:
- Indique las tareas o el procedimiento específicos que se explicarán, así como el alcance de la cobertura (lo que no se cubrirá).
- Indique lo que la audiencia necesita en términos de conocimientos y antecedentes para comprender las instrucciones.
- Dé una idea general del procedimiento y de lo que logra.
- Indique las condiciones en las que estas instrucciones deben (o no deben) usarse.
- Ofrezca una visión general del contenido de las instrucciones.
Vea la sección sobre introducciones para una discusión más detallada.
Avisos generales de advertencia, precaución y peligro. Las instrucciones a menudo deben alertar a los lectores sobre la posibilidad de arruinar su equipo, estropear el procedimiento y lastimarse. Además, las instrucciones a menudo deben 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 las instrucciones de ejemplo mencionadas arriba.
Antecedentes técnicos o teoría. Al comienzo 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 ciertas instrucciones, estos antecedentes son críticos—de lo contrario, los pasos del procedimiento no tienen sentido. Por ejemplo, quizá haya tenido experiencia con aquellos applets de software en los que usted define sus propios colores moviendo barras deslizantes de rojo, verde y azul. Para entender realmente lo que está haciendo, necesita algunos antecedentes sobre el color. De manera similar, puede imaginar que, para ciertas instrucciones que usan cámaras, también podría necesitarse 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 usa 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, por lo general 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 artículos—por ejemplo, marcas, tamaños, cantidades, tipos, números de modelo, etc.
Discusión de los pasos. Cuando llegue a la redacción de los pasos, hay varias cosas que debe tener en cuenta: (1) la estructura y el formato de esos pasos, (2) la información suplementaria que pueda necesitarse y (3) el punto de vista y el estilo general de redacción.
Estructura y formato. Normalmente imaginamos un conjunto de instrucciones con el formato de listas verticales numeradas. Y la mayoría, de hecho, lo están. Normalmente, usted formatea sus instrucciones paso a paso de esta manera. Sin embargo, hay 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 poner el aceite nuevo. Estos se presentan como listas numeradas (por lo general, listas verticales numeradas).
- Pasos de orden variable son pasos que pueden realizarse prácticamente en cualquier orden. Un buen ejemplo son las guías de solución de problemas que le dicen que revise esto, revise aquello cuando intenta arreglar algo. Usted puede hacer estos pasos prácticamente en cualquier orden. En este tipo, el formato apropiado es la lista con viñetas.
- 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 OR insertado entre las alternativas, o con una frase de introducción 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, usted aumenta la sangría y secuencia los subpasos como a, b, c, y así sucesivamente.
- Instrucciones “sin pasos”. Y finalmente existen instrucciones que realmente no pueden usar listas verticales numeradas y que hacen poco, si es que hacen algo, de dirección directa al lector al estilo de instrucciones. Algunas situaciones deben ser tan generalizadas o tan variables que no se pueden declarar pasos.
Vea el capítulo sobre listas para el estilo y formato de estas posibilidades.
Discusión suplementaria. A menudo, no basta con decirle a los lectores que hagan esto o aquello. Necesitan información explicativa adicional, como cómo debería verse algo antes y después del paso; por qué debería importarles hacer ese paso; qué principio mecánico hay detrás de lo que hacen; incluso una explicación más micro del paso—una 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 quede enterrado en un montón de palabras. Hay al menos dos técnicas para evitar este problema: puede separar la instrucción del suplemento en párrafos separados; o puede poner la instrucción en negritas.
Poner en negritas los pasos reales del usuario en las instrucciones. El texto en negrita ayuda a distinguir la acción real de la información suplementaria.
Estilo de redacción. La manera en que usted realmente escribe instrucciones, frase por frase, puede parecer contradictoria con lo que le han enseñado clases previas de redacción. Sin embargo, observe cómo se escriben las instrucciones del “mundo real”—usan mucho el modo imperativo (orden, o dirigirse directamente al lector); usan mucho “usted.” Eso es totalmente apropiado. Usted quiere captar la atención completa del lector. Por esa razón, las oraciones de estilo instructivo suenan así: “Ahora, presione el botón Pause en el panel frontal para detener la pantalla temporalmente” y “Debe tener cuidado de no...”
Un problema particular implica el uso de la voz pasiva en las instrucciones. Por alguna razón extraña, algunas instrucciones suenan así: “El botón Pause debe ser presionado para detener la pantalla temporalmente.” No solo nos preocupa la salud mental del botón Pause, sino que nos preguntamos quién se supone que debe presionar la cosa (¿me está hablando a mí?). O considere este ejemplo: “El botón Timer se ajusta entonces a 3:00.” De nuevo, como persona que sigue estas instrucciones, puede pasar por alto esto; puede pensar que es solo una referencia a algún estado existente, o puede preguntarse: “¿Me están hablando?” Casi igual de malo es usar la tercera persona: “El usuario debe entonces presionar el botón Pause.” Otra vez, la típica doble mirada: usted mira alrededor y se pregunta: “¿Yo?” (Para más detalle, vea el problema de la voz pasiva.)
Otro de los problemas típicos con el estilo de redacción en instrucciones es que la gente parece querer dejar fuera los artículos: “Presione Pause button on front panel to stop display of information temporarily” o “Earthperson, please provide address of nearest pizza restaurant.” ¿Por qué hacemos esto? ¿Todos queremos secretamente ser robots? En fin, asegúrese de incluir todos los artículos (a, an, the) y otras palabras similares que normalmente usaríamos en 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 en 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 se supone que deben hacer.
En un curso de redacción técnica, las instrucciones pueden requerir que incluya ilustraciones u otros tipos de gráficos—lo que normalmente se usaría en esas instrucciones. El problema, por supuesto, puede ser que no tenga acceso a gráficos adecuados para sus instrucciones particulares y que no se sienta muy confiado en sus habilidades artísticas. ¡Hay maneras de superar estos problemas! Revise 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 dicha, y subencabezados para las tareas o fases individuales dentro de esa sección. Revise los ejemplos al comienzo de este capítulo. Vea encabezados para requisitos comunes.
Listas. De manera similar, las instrucciones normalmente hacen uso intensivo de listas, en particular listas verticales numeradas para las explicaciones paso a paso. Las listas verticales simples o las listas de dos columnas suelen ser buenas para la sección de equipo y suministros. Las listas dentro de la oración son útiles cuando usted da una visión general de lo que viene. Vea listas para requisitos comunes.
Avisos especiales. En las instrucciones, debe alertar a los lectores sobre posibilidades en las que pueden dañar su equipo, desperdiciar suministros, hacer que todo el procedimiento falle, o lastimarse a sí mismos o a otros—incluso de manera grave o fatal. Se ha demandado a compañías por la falta de estos avisos especiales, por avisos mal redactados o por avisos fuera de lugar. Vea avisos especiales para una discusión completa del uso correcto de estos avisos, así como de su formato y ubicación dentro de las instrucciones.
Números, abreviaturas y símbolos. Las instrucciones también usan muchos números, abreviaturas y símbolos. Vea las pautas para estas áreas.
Sangría de avisos en las instrucciones. En el primer ejemplo, observe cómo el aviso está sangrado al texto del paso anterior. En el segundo ejemplo, observe que el aviso severo se coloca al principio, antes de cualquiera de los pasos.
Prompts de IA para instrucciones
Las listas de verificación, que por lo general nadie lee, pueden usarse como fuente para prompts de IA con algunas modificaciones. Copie lo siguiente, péguelo en un sistema de IA como Gemini de Google, 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 se pueden encontrar en el libro de texto en línea de redacción técnica.
Cuando quiera usar IA para evaluar un proyecto de escritura, preséntese, diga a la IA quién es y qué quiere. Dé a la IA un punto de referencia para hacer evaluaciones, como un libro de texto en línea. Luego publique lo que quiere que la IA revise en su evaluación.
Modifique la introducción para que se ajuste a su identidad.
|
Prompts de IA para instrucciones Hola, IA. Le solicito que evalúe instrucciones escritas por un estudiante universitario de segundo año en EE. UU. A continuación se presenta un resumen de capítulos del libro de texto sobre instrucciones y avisos para usarlos como base de su evaluación. (Información identificatoria ocultada):
|
Información relacionada
¿Cómo puedo crear manuales de instrucciones eficaces?
El costo oculto de “es tan intuitivo que no necesita un manual”
¿Contribuyen los manuales de operación al desempeño empresarial?
Agradecería sus ideas, reacciones y críticas respecto a este capítulo: su respuesta—David McMurrey.
