???

Resaltando, según se usa el término aquí, es el uso de efectos tipográficos para llamar la atención sobre el texto. Estos efectos pueden incluir cursiva, negrita, todo en mayúsculas, comillas, color, y así sucesivamente. Resaltar llama la atención de los lectores—o los "señala"—hacia acciones que deben tomar o hacia información que deben considerar cuidadosamente.

Uno de los problemas en la redacción técnica—en particular, la redacción técnica sobre ordenadores—implica el uso de las diversas técnicas de énfasis. Desafortunadamente, algunos textos técnicos se exceden en el uso de las diversas técnicas de énfasis que se discuten aquí.

Fundamentos del resaltado

Considere algunos principios fundamentales de énfasis:

Prácticamente cualquier efecto textual especial que sea distinto del texto principal habitual puede funcionar como una técnica de énfasis. Cosas como la cursiva, la negrita, los subrayados, las mayúsculas, los diferentes tamaños de letra, las fuentes alternativas, el color y los distintos ingenios gráficos (sombreado, color invertido, fuentes con contorno) pueden actuar como técnicas de énfasis.
Si se usa en exceso, cualquier técnica de énfasis o combinación de técnicas de énfasis puede perder su capacidad de enfatizar y volverse recargada y distractora. Si se usa en exceso, cualquier técnica de énfasis o combinación de técnicas de énfasis puede provocar que los lectores se muestren reacios a leer un texto, o incluso que lo eviten por completo. Fíjate en lo ilegible que resulta la versión excesivamente resaltada del aviso en esto ventana emergente; también observe que no utiliza el tipo de aviso recomendado en avisos.

Cuando sea necesario enfatizar texto extenso, use el formato de aviso especial (en lugar de crear párrafos totalmente en negrita o en MAYÚSCULAS, por ejemplo).
Debe existir una relación funcional cuidadosamente planificada entre el texto que se enfatiza y la técnica de énfasis que se utiliza.
Las técnicas de énfasis deben emplearse de manera consistente para evitar que los lectores se confundan.
Para promover la coherencia, debe usar una guía de estilo o una hoja de estilo, que registre y luego dicte todas sus decisiones sobre cómo va a utilizar las técnicas de énfasis.
Para ayudar a sus lectores a entender su esquema de resaltado, puede incluir una breve sección en alguna parte de su documento (por lo general en el prefacio) que explique cómo va a emplear las técnicas de énfasis.

En la siguiente discusión, notará que cualquier sistema de técnicas de énfasis puede volverse bastante complicado y difícil de recordar para escritores y editores. Notará que hay muchas maneras igualmente válidas de usar técnicas de énfasis: por ejemplo, en algunos casos es arbitrario si se usa negrita o cursiva para un énfasis simple. Para abordar este problema, debe documentar sus pautas de resaltado en una guía de estilo a la que los escritores y editores (o simplemente usted) puedan referirse. Una guía de estilo es simplemente un registro de las decisiones que usted y su equipo de documentación han tomado sobre cómo quieren que se vean sus documentos.

Sus lectores también deben ser informados sobre el esquema de resaltado que planea utilizar. Esto puede tratarse en el prefacio: incluya una sección llamada "Resaltado" o "Convenciones tipográficas" donde indique cómo utiliza la cursiva, la negrita, las tipografías y otros efectos semejantes. Por ejemplo, consulte la discusión de los prefacios en el capítulo sobre componentes estándar de libros técnicos

Técnicas específicas de énfasis

La siguiente sección repasa una por una las diversas técnicas de énfasis, explicando las prácticas comunes.

Nota: Para mantener las cosas simples, destacar los problemas para mesas, figuras, encabezados, listas, y avisos se presentan en esas secciones.

Negrita

En la publicación, y en particular en la publicación técnica, el uso es mixto respecto a si se debe usar negrita o cursiva para el énfasis básico. Por ejemplo, si quieres enfatizar que los lectores no deben apagar la computadora sin antes realizar el apagado adecuado, la palabra «no» puede ir en negrita o en cursiva. Tradicionalmente se ha empleado la cursiva, pero, quizá por las computadoras, la negrita también se usa comúnmente.

Cualquiera que sea la técnica que utilices, úsala de forma consistente a lo largo de tu texto o de una colección de textos relacionados. Por cierto, es poco probable que los lectores puedan distinguir entre distintos niveles de énfasis: por ejemplo, usar cursiva para texto importante y negrita para texto muy importante probablemente pase desapercibido para la mayoría de los lectores.

