Los avisos especiales son una característica importante de la redacción técnica profesional: destacan información importante que los lectores necesitan saber para comprender lo que están leyendo, para llevar a cabo lo que desean hacer, para prevenir daños al equipo y para evitar hacerse daño a sí mismos o a otras personas.
Avisos muy especiales. Avisos de última generación con comentarios ingeniosos.
Directrices para tipos específicos de avisos
Este capítulo presenta un estilo específico de avisos. Tenga muy en cuenta que existen otros estilos y formatos.
- Utilice avisos especiales para enfatizar puntos clave o para advertir o poner en guardia a los lectores sobre daños o lesiones.
- Tenga cuidado de usar los tipos de avisos especiales con precisión, para sus propósitos definidos. Use los cuatro tipos de avisos especiales de las siguientes maneras:
Nota—Para enfatizar puntos o recordatorios, o para indicar problemas menores en un procedimiento.
Precaución—Para advertir a los lectores acerca de posibles daños al equipo o a los datos, de posibles problemas en el resultado de lo que están haciendo, o de posibles experiencias negativas (como la vergüenza).
Advertencia—Advertir a los lectores sobre la posibilidad de lesiones menores para ellos mismos o para otras personas.
Peligro—Advertir a los lectores sobre la posibilidad de lesiones graves o mortales para ellos mismos o para otras personas.
Nota: Echa un vistazo alrededor de tu garaje o de tu cocina y fíjate en los avisos especiales que aparecen en los productos. Verás mucha variación, que probablemente depende de normas específicas de la industria o normas corporativas.
Decidir qué tipo de aviso usar no es una ciencia exacta. Simplemente no uses un aviso de peligro cuando un aviso de advertencia sea más apropiado (lo mismo que "dar la falsa alarma"). Además, usa los avisos de manera coherente en todo el documento. Haz no crea tus propios avisos, por ejemplo poniendo "Importante:" en lugar de "Advertencia."
- Coloque avisos especiales en el punto del texto donde se necesiten. Por ejemplo, coloque un aviso de precaución o de peligro. justo antes o justo después discutiendo un paso en el que los lectores podrían hacerse daño.
- Evite tener demasiados avisos especiales en un mismo punto del texto. De lo contrario, la eficacia de su formato especial se perderá. (Si tiene demasiados, combínelos.)
- Con advertencias, precauciones y avisos de peligro, explique las consecuencias de no prestar atención al aviso. Indique qué sucederá si el lector no hace caso al aviso.
- Los ejemplos en esta sección usan negrita. Evite el uso de mayúsculas para el texto de cualquier aviso especial.
Nota: En un área de publicación debidamente configurada, los redactores técnicos no tendrían que decidir qué tipo de aviso usar ni siquiera redactar el texto del aviso. Eso debería ser tarea de los abogados de la organización. Aun así, esos abogados podrían estar demasiado ocupados para revisar sus avisos, por lo que la carga podría seguir recayendo en usted, el redactor técnico o editor.
Formato para Avisos Especiales
Utilice lo siguiente para detalles específicos sobre el uso de mayúsculas, la tipografía (negrita, subrayado, diferentes fuentes, distintos tamaños de letra) y el espaciado para cada tipo de aviso especial.
Nota
Utilice el siguiente formato para notas simples:
- Escriba la etiqueta "Nota" seguida de dos puntos. (Aunque algunos de los siguientes ejemplos usan negrita, prefiera la cursiva para evitar confusión visual con los encabezados.)
- Comience a escribir el texto de la nota un espacio después de los dos puntos. (Pero no ponga el texto de la nota en negrita ni en cursiva.)
- Usar interlineado sencillo dentro del texto de la nota; dejar una línea en blanco por encima y por debajo de la nota.
- Comience las líneas de continuación en el margen izquierdo habitual.
- Alinee la nota con el texto al que se refiere (como se ilustra en el segundo ejemplo).
Ejemplo de una nota sencilla
Ejemplo de una nota dentro de una lista con viñetas (no texto corriente). Este mismo principio (que los avisos especiales se alinean con el texto al que hacen referencia) se aplica también a los demás tipos de avisos especiales.
Notas
Utilice el siguiente formato para múltiples notas:
- Use este formato cuando tenga tantas notas que sería una distracción presentarlas individualmente.
- Escriba la etiqueta "Notas" seguida de dos puntos. (Aunque algunos de los siguientes ejemplos usan negrita, prefiera la cursiva para evitar confusión visual con los encabezados.)
- 1. Utilice una lista numerada para las notas individuales; en ella, siga las reglas para las listas numeradas. 2. (No utilice negritas ni cursivas para las notas individuales.)
- Alinee las notas con el texto al que se refieren; omita el equivalente de una línea por encima y por debajo de las notas.
Ejemplo de una nota múltiple. Usa este formato si tienes muchas notas y quieres recopilarlas todas en un solo lugar para evitar distracciones.
Precaución
Utilice el siguiente formato para los avisos de precaución:
- Escribe la etiqueta "Precaución", síguela con dos puntos y pon en negrita tanto la etiqueta como los dos puntos.
- Deje una línea en blanco y comience el texto de la precaución alineado con el inicio de la etiqueta de precaución.
- Ponga el texto de la advertencia con interlineado sencillo; deje una línea en blanco por encima y por debajo del aviso.
- Alinee el aviso de precaución con el texto al que se refiere (en lo anterior, el aviso de advertencia aparece dentro de una lista numerada y tiene la sangría correspondiente).
Ejemplo de un aviso de precaución. Utilice este para alertar a los lectores sobre posibles daños al equipo o problemas con el procedimiento.
Advertencia
Utilice el siguiente formato para las advertencias:
- Escribe la etiqueta "Advertencia,", ponla en cursiva y síguela con dos puntos.
- O bien presione la tecla Tab hasta el inicio del texto de la advertencia, o utilice el formato de sangría francesa (que es mucho mejor). El formato de sangría francesa para la advertencia en el ejemplo siguiente utiliza 0,63 pulgadas tanto para la tabulación como para la sangría francesa, pero el tamaño de la fuente hará que este valor varíe.
Nota: Ver Crear una sangría francesa para un vídeo sobre cómo crear el formato de sangría francesa en Microsoft Word.
- Use la tipografía normal del cuerpo para el texto del aviso de advertencia (sin negrita, sin cursiva, sin todo en mayúsculas, sin color).
- Alinee el aviso de advertencia con el texto al que se refiere.
- Omite el equivalente a una línea por encima y una línea por debajo del aviso de advertencia.
Ejemplo de un aviso de advertencia.. Utilice este para alertar a los lectores sobre la posibilidad de lesiones menores.
Peligro
Utilice el siguiente formato para los avisos de peligro:
- Escribe la etiqueta "DANGER" en negrita y en mayúsculas.
- Alinee el aviso de peligro con el texto al que se refiere.
- Ponga interlineado sencillo en el texto del aviso de peligro; deje una línea en blanco antes y otra después del aviso de peligro.
- Usa negrita en el texto del aviso de peligro si lo tienes (pero nunca todo en mayúsculas).
- Si tiene capacidad gráfica, dibuje un recuadro alrededor del aviso de peligro (incluida la etiqueta).
Aviso de peligro. Utilice este para alertar a los lectores sobre la posibilidad de lesiones graves o de muerte.
Imágenes de aviso (Iconos)
Por favor, vea imágenes de avisos comunes.
Otros problemas de formato
Aquí hay algunos puntos adicionales a considerar con respecto a los avisos especiales:
Alineación especial. Los avisos especiales deben alinearse con el texto al que se refieren. Por ejemplo, si tiene una nota que añade algún detalle especial a algo en un elemento de lista con viñetas, debe alinear esa nota con el texto Del elemento con viñeta. Por supuesto, si la nota sigue a una lista con viñetas pero se refiere a la lista completa, entonces puede usar el margen izquierdo normal.
Texto con interlineado sencillo. Todos los ejemplos y la discusión en esta unidad se basan en texto con espaciado sencillo. Deje una línea en blanco entre el texto corriente y los avisos especiales—según lo que le parezca mejor. (Y, por supuesto, tanto el texto corriente como el texto de los avisos especiales estarán con un solo espacio entre líneas.)
Colocación de avisos especiales. Coloque avisos especiales justo antes o justo después el punto en el que son relevantes. Por ejemplo, puedes advertir a los lectores que hagan una copia de seguridad de todos los datos antes Les dices que reformateen su disco duro. Sin embargo, en la práctica, los avisos especiales importantes se colocan al principio de un procedimiento en el que es probable que ocurra un daño grave a los datos, al equipo o a las personas.
Una técnica utilizada por escritores muy cautelosos (quizá aquellos que han tenido malas experiencias) es colocar todos los avisos serios (advertencias, precauciones y peligros) en algún lugar al principio del documento, y luego repetirlos individualmente donde correspondan. Es probable que una organización tenga una guía de estilo que establezca requisitos sobre la colocación de los avisos.
Tabla de significados de avisos especiales. Los manuales de usuario suelen incluir un cuadro con los significados de los distintos tipos de avisos en el prefacio, como se ilustra parcialmente en la parte inferior de esta figura. Nótese que en este ejemplo no hay un tipo de aviso de precaución, simplemente para ilustrar cómo los avisos varían entre industrias:
Gráfico de avisos. Observe que en este ejemplo no existe ningún tipo de aviso de precaución, lo que ilustra cómo varían los avisos entre industrias.
Múltiples avisos especiales. Te encuentras con situaciones en las que tienes tres o cuatro avisos especiales, todos apiñados en la misma parte del texto, uno tras otro. Esto es un problema porque se pierde todo el propósito del formato especial de los avisos: algo es especial porque es distinto de lo que lo rodea. La solución a este problema es crear un único encabezado identificador (por ejemplo, "Notas y Advertencias") y luego listar los avisos (ya sea con viñetas o numerados) debajo.
Información relacionada
Definiciones ANSI para señales de peligro, advertencia, precaución o aviso. Incluye imágenes descargables.
1910.145 - Especificaciones para señales y etiquetas de prevención de accidentes. Administración de Seguridad y Salud Ocupacional (OSHA)
Categorías de señales de seguridad OSHA (50487). Muchas imágenes descargables.
¿Qué significan los diferentes colores de las señales de seguridad?. incluye imágenes descargables. Creative Safty Supply
Agradecería sus pensamientos, reacciones y críticas con respecto a este capítulo: tu respuesta—David McMurrey.
