En este capítulo, diseño de libros significa el contenido, estilo, formato, diseño y secuencia de los diversos componentes típicos de un libro. "Componentes" aquí se refiere a secciones o páginas reales de un libro, como el aviso de edición, el prefacio, el índice o la portada o contraportada. En el capítulo de diseño de página, el término elemento se refiere a cosas que pueden ocurrir múltiples veces prácticamente en cualquier parte de un libro, como encabezados, pies de página, tablas, ilustraciones, listas, avisos, resaltados, y así sucesivamente.

Lo siguiente ofrece una visión general de los componentes típicos de un libro técnico impreso y del contenido, formato, estilo y secuencia típicos de esos componentes. Sin duda, ninguna guía del usuario, manual de referencia técnica, documento de referencia rápida u otro documento similar tendría realmente todos estos componentes diseñados y secuenciados exactamente de la manera en que estás a punto de leer. En cambio, esta revisión dará una visión general de las posibilidades—digamos que el rango de posibilidades.

Nota: Actualmente, solo tenemos ejemplo guía del usuario desarrollado en FrameMaker y luego exportado a PDF. Carece de un glosario, pero todas las demás partes de una guía de usuario típica están en su lugar. (¡No puedo entender esa "d" en "Filepad"!) Ten en cuenta que no utiliza algunos de los requisitos de fuente y márgenes que se indican a continuación.

Antes de comenzar a leer lo siguiente, toma varios libros de hardware y software para que puedas comparar su contenido, estilo, formato y secuenciación con lo que se discute aquí.

Para aún más detalles de los que ves aquí, consulta estas dos fuentes estándar de la industria:

Puedes ver ejemplos de estos componentes del libro en Diseño de Techdoc.

Cubiertas frontal y trasera

Los documentos del producto para clientes que pagan suelen tener portadas bien diseñadas, incluso si, en el interior, el libro es de calidad muy baja. En la portada, normalmente verás algunos o todos los siguientes:

Puede ser un desafío encontrar un buen formato para el nombre de la empresa, el nombre del producto y el título del libro. A veces, ¡esto puede llegar a ser todo un párrafo de texto! Las empresas están bastante divididas sobre si indicar los números de versión y lanzamiento en las portadas—algunos lo hacen; otros no. Sin embargo, casi siempre verás que se indica la plataforma—ya sea que el producto sea para Macintosh, PC, UNIX, y así sucesivamente.

La contraportada de los manuales y guías de usuario en papel suele ser muy simple. Típicamente, contiene el número de pedido del libro, el nombre de la empresa con los símbolos de marca registrada apropiados, un símbolo de copyright y frases sobre la propiedad del libro, así como una declaración sobre en qué país se imprimió el libro. También encontrarás códigos de barras en la contraportada. Verifica si tu software puede generar un código de barras; solo necesitas acceder a la utilidad de código de barras y escribir el número de pedido del libro, y la utilidad genera el código de barras.

Página de título

La página de título es típicamente un duplicado de la portada, pero con ciertos elementos omitidos. Generalmente se omiten la ilustración, los logotipos de la empresa o del producto, y los eslóganes. Algunas publicaciones técnicas omiten la página de título por completo debido a la aparente duplicación innecesaria. (¡Y en una tirada de 20,000 copias, ¡una sola página significa mucho!)

Aviso de edición

El aviso de edición es típicamente la primera instancia de texto regular en una publicación técnica, aunque generalmente está en un tipo más pequeño. Ocurre en el reverso de la página de título. Si el editor técnico está adoptando el enfoque de lean-and-green y elimina la página de título, el aviso de edición aparecerá en el reverso de la portada.

A nadie le gusta leer la letra pequeña, pero eche un vistazo a las declaraciones que normalmente se incluyen en un aviso de edición:

Exclusiones de responsabilidad

Ver la sección sobre avisos de edición, donde las advertencias suelen estar ocultas. ¡Si un producto o su publicación necesita una página completa para sus advertencias, no lo compraré!

Marcas Registradas