Si te sientes tentado a poner todo un párrafo en negrita, recuerda uno de los principios de énfasis discutidos arriba: usar en exceso una técnica de énfasis hace que el efecto de la técnica se pierda. No solo eso, sino que el exceso de énfasis hace que los lectores estén menos inclinados a leer. En lugar de leer detenidamente un párrafo completamente en negrita, ¡los lectores pueden simplemente ignorarlo por completo!

En lugar de crear un párrafo completamente en negrita, usa el formato de aviso especial. En él, una palabra clave (por ejemplo, Importante, Nota, Peligro, Precaución, Advertencia) está en negrita, mientras que el resto del texto se deja en estilo romano normal (es decir, la misma fuente y estilo que el texto del cuerpo regular).

El uso legítimo de la negrita en textos técnicos varía considerablemente. Siempre que desarrolle un esquema que esté directamente relacionado con la necesidad del lector y con las características del texto (o de la tecnología) y que no conduzca al exceso, su uso de la negrita debería funcionar bien.

Aquí hay algunos usos comunes y estándar de la negrita:

Énfasis simple. Como se discutió anteriormente, algunos textos técnicos usan la negrita para un énfasis simple en lugar de la cursiva tradicional. Por ejemplo, "Haz no Apaga el ordenador antes de apagarlo.
Comandos. Los textos informáticos suelen usar negrita para los comandos, por ejemplo, "Utilice el mover comando para renombrar archivos UNIX." Vea la sección sobre el resaltado de texto informático para revisar el conjunto completo de técnicas de énfasis.
Botones que inician comandos. En una interfaz gráfica de usuario, algunos de los botones inician comandos. Por ejemplo, "pulse el" Salir botón para salir de la aplicación."
Etiquetas de campo. Aunque algunos textos informáticos ponen en negrita las etiquetas de los campos, no es una práctica general porque provoca un resaltado excesivo. Por ejemplo, " Sangría área del cuadro de diálogo, haga clic en Izquierda." Más común es usar el estilo de mayúsculas que se emplea en la pantalla. Es preferible escribir esto: "En el área de Sangría del cuadro de diálogo, haga clic en Izquierda."
Iconos, teclado o botones del ratón. Si bien no se observa de manera universal, otra técnica de resaltado que sigue lógicamente este sistema es poner en negrita el nombre de una tecla del teclado o de un botón del ratón. Por ejemplo, "Presiona la cu clave o el izquierda botón del ratón." En consonancia con este sistema, también se usa la negrita en los iconos: "Haga clic en el Comenzar icono."
Etiquetas en el hardware. Otra práctica que es común en la publicación informática es poner en negrita el nombre de una etiqueta de hardware. Por ejemplo, "Presione el Restablecer botón para reiniciar el ordenador.

Notará que la discusión anterior no estableció reglas absolutas. Así es—la práctica de la publicación técnica es bastante variada. La idea principal es desarrollar un sistema de resaltado lógico y controlado, utilizarlo de manera consistente y documentarlo en una guía de estilo para que usted y los miembros de su equipo de documentación puedan consultarlo.

Cursiva

Aquí hay algunos de los usos estándar de la cursiva:

Énfasis simple. Como se mencionó anteriormente, el uso es mixto en cuanto a si se debe usar negrita o cursiva para un énfasis simple, aunque la cursiva ha sido la tradicional: por ejemplo, "Haz no Apaga el ordenador antes de apagarlo. Sea cual sea el que uses, sé coherente con él y documéntalo en tu guía de estilo o hoja de estilo para que todo el equipo de documentación pueda verlo. Si no estás seguro de cuál usar, usa cursiva para un énfasis sencillo: queda menos recargado.
Variables . En la publicación informática, uno de los usos más comunes de la cursiva es para las variables. Por ejemplo:

copiar archivo antiguo archivo nuevo

Los usuarios saben que no deben teclear archivo antiguo o nuevo archivo pero para sustituir sus propios nombres de archivo en su lugar.
Definiciones en listas de definición (de dos columnas). Mientras que la negrita es más común para los elementos en la columna izquierda de una lista de dos columnas, también se usa la cursiva. (Véase la discusión sobre las listas de dos columnas en la sección anterior sobre la negrita.)
Términos en los que se define el término. Un buen detalle es poner en cursiva una palabra cuando se define en el cuerpo del texto.

Guiones bajos

