Diseño de página significa cosas diferentes para diferentes personas, pero aquí se referirá al 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 de los que ve aquí, consulte estos dos recursos estándar de la industria:
- Publicaciones Técnicas de Sun. ¡Lee Esto Primero! Cualquier edición reciente. Prentice Hall.
- Microsoft Corporation. Manual de Estilo de Microsoft para Publicaciones Técnicas. Cualquier edición reciente. Microsoft Press.
Encabezados y Pies de Página
Las personas a menudo confunden los encabezados con los títulos. Los títulos, cubiertos en encabezados ¿están ocurriendo esas frases? dentro del área del cuerpo de un documento. Los encabezados son esas frases y posiblemente números de página que ocurren dentro del área del encabezado de un documento. Los pies de página son aquellas frases y posiblemente números de página que ocurren dentro del área del pie de página de un documento. Un error común, y grande, es poner el título de un documento en el área del encabezado, lo que hace que aparezca en la parte superior de cada página subsecuente.
Echa un vistazo a un diagrama de una página de documento típica:
Un diseño de página común es colocar el título del documento y el número de página en el área del pie de página. En un formato alternante, la página izquierda podría mostrar el número de página y el título del documento, en ese orden; la página derecha podría mostrar el título del documento y el número de página, en ese orden.
Encabezados
Lo siguiente presenta algunas de las pautas estándar sobre los encabezados. Para una discusión más detallada, consulte el capítulo sobre encabezados en el libro de texto en línea.
- Haz un uso liberal de encabezados, quizás uno por cada dos o tres párrafos. Por supuesto, los encabezados pueden ser excesivos: muchos encabezados con solo una o dos oraciones por encabezado no funcionan.
- Diseña los encabezados de manera que indiquen claramente su nivel. Usa tamaño de tipo, estilo de tipo, color, negrita, cursiva, alineación de tal forma que el nivel del encabezado sea obvio. ("Niveles" de encabezados son como niveles en un esquema: el primer nivel correspondería a los números romanos; el segundo nivel, a las letras mayúsculas; y así sucesivamente.)
- Haz encabezados descriptivos de las secciones que introducen. Encabezados como "Fondo Técnico" no le dicen nada a nadie.
- Hacer encabezados paralelo en la redacción. El paralelismo envía a los lectores pistas importantes sobre si la sección es similar en naturaleza a las anteriores.
- Evita "títulos solitarios"—es el mismo concepto que tener una "A" sin una "B" o un "1" sin un "2" en los esquemas.
- Evita "encabezados apilados"—que son dos o más encabezados consecutivos sin texto intermedio.
- Evitar referirse a los encabezados con pronombres en el texto que sigue a los encabezados. Si tienes un encabezado como "Configurando el Software," no lo sigas con una oración como "Esta siguiente fase..."
- Considera usar el formato de "cabeza colgante" para hacer que los encabezados resalten más y para reducir la longitud de las líneas de texto normal. En el diseño de cabeza colgante, algunos o todos los encabezados están en el margen izquierdo, mientras que todo el texto está indentado una a dos pulgadas.
- Considera usar títulos "integrados" para tu encabezado de nivel más bajo. Puede ser difícil confiar únicamente en el estilo y tamaño de la letra para indicar los niveles de encabezado. Un título integrado "se introduce" al comienzo de un párrafo y termina con un punto. Puedes usar una combinación de negrita, cursiva o color para estos títulos.
Listas
Las listas son herramientas útiles para enfatizar puntos importantes, permitir un escaneo rápido del texto y proporcionar más espacio en blanco. A continuación se presentan algunas de las pautas estándar sobre listas. Para una discusión más detallada, consulte el capítulo sobre listas.
- Utiliza listas numeradas para los elementos que estén en un orden requerido o que deban ser referidos por número. Utiliza listas con viñetas para los elementos en ningún orden requerido.
- Utiliza el formato de listas numeradas y con viñetas estándar disponible en los estilos de párrafo de software de procesamiento de texto, etiquetas HTML, y otros.
- Haz la redacción de los elementos de la lista. paralelo.
- Introduce todas las listas con una introducción; no uses encabezados como introducciones a las listas.
- A menos que el estilo de su organización lo anule, puntee los elementos de la lista con un punto solo si son oraciones completas o tienen cláusulas dependientes integradas.
- Usa ya sea mayúscula inicial o minúscula en la primera palabra de los elementos de la lista, pero hazlo de manera consistente.
- Para listas anidadas, utiliza un guion en negrita como símbolo de viñeta en los elementos de la lista de segundo nivel; utiliza letras minúsculas para los elementos numerados de segundo nivel. Asegúrate de que los elementos anidados se alineen al texto o el nivel anterior.
- Evita el uso excesivo de listas o listas con demasiados elementos. Siete a diez elementos se consideran generalmente el máximo para las listas.
Avisos
Los avisos son esos fragmentos de texto especialmente formateados que alertan a los lectores sobre puntos especiales, excepciones, problemas potenciales o peligros. A continuación, se presentan algunas de las pautas estándar para los avisos. Para una discusión más detallada, consulte el capítulo sobre avisos.
- Utilice una jerarquía estándar de avisos en la que los avisos sean más prominentes y notorios a medida que se vuelven más graves.
- Considera utilizar esta jerarquía:
- avisos de peligro para situaciones que implican posibles lesiones graves o fatalidades
- advertencias para situaciones que involucran lesiones menores
- precauciones para situaciones que involucren daños al equipo o datos o amenaza al éxito del procedimiento
- notas para puntos de excepción o énfasis que no involucren las situaciones precedentes.
- Cualquiera que sea el diseño de aviso que uses, evita el texto extenso en negrita, en cursiva, en mayúsculas, o combinaciones de estos.
- Además de decirles a los lectores que hagan o no hagan algo, explica qué sucederá si ignoran la advertencia, bajo qué condiciones utilizar la declaración y cómo recuperarse si se ignora la declaración.
- Haga el texto de los avisos sucinto, pero sin sacrificar la claridad de la redacción. Evite un estilo de escritura telegráfico (omisión de artículos como). a, un, el) en avisos.
- En listas numeradas, alinear los avisos al texto de el elemento de la lista al que se aplican.
- La sabiduría estándar de colocar avisos antes el paso en el que existe el problema potencial puede causar problemas en el formato. Si es posible, indique advertencias, precauciones o peligros al principio de todo el procedimiento.
Figuras
Las figuras son todo tipo de ilustraciones, dibujos, esquemas, fotos, etc. Ver gráficos para una discusión detallada. Mientras tanto, aquí hay algunos puntos importantes:
- En el texto antes de la figura, proporciona una referencia cruzada a la figura.
- Aunque no es absolutamente necesario incluir un título (leyenda) para cada figura, cuando lo hagas, colócalo debajo la figura.
- Por ejemplo, en las instrucciones, cuando las figuras están estrechamente relacionadas con los pasos individuales, los títulos de las figuras no tienen una función vital y no son necesarios.
Mesas
Las tablas son como listas verticales, discutidas anteriormente, pero más estructuradas y formales. En tu texto, busca pares, tríos o cuartetos que se repitan y que puedan ser formateados como tablas. Por ejemplo, una serie de términos y definiciones es un uso clásico de las tablas. A continuación se presentan algunas de las pautas estándar para tablas. Para una discusión más detallada, consulta el capítulo sobre mesas.
- Busca grupos repetidos de elementos en tu texto que puedas formatear como tablas.
- En el texto antes de la tabla, proporciona una referencia cruzada a la tabla.
- Utiliza un título de tabla a menos que el contenido de la tabla sea absolutamente obvio y la tabla contenga pocos elementos. Coloca el título de la tabla. encima la tabla, o hazlo la fila superior de la tabla.
- Utiliza encabezados de columnas y filas (o ambos) para definir el contenido de las columnas y filas. Considera usar algún tipo de resaltado para estos encabezados de columnas y filas.
- Alinear a la izquierda las columnas de texto (a menos que sean elementos simples de caracteres alfabéticos). Alinear a la izquierda las columnas de texto con sus encabezados.
- Alinee a la derecha o alinee por decimales los datos numéricos, y centríelos bajo su encabezado.
- Coloque unidades de medida estándar (ft, mm, gal.) en el encabezado de la columna o fila en lugar de con cada elemento en la columna o fila.
- Proporcione una breve discusión sobre la tendencia principal en la tabla — lo que desea que los lectores noten.
Resaltando
La documentación de software típicamente utiliza mucho resaltado. El resaltado aquí se refiere a negritas, cursivas, fuentes alternas, 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 el resaltado. Para una discusión más detallada, consulte el capítulo sobre resaltando.
- Establece un plan para el uso del subrayado y aplícalo de manera consistente. Utiliza el subrayado por razones específicas y funcionales. Evita subrayar en exceso; evita esquemas de subrayado complicados.
- Considera usar este esquema de resaltado bastante estándar:
- Para énfasis simple, usa cursivas.
- Usa **negrita** para los comandos, los botones en pantalla y las opciones del menú.
- Usa cursivas para las variables para las que los usuarios deben proporcionar sus propias palabras.
- Utiliza una fuente alternativa para el texto mostrado en pantalla o para el texto que los usuarios deben escribir.
- Para nombres de pantalla y campo, utiliza el estilo de capitalización mostrado en la pantalla, pero sin otro tipo de resaltado.
- Utiliza una letra mayúscula para los nombres clave, pero sin otro tipo de resaltado.
- Para un énfasis prolongado, utiliza el formato de aviso.
Márgenes, Sangrías y Alineación
Como se mencionó en la sección sobre los encabezados, un buen detalle es indentar el texto de una a dos pulgadas dejando los encabezados en los márgenes izquierdos. Este estilo hace dos cosas: hace que los encabezados se destaquen y acorta la longitud de las líneas del texto regular.
Fuentes y Color
Aquí hay algunas sugerencias sobre fuentes y colores:
- Utiliza solo una fuente alternativa, como máximo dos. Por ejemplo, podrías usar Arial para los encabezados, Times New Roman para el texto del cuerpo, y Courier New para el texto que se muestra en la pantalla o que los usuarios deben escribir.
- Si usas color, úsalo mínimamente. Por ejemplo, si tienes texto negro sobre un fondo blanco, podrías seleccionar otro color para los encabezados. También podrías usar ese mismo color para los títulos de las figuras y tablas, así como para las etiquetas de los avisos (las etiquetas reales de "Nota", "Advertencia", "Precaución" y "Peligro" en los avisos).
- Evita combinaciones inusuales de colores de fondo y texto. Por ejemplo, el texto púrpura o rojo sobre un fondo negro es horrible de leer. Mantente con texto negro sobre un fondo blanco o gris, a menos que haya una fuerte razón funcional para alguna otra combinación de colores.
Agradecería tus pensamientos, reacciones, críticas sobre este capítulo: tu respuesta.
