Saltar al contenido principal
Library homepage
 
LibreTexts Español

7.7: Instrucciones de escritura

  • Page ID
    102665
  • \( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \) \( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)\(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\) \(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\)\(\newcommand{\AA}{\unicode[.8,0]{x212B}}\)

    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 ensamblar, operar, reparar o hacer mantenimiento de rutina en algo. Aunque puedan parecer intuitivas y sencillas de escribir, las instrucciones son algunos de los documentos peor escritos que puedes encontrar. La mayoría de nosotros probablemente hemos tenido muchas experiencias exasperantes con instrucciones mal escritas. Este capítulo te mostrará lo que los profesionales consideran las mejores técnicas para brindar instrucciones.

    Un conjunto efectivo de instrucciones requiere lo siguiente:

    • Escritura clara, precisa y sencilla
    • Un profundo conocimiento del procedimiento en todos sus detalles técnicos
    • La capacidad de ponerte en el lugar del lector, la persona que intenta usar tus instrucciones
    • La capacidad de visualizar el procedimiento en detalle y captar esa conciencia en papel
    • Disposición para poner a prueba tus instrucciones sobre el tipo de persona para la que las escribiste.

    Pasos Preliminares

    Al inicio de un proyecto para escribir un conjunto de instrucciones, es importante determinar la estructura o características del procedimiento particular sobre el que vas a escribir. Estos son algunos pasos a seguir:

    1. Hacer un análisis cuidadoso de la audiencia y las tareas

    Al principio del proceso, defina la audiencia y situación de tus instrucciones. Recuerda que definir una audiencia significa definir el nivel de familiaridad que tus lectores tienen con el tema.

    2. Determinar el número de tareas

    ¿Cuántas tareas hay en el procedimiento sobre el que estás escribiendo? Usemos el término procedimiento para referirnos a todo el conjunto de actividades que pretenden discutir tus instrucciones. Una tarea es un grupo semi-independiente de acciones dentro del procedimiento: por ejemplo, poner el reloj en un horno microondas es una tarea en el gran procedimiento general de operar un horno microondas.

    Un procedimiento sencillo como cambiar el aceite en un automóvil contiene una sola tarea; no hay agrupaciones semiindependientes de actividades. Un procedimiento más complejo como usar 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 solo tienen una sola tarea, pero tienen muchos pasos dentro de esa única tarea. Por ejemplo, imagina un conjunto de instrucciones para armar un juego de columpios para niños. En mi propia experiencia, ¡hubo más de 130 pasos! Eso puede ser un poco desalentador. Un buen enfoque es agrupar pasos similares y relacionados en fases, y comenzar a renumerar 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, configurar el marco sería una fase; anclar la cosa en el suelo sería otra; ensamblar el columpio de caja sería otra más.

    3. Determinar el mejor enfoque para la discusión paso a paso

    Para la mayoría de las instrucciones, puedes enfocarte en tareas o puedes enfocarte en herramientas (o características de 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, tendría estas secciones:

    • Grabando tu saludo
    • Reproducir tus mensajes
    • Guardar tus mensajes
    • Reenvío de sus mensajes
    • Eliminar sus mensajes, y así sucesivamente

    Estas son tareas, las cosas típicas que nos gustaría hacer con la máquina.

    Por otro lado, en un enfoque de herramientas a las instrucciones sobre el uso de una fotocopiadora, probablemente habría secciones sobre cómo usar características específicas:

    • Botón Copiar
    • Botón Cancelar
    • Botón Ampliar/reducir
    • Botón de colate/grapa
    • Botón de tamaño de copia, y así sucesivamente

    Si diseñaste un conjunto de instrucciones en este plan, escribirías los pasos para usar cada botón o función 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 exactamente con la tarea a la que está asociado; a veces hay que usar algo más que un solo botón para realizar la tarea. Aún así, puede haber momentos en los que el enfoque de herramientas/características puede ser preferible.

    4. Diseñar agrupaciones de tareas

    Es posible que enumerar tareas no sea todo lo que necesitas hacer. Puede haber tantas tareas que debes agruparlas para que los lectores puedan encontrar más fácilmente las individuales. Por ejemplo, las siguientes son agrupaciones de tareas comunes en las instrucciones:

    1. Tareas de desembalaje y configuración
    2. Instalación y personalización de tareas
    3. Tareas operativas básicas
    4. Tareas de mantenimiento rutinario
    5. Tareas de solución de problemas.

    Secciones Comunes en Instrucciones

    La siguiente es una revisión de las secciones que encontrarás 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 aquí presentado, ni que estas sean las únicas secciones posibles en un conjunto de instrucciones.

    Para formatos alternativos, consulta las instrucciones de ejemplo.

    Un conjunto de instrucciones a menudo incluye lo siguiente

    Introducción: planifique cuidadosamente la introducción a sus instrucciones. Podría incluir cualquiera de los siguientes (pero no necesariamente en este orden):

    • Indicar las tareas o procedimientos específicos a explicar así como los alcances (lo que se cubrirá y no se cubrirá)
    • Indicar lo que el público necesita en términos de conocimiento y antecedentes para entender las instrucciones
    • Dar una idea general del procedimiento y lo que logra
    • Indicar las condiciones en las que estas instrucciones deben (o no deben) ser utilizadas
    • 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, arruinar el procedimiento y lastimarse. Además, las instrucciones a menudo deben enfatizar puntos clave o excepciones. Para estas situaciones, usa avisos especiales —nota, advertencia, precaución y avisos de peligro. Observe cómo se utilizan estos avisos especiales en las instrucciones de ejemplo enumeradas anteriormente.

    Antecedentes técnicos o teoría: al inicio de ciertos tipos de instrucciones (después de la introducción), es posible que necesite una discusión de antecedentes relacionados con el procedimiento. Para ciertas instrucciones, este trasfondo es crítico; de lo contrario, los pasos en el procedimiento no tienen sentido. Por ejemplo, es posible que haya tenido alguna experiencia con esos applets de software en los que define sus propios colores empujando barras deslizantes rojas, verdes y azules alrededor. Para entender realmente lo que estás haciendo, necesitas tener algo de fondo sobre el color. Del mismo modo, se puede imaginar que, para ciertas instrucciones usando cámaras, también podría ser necesaria alguna 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, sartenes para pan, martillos, taladros y sierras) y 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 algunas especificaciones a algunos o a todos los artículos, por ejemplo, nombres de marca, tamaños, cantidades, tipos, números de modelo, etc.

    Discusión de los pasos: al llegar 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) información complementaria que podría ser necesaria, y (3) el punto de vista y estilo general de escritura.

    Estructura y formato: normalmente, imaginamos un conjunto de instrucciones como formateadas como listas numeradas verticales. Y la mayoría lo son de hecho. Normalmente, formateas tus instrucciones paso a paso reales de esta manera. Hay algunas variaciones, sin embargo, así como algunas otras consideraciones:

    • Los pasos de orden fijo son pasos que deben realizarse en el orden presentado. Por ejemplo, si estás cambiando el aceite en un auto, drenar el aceite es un paso que debe llegar antes de poner el aceite nuevo. Estas son listas numeradas (generalmente, listas numeradas verticales).
    • Los pasos de orden variable son pasos que se pueden realizar en prácticamente cualquier orden. Buenos ejemplos son esas guías de solución de problemas que te dicen que compruebes esto, comprueba que donde intentas 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 alternos son aquellos en los que se presentan dos o más formas de lograr lo mismo. También se utilizan pasos alternativos cuando pueden existir diversas condiciones. Use 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 presentarse.
    • Los pasos anidados se pueden usar en los casos en que los pasos individuales dentro de un procedimiento son bastante complejos por derecho propio y necesitan dividirse en subpasos. En este caso, se sangra más y se secuencian los subpasos como a, b, c, y así sucesivamente.
    • Instrucciones “sin paso”. se pueden usar cuando realmente no se puede usar la lista vertical numerada o proporcionar una dirección sencilla de estilo instructivo del lector. Algunas situaciones deben ser tan generalizadas o tan variables que no se puedan afirmar pasos.

    Discusión suplementaria: muchas veces, no basta simplemente con decirle a los lectores que hagan esto o que hagan eso. Necesitan información explicativa adicional como cómo debe verse la cosa antes y después del paso; por qué deberían importarles hacer este paso; qué principio mecánico hay detrás de lo que están haciendo; aún más explicación a nivel micro del paso: discusión de las acciones específicas que conforman el paso.

    El problema con la discusión suplementaria, sin embargo, es que puede ocultar el paso real. Se quiere que el paso real —las acciones específicas que el lector va a tomar— se destaque. No quieres que todo esté enterrado en un montón de palabras. Existen al menos dos técnicas para evitar este problema: puedes dividir la instrucción del suplemento en párrafos separados; o puedes 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 necesita hacer. A menudo, el verbo comando está en negrita; a veces la fuente en negrita resalta el componente clave que se

    El uso de la voz pasiva en las instrucciones puede ser problemático. Por alguna extraña razón, algunas instrucciones suenan así: “Se debe presionar el botón Pausa para detener temporalmente la pantalla”. No sólo nos preocupa la salud mental del botón de pausa, sino que nos preguntamos quién se supone que deprime la cosa (¿ninjas?). Sería más útil indicar cuándo el lector debe “presionar el botón Pausa”. Considera este ejemplo: “El botón Timer se establece entonces en 3:00”. De nuevo, uno podría preguntarse, “¿está fijado por quién? ¿Ninjas?” La persona que sigue estas instrucciones podría pensar que es simplemente una referencia a algún estado existente, o podría preguntarse: “¿Me están hablando?” El uso de la tercera persona también puede generar torpeza: “El usuario debe entonces presionar el botón Pausa”. Por lo general, las instrucciones deben escribirse usando formas verbales de comando y usando “usted” para dejar perfectamente claro lo que debe hacer el lector.

    Ilustrando sus instrucciones

    Quizás 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 críticas para la capacidad de los lectores de visualizar lo que se supone que deben hacer. Asegúrese de que los gráficos representan la imagen desde la perspectiva del lector.

    Formateo de sus instrucciones

    Dado que las personas rara vez quieren leer instrucciones, pero a menudo tienen que hacerlo, formatee sus instrucciones para una legibilidad reacia. Intenta que tu lector quiera leerlos, o al menos no se resiste a la idea de consultarlos. El formato altamente legible permitirá a los lectores que hayan descubierto algunas de las instrucciones por su cuenta saltar a la sección donde están atrapados. Usa lo que has aprendido sobre encabezados, listas, imágenes y espacio pasivo para crear instrucciones efectivas y legibles:

    Encabezados: normalmente, querrás encabezados para cualquier sección de antecedentes que puedas tener, la sección de equipos y suministros, un encabezado general para la sección de instrucciones reales y subtítulos para las tareas individuales o fases dentro de esa sección.

    Listas: de manera similar, las instrucciones suelen hacer un uso extensivo de listas, particularmente listas verticales numeradas para las explicaciones reales paso a paso. Las listas verticales simples o las listas de dos columnas suelen ser buenas para la sección de equipos y suministros. Las listas en oración son buenas cada vez que das una visión general de las cosas por venir.

    Avisos especiales: es posible que tenga que alertar a los lectores sobre las posibilidades en las que puedan dañar sus equipos, desechos, hacer que falle todo el procedimiento, lesionarse a sí mismos u otros, incluso de gravedad o muerte. Las empresas han sido demandadas por falta de estos avisos especiales, por avisos especiales mal escritos, o por avisos especiales que estaban fuera de lugar. Consulte los avisos especiales para una discusión completa sobre el uso adecuado de estos avisos especiales, así como su formato y ubicación dentro de las instrucciones.

    Lista de verificación de revisión para instrucciones escritas

    Al releer y revisar sus instrucciones, verifique que hagan lo siguiente:

    • Describa claramente el procedimiento exacto a explicar
    • Proporcionar una visión general del contenido
    • Indicar requisitos de audiencia
    • Use varios tipos de listas cuando sea apropiado; en particular, use listas numeradas para pasos secuenciales
    • Usar encabezados y subencabezados para dividir las secciones principales y subsecciones en un orden lógico y coherente
    • Usar avisos especiales según corresponda
    • Usar gráficos para ilustrar acciones y objetos clave
    • Proporcionar una explicación complementaria adicional de los pasos necesarios
    • Cree una sección con el listado de equipos y suministros si es necesario.

    Este capítulo fue adaptado de Redacción Técnica en Línea por David McMurrey, que está bajo una Licencia Creative Commons Attribution 4.0 Internacional.

    This page titled 7.7: Instrucciones de escritura is shared under a not declared license and was authored, remixed, and/or curated by Suzan Last (BC Campus) .