En este capítulo, diseño de libros significa el contenido, estilo, formato, diseño y secuencia de los distintos componentes típicos de un libro. "Componentes" aquí se refiere a secciones o páginas reales de un libro, tales como el aviso de edición, el prefacio, el índice, o la portada o la contraportada. En la capítulo de diseño de página, el término elemento se refiere a cosas que pueden ocurrir varias veces prácticamente en cualquier parte de un libro, tales como encabezados, pies de página, tablas, ilustraciones, listas, avisos, resaltados y así sucesivamente.
A continuación se 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. Ciertamente, ninguna guía del usuario, manual de referencia técnica, documento de referencia rápida u otro documento de ese tipo tendría realmente todos estos componentes diseñados y secuenciados precisamente de la manera que está a punto de leer. En su lugar, esta revisión ofrecerá una visión general de las posibilidades—digamos, el rango de posibilidades.
Nota: Actualmente, solo tenemos un 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 descifrar esa "d" en "Filepad"!) Tenga en cuenta que no cumple algunos de los requisitos de fuente y márgenes que se indican a continuación.
Antes de empezar a leer lo siguiente, toma varios libros sobre hardware y software para que puedas comparar su contenido, estilo, formato y secuencia con lo que se discute aquí.
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. ¡Léeme primero! Cualquier edición reciente. Prentice Hall.
- Microsoft Corporación. Manual de estilo de Microsoft para publicaciones técnicas. Cualquier edición reciente. Microsoft Press.
Puedes ver ejemplos de estos componentes del libro en Diseño de Techdoc.
Portada y contraportada
Los documentos de producto para clientes que pagan suelen tener portadas bien diseñadas, aunque, en el interior, el libro sea de muy baja calidad. En la portada, normalmente verá algunos o todos los siguientes elementos:
- Nombre de la empresa
- Nombre del producto
- Plataforma del producto o sistema operativo
- Números de versión y de lanzamiento del producto
- Título del libro
- Logotipos de empresas o productos
- Símbolos de marca registrada
- Obra de arte
- Número de pedido del libro
- Eslogan de la empresa o del producto
Puede ser un desafío determinar un buen formato para el nombre de la empresa, el nombre del producto y el título del libro. ¡A veces, estos pueden equivaler a todo un párrafo de texto! Las empresas están bastante divididas en cuanto a si indicar los números de versión y de lanzamiento en las portadas—algunas sí; otras no. Casi siempre, sin embargo, verás la plataforma indicada—ya sea que el producto sea para Macintosh, el PC, UNIX y demás.
La contraportada de las guías y manuales de usuario en formato impreso suele ser muy sencilla. Normalmente contiene el número de pedido del libro, el nombre de la empresa con los símbolos de marca pertinentes, un símbolo de copyright y una frase que indique la titularidad del libro, y una declaración sobre en qué país se imprimió el libro. También encontrará códigos de barras en la contraportada. Compruebe si su software puede generar un código de barras—usted simplemente accede a la utilidad de códigos de barras y escribe el número de pedido del libro, y la utilidad genera el código de barras.
Página del título
La página del título suele ser una duplicación de la portada, pero con ciertos elementos omitidos. Normalmente se omiten el material gráfico, los logotipos de la empresa o del producto y los eslóganes. Algunas publicaciones técnicas omiten por completo la página del título debido a la aparente duplicación innecesaria. (Y en una tirada de 20.000 ejemplares, una sola página supone mucho.)
Aviso de edición
El aviso de edición suele ser la primera instancia de texto normal en una publicación técnica, aunque suele estar en un tamaño de letra más pequeño. Aparece en el reverso de la página del título. Si el editor técnico adopta un enfoque de eficiencia y sostenibilidad y elimina la página del 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:
- Fecha de publicación—Incluye no solo el año, sino a veces incluso el mes en que se publicó el libro.
- Número de edición—Si el libro es de primera, segunda o tercera edición.
- Aplicabilidad del producto—El aviso de edición normalmente indica a qué plataforma, versión y número de lanzamiento del producto se aplica el libro.
- Título completo del libro—Mostrado en cursiva.
- Descargos de responsabilidad—Sorprendentemente, los fabricantes de productos harán declaraciones en el sentido de que no garantizan que el libro sea técnicamente correcto, completo o esté libre de problemas de redacción, o que el producto esté libre de pequeños defectos, o que satisfaga las necesidades del cliente. También podrá encontrar otras exenciones de responsabilidad además de estas.
- Símbolo de derechos de autor y declaración— Verás el símbolo de copyright (una C dentro de un círculo) y una declaración que advierte a los lectores que no copien el libro sin permiso.
- Permisos de derechos de autor—El mundo de la alta tecnología a menudo se mueve tan rápidamente que, en lugar de crear sus propias versiones de un componente de producto y su documentación correspondiente, las empresas simplemente compran el código o el diseño y también los derechos para reimprimir la documentación. Esto generalmente implica el reconocimiento de derechos de autor en el aviso de edición (aunque si ha habido mucho material tomado prestado, los editores deben ingeniárselas para decidir dónde colocar todos estos reconocimientos).
- Respuestas de los lectores—A veces, el aviso de edición incluirá alguna invitación a los clientes a ponerse en contacto con la empresa sobre preocupaciones relativas al producto o la documentación. En ocasiones, se incluyen instrucciones sobre cómo contactar a la empresa en el aviso de edición. También suele incluirse una declaración algo poco amigable de que cualquier comunicación del cliente pasa a ser propiedad de la empresa.
- Marcas registradas—Algunas publicaciones técnicas enumeran las marcas registradas conocidas en el aviso de edición. Esto incluye tanto las propias marcas de la empresa como las marcas de otras empresas mencionadas en el libro. Con la explosión de nuevos productos en el mundo de alta tecnología, y por tanto la explosión de marcas registradas, algunas publicaciones prácticamente se dan por vencidas e insertan una declaración simple de que cualquier referencia a nombres de productos con marca registrada pertenece a sus respectivas empresas.
Descargos de responsabilidad
Consulte la sección sobre avisos de edición, donde normalmente se esconden los descargos de responsabilidad. Si un producto o su publicación necesita toda una página separada para sus descargos de responsabilidad, ¡no lo compro!
Marcas registradas
Aunque muchas empresas sí incluyen sus propias marcas registradas 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 exclusivamente competencia de los abogados de la empresa; como autor, es posible que tengas que cumplir, sin importar lo mala que sea la decisión en términos de diseño del libro o estilo de escritura. Recuerda, solo debes listar los nombres de productos con marca registrada que aparezcan en ese libro en particular.
Notarás que algunas publicaciones toman medidas extremas con las marcas registradas: ponen un asterisco o una nota a pie de página en la primera mención, o incluso en cada aparición del nombre de un producto con marca registrada. Pero, de nuevo, estas son directivas de los abogados de la empresa a las que los redactores técnicos deben resignarse, por muy lamentable que sea.
Garantías
Más temas legales. Estas son las "garantías" que la empresa respaldará con respecto a su producto. A veces se publican en el material preliminar del libro; pero, más apropiadamente desde el punto de vista del diseño del libro, se imprimen en una tarjeta separada e insertan en el film retráctil que envuelve el libro o el producto. De nuevo, al igual que con los avisos de edición, este es un texto que simplemente se incorpora como "texto estándar" y se sitúa en el lugar adecuado dentro del libro.
Sin embargo, debes ser consciente de que las empresas a veces mantienen múltiples versiones de avisos de edición, avisos de seguridad, garantías, comunicados y otros similares. Como redactor, debes asegurarte de que estás usando la versión correcta (y, al averiguar cuál es la correcta, ¡tendrás la oportunidad de salir y conocer a mucha gente nueva en la empresa!). Y hagas lo que hagas, no cambies el texto de estos elementos estándar, por horriblemente que estén escritos. Los cambios normalmente deben ser aprobados por los abogados de la empresa (que normalmente lo hacen de mala gana y solo después de muchos esfuerzos por tu parte y de que haya pasado mucho tiempo).
Avisos de seguridad
Los productos de hardware suelen tener una sección de avisos de seguridad al frente de sus manuales. Estos pueden aparecer como una subsección del prefacio, por ejemplo, o como una sección separada por sí misma. Estas secciones normalmente 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 previa, los manuales de hardware siguen colocando los avisos individuales en los puntos donde se aplican. (Para más información, vea avisos especiales.)
Declaraciones de comunicación
Los manuales de hardware también requieren declaraciones de comunicaciones según lo estipulado por los gobiernos de los países a los que se envían estos productos. En EE. UU., la FCC exige ciertas declaraciones de comunicaciones dependiendo de la "clase" del producto de hardware. Como redactor, debe tener cuidado de usar la declaración de comunicaciones correcta para el producto que está documentando—y no editar la declaración de ninguna manera (¡palabras legales sagradas!).
Tabla de contenidos
La tabla de contenidos (TOC) suele contener al menos un segundo nivel de detalle (los "head 1s" en el texto real) para que los lectores puedan encontrar lo que necesitan con más precisión. Los escritores, los editores y los diseñadores de libros suelen discutir sobre la secuenciación de la TOC. En términos de usabilidad, es mucho mejor que la TOC esté lo más cerca posible del comienzo del libro, si no al principio mismo del libro. En términos legales, sin embargo, a la gente le preocupa que todas esas declaraciones de comunicación, garantías, derechos de autor, marcas registradas y avisos de seguridad deban ir primero. En aquellos lugares donde la usabilidad sale ganando, los libros emplean todas las tácticas posibles para sacar este material legalista de las páginas preliminares: las garantías se colocan en tarjetas separadas y se envuelven en film retráctil junto con el libro o producto; las garantías, las declaraciones de comunicación, las marcas registradas y otros elementos similares pueden volcarse en apéndices.
¿Problemas para crear una tabla de contenido bien formateada? Vea Crear una tabla de contenidos con aspecto profesional
Lista de figuras
Los manuales técnicos para usuarios habituales normalmente no incluyen listas de figuras. De hecho, las propias figuras normalmente no cuentan con títulos completos. Pero ello no significa que una lista de figuras no tenga cabida en los manuales técnicos. Todo depende del lector y de las necesidades del lector—y también del contenido del libro. Si el libro contiene tablas, ilustraciones, cuadros, gráficos y otros elementos que los lectores querrán localizar directamente, la lista de figuras está justificada.
Prefacio
La función del prefacio es preparar a los lectores para leer el libro. Lo hace mediante:
- caracterizando el contenido y el propósito del libro
- identificar o incluso describir brevemente el producto que el libro respalda
- explicando el tipo de lector para el que está destinado el libro
- esbozando los contenidos principales del libro
- mostrando cualquier convención especial o terminología utilizada en el libro
- proporcionando números de soporte y de marketing, y otros por el estilo
En la edición tradicional de libros, el prefacio va antes de la tabla de contenidos; pero como se discutió anteriormente en el tabla de contenidos Sección, los responsables de la publicación técnica quieren que la tabla de contenidos aparezca antes en el libro por razones de usabilidad.
Capítulos del cuerpo
¡Oh sí, y hay texto real en estos libros—: no es todo material 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. Consulte el capítulo sobre diseño de la página para problemas 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 omitirse del libro. Los apéndices suelen ser el lugar para tablas grandes y engorrosas. Algunas publicaciones técnicas incluyen cosas como garantías en los apéndices. En cuanto al formato, un apéndice es como un capítulo—excepto que se llama "Apéndice A" o algo por el estilo, y los encabezados y pies de página coinciden con esa convención diferente de numeración y denominación (A-1, A-2, y así sucesivamente para las páginas del Apéndice A).
Glosario
Algunas publicaciones técnicas incluyen una sección de términos especializados y sus definiciones. Nótese que la mayoría de los glosarios utilizan un diseño de dos columnas. Por lo general, cada término y su definición constituyen 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, y luego la definición en letra romana normal. Nótese también que las definiciones normalmente no son oraciones completas. Las buenas definiciones de glosario deberían usar la técnica de definición en oración formal tal como se describe en el capítulo de definiciones de este texto en línea. Las definiciones múltiples 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 Véase también referencias a términos relacionados.
Índice
Los índices también suelen ser de dos columnas y también contienen Ver referencias a términos preferidos y Véase también referencias a términos relacionados. Consulte el capítulo sobre indexación para procesos y directrices para la creación de 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, resultó que esos formularios con más frecuencia suscitaban quejas sobre el funcionamiento defectuoso del producto que el libro documentaba. Con el auge de Internet, esos formularios se han trasladado a la web y los libros simplemente indican su ubicación en línea.
Diseño y maquetación de libros
Por lo general, las guías y manuales de usuario producidos por fabricantes de hardware y software están diseñados de una 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. A continuación se muestran algunas de las características típicas de diseño y maquetación que verá:
- El tamaño de la página a menudo se determina por consideraciones de embalaje así como por los tamaños de página estándar disponibles en las imprentas. Cuando el tamaño de la página no es una limitación, algunas empresas utilizan el tamaño de página de 8,5 × 11 pulgadas; esto facilita mucho la producción para los redactores.
- Las páginas normalmente se diseñan alternando páginas derechas e izquierdas. El pie de página de la página izquierda (par) comienza con el número de página y termina con el título del libro. El pie de página de la página derecha (impar) comienza con el título del capítulo y termina con el número de página.
- Hay prácticas mixtas respecto a si la numeración de las páginas es consecutiva a lo largo del libro o por capítulo.
- A menos que las páginas sean bastante pequeñas, el diseño de encabezados colgantes en relación con las páginas es bastante común en los manuales técnicos. La sangría francesa suele ser de una pulgada a una pulgada y media.
- Las fuentes suelen ser Times New Roman de 12 puntos para el texto del cuerpo y Arial para los encabezados. Se utiliza el espaciado de línea y el espaciado entre palabras estándar. Vea el capítulo sobre resaltando para otros problemas tipográficos.
- Los márgenes son bastante estándar, de una a dos pulgadas por todos lados. Por lo general, se utiliza media pulgada adicional en los márgenes interiores para permitir la encuadernación.
- Por lo general, el color es no utilizado en estos manuales y guías, generalmente por consideraciones de costo y eficiencia.
Nota: Esto concluye la discusión sobre el libro impreso componentes. Para completar esta visión general 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, resaltados, referencias cruzadas y más.
Agradecería sus opiniones, reacciones y críticas respecto a este capítulo: tu respuesta.
