4.3: Diseño de página

Objetivo de aprendizaje

Al finalizar este capítulo, los lectores podrán:

1. Explicar y aplicar pautas de diseño para el uso de rubros y listas en documentos técnicos.
2. Explicar y aplicar pautas de diseño para incluir avisos en documentos técnicos.
3. Explicar y aplicar pautas de diseño para el uso de tablas y figuras en documentos técnicos.
4. Explicar y aplicar pautas de diseño para resaltar y alinear textos en documentos técnicos.
5. Explicar y aplicar pautas de diseño para la fuente y el color en los documentos técnicos.

Diseño de página común

El diseño de páginas significa cosas diferentes para diferentes personas, pero aquí significará el uso de tipografía y formato como se ve en documentos diseñados profesionalmente.

Nuestro enfoque aquí es la documentación técnica, lo que implica un diseño modesto y funcional.

Para obtener aún más detalles del que ve aquí, consulte estos dos recursos estándar de la industria:

• Pubs Técnicos del Sol. ¡Léeme primero! Cualquier edición reciente. Salón Prentice.
• Microsoft Corporation. Manual de Estilo de Microsoft para Publicaciones Técnicas. Cualquier edición reciente. Microsoft Press.

Rúbricas

A continuación se presentan algunos de los lineamientos normalizados sobre rubros.

• Insertar bastantes encabezamientos, tal vez uno por cada dos o tres párrafos. Evite exagerar, sin embargo: muchos encabezamientos con solo una o dos oraciones por encabezado no funcionan.
• Indicar el nivel de un encabezado a través del diseño. Use el tamaño del tipo, el estilo de tipo, el color, la audacia, la cursiva y la alineación para hacer obvio el nivel de un encabezado. (Los “niveles” de los encabezamientos son como niveles en un esquema: el Nivel 1 corresponde a los números romanos grandes en mayúscula; el Nivel 2 a las letras mayúsculas; el Nivel 3 a los números arábigos; el Nivel 4 a los números romanos en minúscula; y así sucesivamente.)
• Limitar los niveles de rumbo. La mayoría de los documentos solo necesitan tres o menos niveles de encabezado; más niveles pueden confundir a tus lectores.
• Describir los contenidos de las secciones con lenguaje específico. Rubros vagos como “Antecedentes técnicos” no le dicen nada a nadie.
• Usa fraseo paralelo. Los encabezados paralelos dicen a los lectores si las secciones son similares entre sí.
• Evite los “encabezados solitarios”. Si tienes una partida, debes usar una segunda. Es el mismo concepto que tener una “A” sin una “B” o una “1" sin un “2" en contornos.
• Evite los “encabezados apilados” (dos o más encabezados consecutivos sin texto intermedio).
• No use pronombre para referirse a un encabezado. Si tienes un encabezado como “Configurando el Software”, no lo sigas con una frase como “Esta siguiente fase...”
• Considera el formato de “cabeza colgada” para los encabezados principales. En este diseño, algunos o todos los encabezados están en el margen izquierdo, mientras que todo el texto tiene sangría de una a dos pulgadas. Este formato hará que los encabezados destaquen más y reduzca la longitud de línea del texto principal.
• Considera usar encabezados “run-in” para tus encabezados de nivel más bajo. En este diseño, el encabezamiento “se encuentra” con el inicio de un párrafo y termina con un punto. Puede usar alguna combinación de audacia, cursiva o color para estos encabezados. Este formato evita el problema de que los encabezados de nivel inferior se mezclen entre sí.

Listas

Las listas son herramientas útiles para enfatizar puntos importantes, permitir a los lectores escanear texto rápidamente y proporcionar más espacios en blanco. A continuación se presentan algunos de los lineamientos normalizados en las listas.

• Utilice listas numeradas para mostrar la secuencia, el orden o la jerarquía. Utilice listas con viñetas para los elementos que puedan aparecer en cualquier orden.
• Utilice formatos estándar numerados y de listas con viñetas. Están integrados en programas de procesamiento de textos, y HTML tiene etiquetas de listas ordenadas y no ordenadas.
• Use fraseo paralelo para el contenido de las listas.
• Introduce todas las listas con texto inicial; no inicies una lista inmediatamente después de un encabezado.
• A menos que el estilo de su organización sobrescriba, puntúese los elementos de la lista con un punto solo si son oraciones completas o tienen cláusulas dependientes incrustadas.
• Sea consistente con el uso de mayúsculas iniciales o letras minúsculas en las primeras palabras de los elementos de la lista.
• Usa diferentes símbolos para los segundos niveles de listas anidadas. Para listas numeradas, use letras minúsculas. Para listas con viñetas, use guiones en negrita o círculos centrados en vacío. En cualquier caso, asegúrese de que los elementos anidados se alineen con el texto del nivel anterior.
• Evite usar demasiadas listas o listas de relleno excesivo. De siete a diez artículos es generalmente aproximadamente el número máximo de artículos.

Avisos

Los avisos son trozos de texto con formato especial que alertan a los lectores sobre puntos especiales, excepciones, problemas potenciales o peligros. A continuación se presentan algunos de los lineamientos estándar para los avisos.

• Hacer que los avisos sean más prominentes y notables a medida que se vuelven más severos. Considere usar esta jerarquía estándar:
  • “Peligro” para situaciones que puedan implicar lesiones graves o la muerte
  • “Advertencia” para situaciones que puedan implicar lesiones leves
  • “Precaución” para situaciones que puedan implicar daños en el equipo, pérdida de datos o una amenaza para el éxito de un procedimiento
  • “Nota” para excepciones o situaciones que no requieran las etiquetas anteriores