Casi no hay razón para usar guiones bajos en el texto técnico. En la época de los textos mecanografiados, sin duda la había. Sin embargo, en estos tiempos, cuando la negrita, la cursiva y otros efectos tipográficos están fácilmente disponibles, los guiones bajos parecen obsoletos. Si desea enfatizar algo, utilice sus directrices estándar—por ejemplo, utilice cursiva o negrita. No intente crear gradaciones de énfasis: por ejemplo, una escala de importancia creciente que vaya de la cursiva a la negrita y al guion bajo se les pasará desapercibida a sus lectores.

Si ves un buen uso de los guiones bajos en texto técnico, probablemente se dé en el diseño de encabezados.

Capitalización

En la publicación técnica, parece haber una batalla continua entre los redactores técnicos y los expertos técnicos sobre el uso de mayúsculas. Los expertos técnicos tienden a usar mayúscula inicial para prácticamente cada componente y proceso de un sistema. Además, los expertos técnicos (y la dirección) suelen utilizar MAYÚSCULAS para el texto que consideran importante y al que quieren que los lectores presten atención. Mientras tanto, los redactores y editores técnicos (con razón) insisten en usar mayúsculas únicamente para los nombres propios.

Como redactor técnico, mantente firme contra el uso de mayúsculas. Las letras mayúsculas distraen; el texto todo en mayúsculas resulta incómodo de leer. Las mayúsculas crean un texto cargado, que envía muchas señales innecesarias. Las mayúsculas están tradicionalmente destinadas a nombres propios como Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, y así sucesivamente. La pauta clásica en la publicación técnica es capitalizar los nombres de productos que se pueden pedir por separado solo. Sin embargo, la política de las organizaciones flexibiliza considerablemente esta directriz. Si una empresa está orgullosa de cierta característica en su nueva versión, por ejemplo, EnergyMiser, la destacará, aunque no se pueda pedir por separado.

Aquí tienes algunas pautas típicas para el uso de mayúsculas:

Utilice el estilo exacto de mayúsculas y minúsculas de los mensajes que se muestran en la pantalla del ordenador, de los nombres de menús o pantallas, de los nombres de campos, de las etiquetas de hardware, etc. (En interfaces bastante antiguas, se usaban MAYÚSCULAS para cosas como nombres de campos, menús y pantallas. Una práctica común en estos casos es usar mayúscula inicial para las referencias a estas cosas en el texto normal. El principio aquí es que las MAYÚSCULAS innecesarias en el texto corriente resultan distractoras.)
Hacer no usa letras mayúsculas para énfasis; usa cursiva o negrita en su lugar.
No uses texto en mayúsculas para ningún texto extenso; usa el formato de aviso especial en su lugar.
No se deben capitalizar los nombres de los componentes ni de los procesos de un producto. Solo deben capitalizarse los nombres de los productos, es decir, de los componentes que se pueden solicitar por separado.

Por ejemplo, su producto puede llamarse WordStuff y, por supuesto, debe escribirse con mayúscula según el estilo dictado por el departamento de marketing y los planificadores de producto. Sin embargo, una de las funciones de WordStuff llamada "corrector ortográfico" no debería llevar mayúscula—casi todo el mundo tiene uno de esos. Sin embargo, WordStuff puede tener una función llamada "ZippyFormat" y otra llamada "Image Worker." Aunque estas no se puedan pedir por separado, querrá usar el estilo de mayúscula inicial debido a su estilo especial y su valor de marketing. "Image Worker" es obviamente algo que WordStuff, Inc., quiere mostrar—por lo tanto, las mayúsculas.

Pero cuando tienes que romper reglas así, las excepciones deben ir en la guía de estilo o en la hoja de estilo.

Comillas simples o dobles

Las comillas suelen utilizarse erróneamente como técnica de énfasis en textos técnicos. Como redactor técnico, limite el uso de las comillas a su empleo tradicional, que incluye el discurso citado; números, letras o palabras mencionados como tales. Las comillas, al igual que las letras mayúsculas, tienden a crear un texto recargado y que distrae; por lo tanto, deben evitarse.

Un uso legítimo de las comillas dobles es el uso extraño, peculiar y no estándar de palabras (llamadas "comillas de duda" por Manual de estilo de Chicago). Por ejemplo:

En un volcado de memoria, la computadora "vomita" todos los datos en un solo archivo.

El texto informático bien diseñado evita enérgicamente el uso de comillas. Una de las razones principales es que algunos lectores podrían suponer, por error, que deben incluir las comillas en los comandos que ingresan.

En lugar de	Utiliza el comando "move".
Escribe	Usa el mover comando.