Aunque muchas empresas enumeran sus propias marcas comerciales y las de otras empresas en el aviso de edición, algunos prefieren enumerarlos en una página separada, justo después del aviso de edición. Estas decisiones sobre la ubicación son casi estrictamente competencia de los abogados de la empresa; como escritor, es posible que tengas que cumplir sin importar cuán mala sea la decisión en términos de diseño del libro o estilo de escritura. Recuerda, solo enumeras aquellos nombres de productos con marca registrada que aparecen en ese libro en particular.

Notarás que algunas publicaciones van a medidas extremas con las marcas comerciales: asterizan o ponen una nota al pie en la primera, o incluso en cada ocurrencia de un nombre de producto registrado. Pero, de nuevo, estas son directrices de los abogados de la empresa a las que los escritores técnicos deben resignarse, aunque les apene.

Garantías

Más asuntos legales. Estas son las "garantías" que la empresa ofrecerá respecto a su producto. A veces se publican en el frontispicio del libro; pero, más apropiadamente desde el punto de vista del diseño del libro, se imprimen en una tarjeta separada y se insertan en el envoltorio de película del libro o del producto. Nuevamente, al igual que con los avisos de edición, este es un texto que simplemente se trae como "plantilla" y se posiciona en el lugar correcto dentro del libro.

Sin embargo, debes tener en cuenta que las empresas a veces mantienen múltiples versiones de avisos de edición, avisos de seguridad, garantías, declaraciones de comunicación y otros similares. Como escritor, debes asegurarte de estar utilizando la versión correcta (y, al averiguar cuál es la correcta, ¡tendrás la oportunidad de salir y conocer a muchas personas nuevas en la empresa!). Y sea lo que sea que hagas, no cambies el texto de estos elementos estándar, por muy mal que estén escritos. Los cambios generalmente deben ser aprobados por los abogados de la empresa (quienes suelen hacerlo de mala gana y solo después de muchos esfuerzos de tu parte y después de que haya pasado mucho tiempo).

Avisos de seguridad

Los productos de hardware suelen tener una sección de avisos de seguridad al principio de sus libros. Estos pueden aparecer como una subsección del prefacio, por ejemplo, o como una sección separada por derecho propio. Estas secciones típicamente reúnen todos los avisos de peligro, advertencia y precaución que aparecen a lo largo del libro y los organizan de alguna manera lógica. Pero incluso con esta advertencia al principio, los libros de hardware aún colocan los avisos individuales en los puntos donde son aplicables. (Para más información, consulte) avisos especiales.)

Declaraciones de comunicación

Los libros de hardware también requieren declaraciones de comunicación según lo estipulado por los gobiernos de los países a los que se envían estos productos. En EE. UU., la FCC requiere ciertas declaraciones de comunicación dependiendo de la "clase" del producto de hardware. Como escritor, debes tener cuidado de usar la declaración de comunicación correcta para el producto que estás documentando—y no editar la declaración de ninguna manera (¡palabras legales sagradas!).

Tabla de contenidos

El índice (TOC) generalmente contiene al menos un segundo nivel de detalle (los encabezados 1 en el texto real) para que los lectores puedan encontrar lo que necesitan de manera más precisa. Los escritores, editores y diseñadores de libros suelen discutir sobre la secuenciación del TOC. En términos de usabilidad, es mucho mejor tener el TOC lo más cerca posible del inicio del libro, si no en la primera página. Sin embargo, en términos legales, a la gente le preocupa que todas esas declaraciones de comunicación, garantías, derechos de autor, marcas comerciales y avisos de seguridad deban aparecer primero. En aquellos lugares donde la usabilidad prevalece, los libros utilizan todas las tácticas que pueden para sacar este material legalista del contenido preliminar: las garantías se colocan en tarjetas separadas y se envuelven al vacío con el libro o producto; garantías, declaraciones de comunicación, marcas comerciales y otros pueden ser incluidos en apéndices.

¿Problemas para crear un índice bien formateado? Ver Crea un índice de contenido con aspecto profesional.

Lista de figuras

