4.2: Diseño de libros
- Page ID
- 103303
\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)
\( \newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\)
( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\)
\( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)
\( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\)
\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)
\( \newcommand{\Span}{\mathrm{span}}\)
\( \newcommand{\id}{\mathrm{id}}\)
\( \newcommand{\Span}{\mathrm{span}}\)
\( \newcommand{\kernel}{\mathrm{null}\,}\)
\( \newcommand{\range}{\mathrm{range}\,}\)
\( \newcommand{\RealPart}{\mathrm{Re}}\)
\( \newcommand{\ImaginaryPart}{\mathrm{Im}}\)
\( \newcommand{\Argument}{\mathrm{Arg}}\)
\( \newcommand{\norm}[1]{\| #1 \|}\)
\( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\)
\( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\AA}{\unicode[.8,0]{x212B}}\)
\( \newcommand{\vectorA}[1]{\vec{#1}} % arrow\)
\( \newcommand{\vectorAt}[1]{\vec{\text{#1}}} % arrow\)
\( \newcommand{\vectorB}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vectorC}[1]{\textbf{#1}} \)
\( \newcommand{\vectorD}[1]{\overrightarrow{#1}} \)
\( \newcommand{\vectorDt}[1]{\overrightarrow{\text{#1}}} \)
\( \newcommand{\vectE}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash{\mathbf {#1}}}} \)
\( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \)
\( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)
\(\newcommand{\avec}{\mathbf a}\) \(\newcommand{\bvec}{\mathbf b}\) \(\newcommand{\cvec}{\mathbf c}\) \(\newcommand{\dvec}{\mathbf d}\) \(\newcommand{\dtil}{\widetilde{\mathbf d}}\) \(\newcommand{\evec}{\mathbf e}\) \(\newcommand{\fvec}{\mathbf f}\) \(\newcommand{\nvec}{\mathbf n}\) \(\newcommand{\pvec}{\mathbf p}\) \(\newcommand{\qvec}{\mathbf q}\) \(\newcommand{\svec}{\mathbf s}\) \(\newcommand{\tvec}{\mathbf t}\) \(\newcommand{\uvec}{\mathbf u}\) \(\newcommand{\vvec}{\mathbf v}\) \(\newcommand{\wvec}{\mathbf w}\) \(\newcommand{\xvec}{\mathbf x}\) \(\newcommand{\yvec}{\mathbf y}\) \(\newcommand{\zvec}{\mathbf z}\) \(\newcommand{\rvec}{\mathbf r}\) \(\newcommand{\mvec}{\mathbf m}\) \(\newcommand{\zerovec}{\mathbf 0}\) \(\newcommand{\onevec}{\mathbf 1}\) \(\newcommand{\real}{\mathbb R}\) \(\newcommand{\twovec}[2]{\left[\begin{array}{r}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\ctwovec}[2]{\left[\begin{array}{c}#1 \\ #2 \end{array}\right]}\) \(\newcommand{\threevec}[3]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\cthreevec}[3]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \end{array}\right]}\) \(\newcommand{\fourvec}[4]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\cfourvec}[4]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \end{array}\right]}\) \(\newcommand{\fivevec}[5]{\left[\begin{array}{r}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\cfivevec}[5]{\left[\begin{array}{c}#1 \\ #2 \\ #3 \\ #4 \\ #5 \\ \end{array}\right]}\) \(\newcommand{\mattwo}[4]{\left[\begin{array}{rr}#1 \amp #2 \\ #3 \amp #4 \\ \end{array}\right]}\) \(\newcommand{\laspan}[1]{\text{Span}\{#1\}}\) \(\newcommand{\bcal}{\cal B}\) \(\newcommand{\ccal}{\cal C}\) \(\newcommand{\scal}{\cal S}\) \(\newcommand{\wcal}{\cal W}\) \(\newcommand{\ecal}{\cal E}\) \(\newcommand{\coords}[2]{\left\{#1\right\}_{#2}}\) \(\newcommand{\gray}[1]{\color{gray}{#1}}\) \(\newcommand{\lgray}[1]{\color{lightgray}{#1}}\) \(\newcommand{\rank}{\operatorname{rank}}\) \(\newcommand{\row}{\text{Row}}\) \(\newcommand{\col}{\text{Col}}\) \(\renewcommand{\row}{\text{Row}}\) \(\newcommand{\nul}{\text{Nul}}\) \(\newcommand{\var}{\text{Var}}\) \(\newcommand{\corr}{\text{corr}}\) \(\newcommand{\len}[1]{\left|#1\right|}\) \(\newcommand{\bbar}{\overline{\bvec}}\) \(\newcommand{\bhat}{\widehat{\bvec}}\) \(\newcommand{\bperp}{\bvec^\perp}\) \(\newcommand{\xhat}{\widehat{\xvec}}\) \(\newcommand{\vhat}{\widehat{\vvec}}\) \(\newcommand{\uhat}{\widehat{\uvec}}\) \(\newcommand{\what}{\widehat{\wvec}}\) \(\newcommand{\Sighat}{\widehat{\Sigma}}\) \(\newcommand{\lt}{<}\) \(\newcommand{\gt}{>}\) \(\newcommand{\amp}{&}\) \(\definecolor{fillinmathshade}{gray}{0.9}\)Objetivos de aprendizaje
Al finalizar este capítulo, los lectores podrán:
- Reconozca los componentes estándar de una portada, contraportada y portada.
- Reconocer el asunto principal común de un libro, incluidos los avisos de edición, renuncias de responsabilidad, marcas comerciales, garantías, avisos de seguridad y declaraciones de comunicación.
- Reconocer las estrategias comunes de organización de los libros, incluyendo tablas de contenido, tablas de figuras, un prefacio y capítulos de cuerpo.
- Explicar y aplicar el diseño y diseño típico del libro.
Descripción general del diseño de libros
A continuación se ofrece una descripción general de los componentes típicos de un libro técnico impreso y el contenido, formato, estilo y secuencia típicos de esos componentes. Ciertamente, ninguna guía de usuario, manual de referencia técnica, documento de referencia rápida u otro documento similar en realidad tendría todos estos componentes diseñados y secuenciados precisamente de la manera que está a punto de leer. En cambio, esta revisión dará una visión general de las posibilidades, digamos el rango de posibilidades.
Antes de comenzar a leer lo siguiente, tome una serie de libros de hardware y software para que pueda comparar su contenido, estilo, formato y secuenciación con lo que se discute aquí.
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.
Cubiertas Delanteras y Traseras
Los documentos de producto para clientes que pagan suelen tener portadas muy bien diseñadas incluso si, en el interior, el libro es sótano de ganga en términos de su calidad. En la portada, normalmente verá algunos o todos los siguientes:
- Nombre de la empresa
- Nombre del producto
- Plataforma de producto o sistema operativo
- Versión del producto y números de lanzamiento
- Título del libro
- Logotipos de empresa o producto
- Símbolos de marcas
- Ilustraciones
- Número de pedido del libro
- Lema de empresa o producto
Puede ser difícil encontrar un buen formato para el nombre de la compañía, el nombre del producto y el título del libro. A veces, ¡estos pueden equivaler a un párrafo completo de texto! Las empresas están bastante divididas sobre si indicar la versión y los números de lanzamiento en las cubiertas frontales, algunas sí; otras no. Casi siempre, sin embargo, verá la plataforma indicada, ya sea que el producto sea para Macintosh, PC, UNIX, etc.
La contraportada de las guías de usuario y manuales en papel suele ser muy sencilla. Por lo general, contiene el número de pedido del libro, el nombre de la compañía con los símbolos de marca correspondientes, un símbolo de derechos de autor y una frase en cuanto a la propiedad del libro, y una declaración sobre en qué país se imprimió el libro. También encontrarás códigos de barras en la contraportada. Vea si su software puede generar un código de barras: solo tiene que 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 portada suele ser un duplicado de la portada, pero con ciertos elementos omitidos. Por lo general, se omiten las ilustraciones, los logotipos de la empresa o del producto y los lemas. Algunas publicaciones técnicas omiten la portada por completo debido a la duplicación aparentemente innecesaria. (Y en una tirada de 20 mil ejemplares, ¡una sola página significa mucho!)
Aviso de Edición
El aviso de edición suele ser la primera instancia de texto regular en una publicación técnica, aunque suele ser de tipo más pequeño. Ocurre en la parte posterior de la página de título. Si el editor técnico está adoptando el enfoque lean and green y eliminando la portada, el aviso de edición aparecerá en la parte posterior de la portada.
A nadie le gusta leer letra pequeña, pero eche un vistazo a las declaraciones típicamente incluidas en un aviso de edición:
- Fecha de publicación: incluido no sólo es el año sino a veces incluso el mes en que se publicó el libro.
- Número de edición: si el libro es una primera, segunda o tercera edición.
- Aplicabilidad del producto: el aviso de edición generalmente 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 libre de problemas de escritura o que el producto esté libre de fallas menores o que satisfaga las necesidades del cliente. También podrás encontrar renuncias adicionales más allá de estas.
- Símbolo y declaración de copyright: verás el símbolo de copyright del Circle-C © y alguna declaración advirtiendo 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ápido que en lugar de crear sus propias versiones de un componente de producto y su documentación correspondiente, las empresas simplemente comprarán el código o diseño y los derechos para reimprimir la documentación también. Esto suele implicar el reconocimiento de derechos de autor en el aviso de edición (aunque si ha ocurrido mucho préstamo, los editores deben ser creativos sobre dónde poner todos estos reconocimientos).
- Respuestas de los lectores: a veces, el aviso de edición incluirá algún estímulo a los clientes para que se comuniquen con la compañía por inquietudes sobre productos o documentación. Las instrucciones sobre cómo contactar a la empresa a veces se incluyen en el aviso de edición. También se incluye a menudo una declaración bastante antipática de que cualquier comunicación con el cliente se convierte en propiedad de la empresa.
- Marcas comerciales: algunas publicaciones técnicas enumeran marcas conocidas en el aviso de edición. Esto incluye tanto las marcas propias de la compañía como las marcas registradas de otras empresas a las que se hace referencia en el libro. Con la explosión de nuevos productos en el mundo de la alta tecnología, y con ello la explosión de marcas, algunas publicaciones esencialmente levantan la mano e insertan una simple declaración de que cualquier referencia a los nombres de productos de marca registrada es propiedad de sus respectivas empresas.
Renuncias
Consulte la sección anterior sobre avisos de edición, donde los descargos de responsabilidad suelen estar escondidos. Si un producto o su publicación necesita una página entera separada para sus descargos de responsabilidad, ¡no lo estoy comprando!
Marcas
Aunque muchas empresas sí enumeran sus propias marcas y las de otras empresas en el aviso de edición, algunas prefieren incluirlas en una página separada, justo después del aviso de edición. Estas decisiones de colocación son casi estrictamente de la provincia de los abogados de la empresa; como escritor, puede que tengas que cumplir por mala que sea la decisión en términos de diseño de libros o estilo de escritura. Recuerde, usted enumera solo aquellos nombres de productos de marca registrada que aparecen en ese libro en particular.
Notarás que algunas publicaciones van a medidas extremas con marcas registradas: van a asterisco o nota al pie de página la primera, o incluso cada ocurrencia de un nombre de producto de marca registrada. Pero nuevamente, se trata de directivas de abogados de empresa a las que los escritores técnicos deben resignarse, aunque tristemente sea.
Garantías
Estas son las “garantías” que la compañía apoyará respecto a su producto. En ocasiones estos se publican en la portada 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 del libro o del producto. Nuevamente, al igual que con los avisos de edición, este es el texto que simplemente traes como “boilerplate” y posiciona en el lugar correcto dentro del libro.
Sin embargo, debe 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 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 compañía!). Y hagas lo que hagas, no cambies el texto de estos artículos obligatorios, por muy horriblemente que estén escritos. Los cambios generalmente deben ser aprobados por abogados de la compañía (que generalmente lo hacen a regañadientes y solo después de muchos esfuerzos de su 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 frente de sus libros. Estos pueden ocurrir como una subsección del prefacio, por ejemplo, o como una sección separada por derecho propio. Estas secciones suelen reunir todos los avisos de peligro, advertencia y precaución que ocurren a lo largo del libro y los arreglan de alguna manera lógica. Pero incluso con esta alerta inicial, los libros de ferretería aún colocan los avisos individuales en los puntos donde aplican.
Declaraciones de Comunicación
Los libros de ferretería 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 Estados Unidos, la FCC requiere ciertas declaraciones de comunicaciones dependiendo de la “clase” del producto de hardware. Como escritor, debe tener cuidado de usar la declaración de comunicación correcta para el producto que está documentando y no editar la declaración de ninguna manera (¡palabras legales sagradas!).
Tabla de Contenidos
El índice (TOC) suele contener al menos un segundo nivel de detalle (los encabezados de primer nivel en el texto real) para que los lectores puedan encontrar lo que necesitan con mayor precisión. Escritores, editores y diseñadores de libros suelen discutir sobre la secuenciación de la TOC. En términos de usabilidad, es mucho mejor tener el TOC lo más cerca posible del frente del libro, si no al principio del libro. En términos de legalidades, sin embargo, a la gente le preocupa que todas esas declaraciones de comunicación, garantías, derechos de autor, marcas comerciales y avisos de seguridad sean lo primero. En aquellos lugares donde la usabilidad gana, los libros utilizan todas las tácticas que pueden para sacar este material legalista de la materia frontal: las garantías se colocan en tarjetas separadas y se envuelven con el libro o producto; las garantías, declaraciones de comunicación, marcas comerciales y otros similares pueden ser arrojados en apéndices.
Lista de figuras
Los manuales técnicos para usuarios ordinarios no suelen tener listas de cifras. De hecho, las propias figuras no suelen tener títulos de figuras en toda regla. Pero esto no quiere decir que una lista de cifras no tenga cabida en los manuales técnicos. Todo depende del lector y de las necesidades del lector, así como del contenido del libro. Si el libro contiene tablas, ilustraciones, tablas, gráficas, y otras tales que los lectores querrán encontrar directamente, la lista de figuras está en orden.
Prefacio
La función del prefacio es preparar a los lectores para leer el libro. Lo hace por:
- caracterizar el contenido y propósito del libro
- identificar o incluso describir brevemente el producto que soporta el libro
- explicando el tipo de lector para el que se entiende el libro
- esbozando los principales contenidos del libro
- mostrando cualquier convenciones especiales o terminología utilizada en el libro
- proporcionar soporte y números de mercadeo, y otros
En la publicación tradicional de libros, el prefacio viene antes de la tabla de contenidos; pero como se discutió anteriormente en la sección de tabla de contenidos, la gente editorial técnica quiere que el TOC venga antes en el libro por razones de usabilidad.
Capítulos de Cuerpo
Oh, sí, y hay texto real en estos libros, ¡no todo es asunto frontal! 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.
Apéndices
Como saben, los apéndices son para material que simplemente no parece encajar en la parte principal de un libro pero tampoco se puede dejar fuera del libro. Los apéndices suelen ser el lugar para mesas grandes y poco manejables. Algunas publicaciones técnicas tienen cosas como garantías en los apéndices. En términos de formato, un apéndice es como un capítulo, excepto que se llama “Apéndice A” o algo así, y los encabezados y pies de página coinciden con esa convención de numeración y denominación diferente (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. Observe que la mayoría de los glosarios utilizan un diseño de dos columnas. Normalmente, cada término y su definición conforman un párrafo separado con el término minúsculas (a menos que sea un nombre propio) y en negrita, seguido de un punto y luego la definición en romano regular. Observe también que las definiciones normalmente no son oraciones completas. Las definiciones múltiples se identifican típicamente 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 suelen ser de dos columnas y también contienen Ver referencias a términos preferidos y Ver también referencias a términos relacionados.
Formulario de respuesta del lector
Antes del auge de Internet y las redes sociales, algunas publicaciones técnicas contenían un formulario impreso para permitir a los lectores enviar comentarios, preguntas y evaluación del libro. Por supuesto, resulta que estos formularios con mayor frecuencia suscitan quejas sobre la función defectuosa en el producto que documenta el libro. Con el auge de Internet, estos formularios se han puesto en línea, y los libros simplemente apuntan a su ubicación en línea.
Diseño y maquetación de libros
Por lo general, las guías de usuario y los manuales 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 su producto a veces cada nueve meses. En este contexto, el diseño sofisticado simplemente no es práctico. Estas son algunas de las características típicas de diseño y diseño que verás:
- El tamaño de la página a menudo está determinado por consideraciones de empaque, así como por tamaños de página estándar disponibles con las empresas de impresión. Cuando el tamaño de la página no es una restricción, algunas compañías usarán el tamaño de página de 8.5 × 11 pulgadas, esto facilita mucho la producción para los escritores.
- Por lo general, las páginas se diseñan con páginas alternas derecha e izquierda. El pie de página de la 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 derecha (impar) comienza con el título del capítulo y termina con el número de página.
- La práctica es mixta sobre si la numeración de 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 cabecera colgante de los encabezados en relación con las páginas es bastante común en los manuales técnicos. La sangría para colgar 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 utilizan interlineado estándar y espaciado entre palabras.
- Los márgenes son bastante estándar, de una a dos pulgadas en todos los sentidos. Por lo general, se usa media pulgada adicional en los márgenes interiores para permitir la encuadernación.
- Por lo general, el color no se usa en estos manuales y guías, generalmente por consideraciones de costo y eficiencia.