En lugar de	Introduzca "copiar instalar instalarahora."
Escribir	Entrar copiar instalar instalar ahora

Nota: Aunque algunos textos técnicos tienen usos bien definidos para las comillas simples, en general no existe un uso estándar para las comillas simples, aparte de la regla tradicional de cita dentro de una cita y la regla de uso peculiar. Cuando se ven comillas simples en textos técnicos, por lo general no hay más justificación para su uso que la que existe para las comillas dobles.

Fuentes alternativas

Uno de los estilos más comunes que implican fuentes alternativas es usar Courier o alguna fuente monoespaciada similar, de estilo antiguo de máquina de escribir, en contraste con la fuente de cuerpo estándar (como Times New Roman o Helvetica). Puedes crear este efecto en una página 1web usando un estilo CSS como . Por ejemplo, "tipo " instalar para instalar el programa."

Aquí tienes una reseña de los usos comunes de fuentes alternativas:

Texto de ejemplo. Para indicar que se muestra un ejemplo en lugar de una entrada obligatoria, a menudo se utiliza una fuente alternativa como Courier:

Por ejemplo, si desea copiar un archivo, escriba copia tuarchivo.txt miarchivo.txt. Un archivo llamado miarchivo.txt se creará, y sus contenidos serán los mismos que No se proporcionó contenido. Por favor, pegue el texto en inglés aquí o cargue el archivo yourfile.txt para que lo traduzca al español..

Texto mostrado. Los ordenadores y otros equipos suelen mostrar cosas como advertencias, códigos de estado o mensajes de error. Estos aparecen en monitores o en paneles LCD y similares. Cuando te refieras a este texto mostrado, puedes usar una fuente alternativa como Courier. Por ejemplo, "Si el directorio no existe, el sistema responderá con No existe tal archivo o directorio." O, "Mientras la computadora arranca, la ventana de visualización digital mostrará 8888."
Ejemplos de código ampliados. En los textos de programación informática, los ejemplos de programación extensos a menudo se muestran en Courier, por ejemplo:


#comprobar si hay piratas informáticos malintencionados

        if ($address1 eq "" & $address2 eq "")
{
        &wicked_address (500, "Error de búsqueda", "Por favor, introduzca un nombre.");
}
elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/)
{
        &wicked_address (500, "Error de búsqueda", "Dirección de correo electrónico malformada.
        ¡Por favor, no destruyan nuestra pobre y humilde escuelita virtual de una sola aula!.");
}

Color

El color se utiliza en textos técnicos, pero es caro y difícil de gestionar a lo largo del ciclo de publicación.

Sin embargo, el color es fácil de usar en la información en línea. Por ejemplo, es común ver que los enlaces de hipertexto emplean color. La ayuda en línea suele usar el verde, mientras que las páginas web típicamente usan el azul para los enlaces nuevos y el púrpura para los enlaces que el usuario ya ha explorado.

La tendencia a usar el color de manera indiscriminada en la información en línea es muy parecida a la tendencia a dejarse llevar con el uso de negritas, cursivas, tamaños de letra y fuentes alternativas en la información impresa. La sensación debe ser algo así como: «¡Está ahí, es genial, así que usémoslo!»

Si quieres usar color, plánifícalo cuidadosamente. No esperes que los lectores recuerden que el rojo indica una idea, el azul otra idea y el verde otra idea más. Limítate a un solo color. En general, evita usar color en textos extensos. En lugar de poner todo un aviso de advertencia en rojo, haz que solo la etiqueta «Advertencia» sea roja y deja el texto de la advertencia en letra romana normal (texto como el del cuerpo regular).

Mejor aún, lea parte de la literatura estándar sobre el color en el campo de la comunicación técnica. Existen cuestiones generales de diseño y cuestiones internacionales:

Usando color. Proporcionado por el Sistema de Diseño Web de EE. UU. (USWDS).
Guía internacional para el uso del color en el marketing y la publicidad. Diferentes significaciones que el rojo, por ejemplo, tiene internacionalmente. Echa un vistazo a su Tabla internacional de simbolismo del color. Fuente: Seis Grados, LLC
Recuerde que, según un artículo En Wikipedia, "Aproximadamente el 8% de los hombres y el 0,4% de las mujeres son daltónicos rojo–verde de alguna u otra manera, ya sea un color, una combinación de colores u otra mutación."

Combinaciones de lo anterior

En general, es una mala idea combinar técnicas de énfasis, por ejemplo, la negrita y la cursiva. En textos técnicos no profesionales, verás combinaciones tan estridentes como todo en mayúsculas con negrita y cursiva, o en mayúsculas con negrita y cursiva entre comillas dobles. ¡Evítalas!

Una combinación legítima es usar la cursiva con fuentes alternativas. Por ejemplo, cuando muestras la sintaxis de un comando, quieres que todo el texto esté en Courier, pero también quieres que las variables estén en cursiva:

copiar Nombre de archivo antiguo Nuevo nombre de archivo

Nombres funcionales para estilos de carácter y etiquetas

Si alguna vez has estado cerca de la industria editorial, puede que te hayas encontrado con algo llamado marcado semántico. Esto significa nombrar secciones de texto de acuerdo con el papel estructural que desempeñan en el documento—por ejemplo, encabezado. El lector no ve estos nombres, pero desempeñan un papel importante en cómo se formatea el documento y en cómo puede reutilizarse.

La misma idea se aplica a las palabras en frases dentro del texto. Por ejemplo, en el HTML de una página web, puedes usar el palabra en negrita etiquetas para poner una palabra en negrita. Pero la negrita no indica la función de la palabra o frase. En su lugar, comando haría o etiqueta_de_interfaz lo haría. Por lo tanto, en el marcado semántico usando HTML y CSS, las cosas son más funcionales si se ven así: palabra en negrita.

Los archivos que utilizan HTML y CSS suelen convertirse a otros medios, como PDF o incluso hacia y desde XML. Usando funcionalmente Los estilos de resaltado con nombre, como se describió justo arriba, pueden facilitar en gran medida el proceso de conversión.

Exploraciones adicionales

Una vez que hayas leído lo anterior, una buena idea para hacer a continuación es explorar publicaciones técnicas para ver qué esquemas de resaltado utilizan. Observa la forma en que se utilizan elementos como la negrita, la cursiva, las mayúsculas, las fuentes alternativas y otros efectos similares. Lo más probable es que veas un uso muy distinto al que has leído aquí. Mientras exploras, piensa en la lógica de las técnicas de énfasis que se están utilizando; intenta formular las reglas que parecen emplear los redactores; observa las inconsistencias en el resaltado; y piensa críticamente sobre el uso que ves—¿es lógico? ¿exceso? "insuficiente?"

Después de haber explorado de esta manera, el siguiente paso lógico es leer el capítulo sobre guías de estilo, si aún no lo has hecho. Los esquemas de resaltado deben documentarse en las guías de estilo para que no los olvides y para que los miembros de tu equipo de documentación puedan consultarlos.

Esquema de resaltado

Si todas las opciones y alternativas discutidas anteriormente le han abrumado, considere usar el siguiente esquema de resaltado. Está basado en el resaltado que encontrará en muchos documentos de UNIX, Windows y Linux.

Nombres de campos, carpetas, cuadros de diálogo (ventanas), menús (cualquier objeto de la interfaz con el que los usuarios realicen no haz clic en)	Estilo de mayúsculas en pantalla; romano regular
Nombres de iconos	Estilo de mayúsculas en pantalla; negrita
Botones (o equivalente funcional si no están etiquetados así)	Estilo de mayúsculas en pantalla; negrita
Selecciones del menú, opciones seleccionables	Estilo de mayúsculas en pantalla; negrita
Comandos introducidos literalmente sin parámetros ni banderas	Negrita
Texto introducido o mostrado	Courier New (si es necesario, 1 punto más pequeño que la fuente del cuerpo)
Variables	Cursiva; romana regular
Código de programación	Courier New; romano regular; si es necesario, 1 punto más pequeño que la fuente del cuerpo
Etiquetas en el hardware	Courier New; en negrita; si es necesario, 1 punto más pequeño que la fuente del cuerpo

Notas:

Romano regular se refiere a la fuente y al tamaño de letra que se utilizan para el texto del cuerpo.
Aunque estas sugerencias recomiendan "estilo de mayúsculas en pantalla", los desarrolladores a veces tienen la desafortunada tendencia de usar todo en mayúsculas. Dado que el uso exclusivo de mayúsculas reduce la legibilidad, usa mayúsculas iniciales (estilo título) de todos modos.
Si les muestras a los usuarios cómo introducir un comando, incluyendo texto de ejemplo, no pongas en negrita el comando que aparece en el texto de ejemplo:

Resaltado y énfasis

Indica a los lectores qué deben hacer y qué es importante.

Contenido de este capítulo