Los manuales técnicos para usuarios comunes típicamente no tienen listas de figuras. De hecho, las figuras en sí mismas generalmente no tienen títulos completos. Pero esto no quiere decir que una lista de figuras no tenga lugar en los manuales técnicos. Todo depende del lector y de las necesidades del lector—y del contenido del libro también. Si el libro contiene tablas, ilustraciones, gráficos, diagramas y otros elementos que los lectores querrán encontrar directamente, la lista de figuras es ordenada.

Prefacio

La función del prefacio es preparar a los lectores para leer el libro. Lo hace de la siguiente manera:

En la publicación de libros tradicional, la introducción viene antes de la tabla de contenido; pero como se discutió anteriormente en el tabla de contenido sección, las personas de publicaciones técnicas quieren que el índice aparezca antes en el libro por razones de usabilidad.

Capítulos del cuerpo

Oh sí, y hay texto real en estos libros—¡no todo es materia preliminar! Poco más que decir aquí, aparte de que la mayoría de los libros técnicos tienen capítulos o secciones, y, en algunos casos, partes. Ver el capítulo sobre diseño de página para cuestiones de formato, estilo y diseño de elementos como encabezados, pies de página, títulos, listas, avisos, tablas, gráficos, referencias cruzadas y resaltado.

Apéndices

Como sabes, los apéndices son para material que simplemente no parece encajar en la parte principal de un libro pero que tampoco puede ser omitido. Los apéndices suelen ser el lugar para grandes tablas difíciles de manejar. Algunas publicaciones técnicas tienen cosas como garantías en los apéndices. En cuanto al formato, un apéndice es igual que un capítulo—excepto que se llama "Apéndice A" o algo similar, y los encabezados y pies de página coinciden con esa diferente convención de numeración y nombres (A-1, A-2, y así sucesivamente para las páginas en el Apéndice A).

Glosario

Algunas publicaciones técnicas incluyen una sección de términos especializados y sus definiciones. Observe que la mayoría de los glosarios utilizan un formato de dos columnas. Normalmente, cada término y su definición forman un párrafo separado, con el término en minúsculas (a menos que sea un nombre propio) y en negrita, seguido de un punto, luego la definición en estilo normal. También cabe señalar que las definiciones no suelen ser oraciones completas. Las buenas definiciones de glosario deberían utilizar la técnica de definición de oración formal como se describe en el capítulo de definiciones de este texto en línea. Múltiples definiciones suelen identificarse por números arábigos entre paréntesis. Los párrafos del glosario también contienen Ver referencias a términos preferidos y Ver también referencias a términos relacionados.

Índice

Los índices también son típicamente de dos columnas y también contienen Ver referencias a términos preferidos y Ver también referencias a términos relacionados. Ver el capítulo sobre indexación para procesos y directrices para crear buenos índices.

Formulario de respuesta del lector

Antes del auge de Internet y las redes sociales, algunas publicaciones técnicas incluían un formulario en papel para permitir a los lectores enviar comentarios, preguntas y evaluaciones del libro. Por supuesto, resulta que estos formularios a menudo provocan quejas sobre fallos en el producto que el libro documenta. Con el auge de Internet, estos formularios se han trasladado en línea, y los libros simplemente indican su ubicación en línea.

Diseño y maquetación del libro

Por lo general, las guías de usuario y los manuales producidos por fabricantes de hardware y software están diseñados de manera bastante austera y espartana. Las empresas de alta tecnología desarrollan nuevas versiones y lanzamientos de sus productos a veces cada nueve meses. En este contexto, un diseño sofisticado simplemente no es práctico. Aquí están algunas de las características de diseño y disposición típicas que verás:

Nota: Esto concluye la discusión del libro impreso. componentes. Para completar este resumen del diseño de libros impresos, consulte el capítulo sobre diseño de página, que cubre elementos como encabezados y pies de página, títulos, listas, avisos especiales, tablas, gráficos, resaltar, referencias cruzadas y más.

Agradecería tus pensamientos, reacciones, críticas sobre este capítulo: tu respuesta.