• Sea cual sea el diseño de aviso que use, evite usar cadenas largas de texto en negrita, cursiva, letras mayúsculas o combinaciones de estos. Además de decirle a los lectores que hagan o no hagan algo, explique tres cosas:
  • bajo qué condiciones deben usar el aviso
  • qué pasará si ignoran el aviso
  • cómo recuperar si ignoran el aviso
• Hacer que el texto de los avisos sea sucinto, pero no a costa de una escritura clara. Evite el estilo de escritura telegráfica (omitiendo artículos como a, an, the) en los avisos.
• En las listas numeradas, alinee los avisos al texto de los elementos de la lista a los que se aplican. Poner avisos en dos lugares:
  • antes del paso en el que existe el problema potencial
  • al inicio de todo el procedimiento

Cifras

Las figuras son ilustraciones, dibujos, esquemas, fotos y otros materiales visuales. A continuación se presentan algunos de los lineamientos normalizados sobre cifras.

• En el texto antes de que aparezca cada figura, proporcionar una referencia cruzada a la figura.
• Si incluyes una etiqueta y un pie de foto, colóquelos debajo de cada figura.
• Omitir etiquetas y leyendas si no tienen una función vital y no son necesarias (por ejemplo, en instrucciones cuando las figuras están estrechamente relacionadas con los pasos individuales).

Mesas

Las tablas son como listas, las cuales se discutieron previamente, pero son más estructuradas y formales. En su texto, busque pares repetidos, tripletes o cuatrillizos de elementos que puedan formatearse como tablas. Por ejemplo, una serie de términos y definiciones es un uso clásico para las tablas. A continuación se presentan algunos de los lineamientos estándar para las tablas.

• Busque grupos repetidos de elementos en su texto que pueda formatear como tablas.
• En el texto antes de que aparezca cada tabla, proporcione una referencia cruzada a la tabla.
• Incluya el título de una tabla a menos que el contenido de la tabla sea completamente obvio y la tabla contenga pocos elementos. Coloque el título de la tabla encima de la tabla, o conviértela en la fila superior de la tabla.
• Utilice encabezados de columna y fila (o ambos) para definir el contenido de las columnas y filas. Considera destacar estos encabezamientos.
• Alinee a la izquierda las columnas de texto (a menos que el contenido sea caracteres alfabéticos simples). Alinee a la izquierda las columnas de texto con sus encabezados.
• Alinear a la derecha o alinear decimales datos numéricos, y centrarlos bajo su encabezado.
• Ponga unidades de medida estándar (ft, mm, gal.) en el encabezado de columna o fila en lugar de con cada elemento en la columna o fila.
• Discuta brevemente la tendencia principal en la mesa, lo que quiere que los lectores noten.

Destacando

La documentación de software suele utilizar mucho resaltado. Destacar aquí se refiere a texto en negrita, cursiva, fuentes alternas, letras mayúsculas, comillas y otros trucos tipográficos utilizados para llamar la atención sobre el texto. A continuación se presentan algunas pautas estándar para resaltar.

• Establecer un plan para usar el resaltado y aplicarlo de manera consistente
• Utilizar el resaltado por razones específicas y funcionales. Evite demasiado resaltado, y evite complicados esquemas de resaltado.
• Considere usar este esquema de resaltado bastante estándar:
  • Para un énfasis simple, use cursiva.
  • Usa negrita para comandos, botones en pantalla y opciones de menú.
  • Use cursiva para las variables para las cuales los usuarios deben suministrar sus propias palabras.
  • Utilice una fuente alternativa para el texto que se muestra en la pantalla o el texto que los usuarios deben escribir.
  • Para los nombres de pantalla y campo, use el estilo de mayúsculas que se muestra en la pantalla pero no otro resaltado.
  • Use un límite inicial para los nombres clave pero no otro resaltado.
  • Para mayor énfasis, utilice el formato de aviso.

Márgenes, sangría y alineación

Como se menciona en la sección sobre encabezados, es posible que desee aplicar sangría al texto principal de una a dos pulgadas mientras deja encabezados en los márgenes izquierdos. Este estilo hace dos cosas: hace que los encabezados destaquen, y acorta la longitud de línea del texto principal.

Fuentes y Color

Aquí hay algunas sugerencias sobre fuentes y color:

• Limite a dos el número de fuentes principales que aparecen en un documento. Por ejemplo, podrías usar Arial para encabezados y Times New Roman para texto corporal.
• Utilice solo una fuente alternativa, como máximo dos. Por ejemplo, podría usar Arial para encabezados, Times New Roman para el texto del cuerpo y Courier New para el texto que los usuarios verán en pantalla o que los usuarios deben escribir.
• Si usas color, úsalo mínima y consistentemente. Por ejemplo, si tienes texto negro sobre un fondo blanco, podrías seleccionar otro color para los encabezados. Podrías usar ese mismo color para los títulos de figuras y tablas, así como las etiquetas para los avisos (las etiquetas reales de “Nota”, “Advertencia”, “Precaución” y “Peligro” en los avisos).
• Evite combinaciones inusuales de colores de fondo y texto. Por ejemplo, el texto morado o rojo sobre fondo negro es ilegible. Quédate con texto negro sobre un fondo blanco o gris a menos que haya una razón fuerte y funcional para alguna otra combinación de colores.