Como redactor técnico, normalmente tendrás que crear índices para los libros impresos y para los sistemas de ayuda en línea que desarrolles. El tipo de índice al que nos referimos aquí es el clásico índice al final del libro que muestra los números de página en los que aparecen los temas y subtemas dentro del libro. Un índice en línea es prácticamente lo mismo, excepto que proporcionas hipervínculos en lugar de números de página.
Índice en un documento impreso
Índice en un sistema de ayuda en línea (panel izquierdo)
Redacción preliminar de un índice
Como ocurre en cualquier proyecto de escritura, hay una fase de borrador inicial para la indexación. Y, por supuesto, necesitas pensar en tu audiencia—: quiénes son, cómo usarán el índice, por qué lo usarán y a qué tipo de terminología podrían estar acostumbrados. Después de eso, esto es lo que debes hacer a continuación:
- Convierte cada encabezado en múltiples entradas de índice. Los encabezados son un buen punto de partida: indican temas y subtemas—precisamente lo que hace un índice. Sin embargo, no te limites a copiar los encabezados directamente en un índice y ya está. Como verás a continuación, necesitas listar de forma cruzada las entradas basadas en encabezados de tantas maneras como sea prácticamente posible.
- Publica cada entrada en varios listados. Reordene cada una de sus entradas basadas en encabezados de tantas maneras prácticas como pueda. Por ejemplo, un encabezado como "Cambiar la resolución de pantalla" puede indexarse como "resolución de pantalla, cambiar" así como "cambiar la resolución de pantalla." También podría incluir "resolución, cambiar pantalla." Estas entradas cruzadas intentan anticipar todas las formas probables en que un lector podría buscar este tema en un índice: "pantalla", "resolución" o "cambiar".
Aquí tienes algunos ejemplos adicionales:
Encabezado Entradas del índice Optimizando la visualización de vídeo visualización de vídeo, optimización
optimizando la visualización de vídeo
pantalla, optimizando vídeoReproduciendo multimedia en streaming transmisión multimedia, reproduciendo
reproduciendo multimedia en streaming
multimedia, reproducción en streamingConceptos básicos de redes establecimiento de contactos
redesPresentando multimedia en streaming transmisión multimedia
multimedia, transmisión en streaming
Tenga en cuenta que no siempre se pueden crear entradas cruzadas en el índice para cada palabra. Por ejemplo, "introduciendo multimedia en streaming" en lo anterior simplemente no funcionaría. ¿Algún lector buscaría alguna vez este tema empezando por "introduciendo"? - Crear entradas de sinónimos. Los lectores no necesariamente usan la misma terminología que usted emplea en su documentación. Pueden llamar a una unidad de disquetes "disquetera". Pueden referirse a una pantalla como "monitor". Como indexador, debe anticipar estas variaciones comunes en la terminología. En las entradas anteriores, sería buena idea tener un sinónimo para "pantalla de vídeo" como "monitor". Pero en lugar de repetir los números de página, use un Ver referencia. De ese modo, diriges a los lectores hacia el término preferido. (Por supuesto, si solo hay un número de página, simplemente repítelo con la entrada del sinónimo.)
Aquí hay algunos ejemplos adicionales:
Entrada del índice Entradas de sinónimos volumen, ajustando sonoridad, ajustando tasa de transmisión velocidad, transmisión capturando vídeo copiando vídeo - Revise el texto en busca de entradas adicionales para el índice. Normalmente no es suficiente indexar solo por los encabezados. Tienes que profundizar en el texto en busca de conceptos, términos y tareas que no están representados por los encabezados. Por ejemplo, bajo el encabezado "Creación de una transmisión multimedia", podrías ver definiciones de "captura" y "codificación". Estos son términos importantes, pero no aparecen en ninguna parte de los encabezados—¡inclúyalos también! En este caso, querrías crear estas entradas adicionales del índice: "captura de transmisiones" y "codificación de transmisiones".
- Índice, material preliminar y material final. No olvides revisar el prefacio, los avisos de seguridad, los apéndices y otros anexos similares en busca de entradas adicionales para el índice. Normalmente, los números y direcciones de soporte técnico aparecen en el prefacio. Índicalos—y no olvides crear también entradas con referencias cruzadas y entradas sinónimas para ellos.
Entrada de índice Entradas clonadas y sinónimas soporte técnico soporte, técnico
mesa de ayuda
problemas
Revisando y afinando un índice
Una vez que hayas anotado todas las entradas de índice que se te ocurran, es hora de ver cómo queda el índice y empezar a trabajarlo. Para revisar un índice en borrador:
- Elabora un índice preliminar. Una vez que haya creado tantas entradas de índice, remisiones cruzadas y sinónimos como pueda, es hora de "construir" un primer borrador del índice. A menos que esté trabajando a la antigua con fichas de índice, puede pedirle a su aplicación de software que haga esto por usted. Por ejemplo, si trabaja en un sistema de autoedición, habrá repasado su texto insertando entradas de índice. El mismo proceso se aplica a las herramientas de creación de ayuda. Cuando genere el primer borrador del índice, no se desanime. Es solo un borrador preliminar, al que deberá aplicar varios tipos de revisión.
- Descarta entradas inútiles. En los pasos anteriores has estado redactando un borrador del índice. En esa fase no te obsesionas con la redacción exacta de las entradas ni con la probabilidad de que alguien las llegue a utilizar. Pero ahora es el momento de empezar a eliminar las entradas que ningún lector utilizaría jamás. Por ejemplo, las entradas de primer nivel que empiezan con "introducción", "uso", "acerca de" probablemente no sean útiles. ¡Bórralas! Pero no las borres del índice ya construido. Vuelve a tu documento y elimina la entrada original del índice.
- Consolidar entradas con una redacción similar. También encontrarás muchas entradas que solo tienen pequeñas variaciones en la redacción. Por ejemplo:
Entradas en borrador Entradas revisadas tecnología, transmisión multimedia
tecnologías, transmisión multimediatecnologías, transmisión multimedia pantalla de vídeo
pantallas de vídeopantallas de vídeo cambiar la resolución de la pantalla
cambiando la resolución de pantallacambiando la resolución de pantalla
Como puede ver en estos ejemplos, las entradas en singular/plural y las variaciones verbales son las causas más comunes de frases similares en las entradas del índice. Su guía de estilo puede dictar el uso de singulares en lugar de plurales. Sea cual sea la forma en que los maneje, simplemente sea coherente. - Agrupa entradas similares. También verá entradas que necesitan agruparse y subordinarse. Por ejemplo, pueden todas comenzar con la misma palabra, pero tener modificadores distintos. Aquí tiene un ejemplo:
Entradas similares Entradas agrupadas y subordinadas proyector, definido
proyectores, compilando
proyectores, consideraciones
proyectores, creando
proyectores, solución de problemas
proyectores compilando
consideraciones
creando
definido
solución de problemas
- Reelaborar las entradas que contienen un número excesivo de páginas. Algunas organizaciones tienen reglas reales en sus guías de estilo sobre cuántas referencias de página que siguen a una entrada de índice son permitidas. Tres es un máximo común; dos es agresivo, ambicioso. Por ejemplo, "sintaxis de programación, 12, 45, 74, 122, 219, 222." Una cadena de referencias de página anónimas como esta no ayuda a nadie. En su lugar, identifique el subtema para estas referencias de página. Aquí hay un ejemplo:
Demasiadas referencias de página no identificadas Entradas subordinadas y etiquetadas proyectores, 124, 136, 154-155, 156 157 proyectores
compilación, 154-155
consideraciones, 156
controles, 136
definido, 124, 136, 157
Un detalle muy bueno que no se suele ver en los índices es el rango de páginas en el que se discute un tema—incluso si no hay subentradas. Si fuera exacto, podrías tener una entrada como esta: "proyectores, 126–137" - Busque agrupaciones de entradas. Un toque agradable y útil en los índices es buscar maneras de agrupar las entradas. Por ejemplo, imagina una guía del usuario que explica los distintos cuadros de diálogo que aparecen en la aplicación. Está el cuadro de diálogo de contraseña, el cuadro de diálogo de nuevo usuario, el cuadro de diálogo de eliminar usuario, y así sucesivamente. ¿Qué tal repetir todas esas entradas bajo «cuadros de diálogo»?
Entradas Entradas agrupadas (las entradas están dispersas por todo el índice) Cuadro de diálogo Agregar usuario
...
Cuadro de diálogo: Eliminar usuario
...
Cuadro de diálogo de nuevo usuario
...
Cuadro de diálogo de contraseñaCuadro de diálogo Agregar usuario
...
Cuadro de diálogo Eliminar usuario
...
cuadros de diálogo
Agregar usuario
Eliminar usuario
Nuevo usuario
Contraseña
...
Cuadro de diálogo de nuevo usuario
...
Cuadro de diálogo de contraseña- Busca entradas de "shift-up". En su trabajo de indexación, puede que tenga algunas subentradas que necesiten copiarse como entradas principales.
Entradas Entradas desplazadas hacia arriba
(las entradas están dispersas a lo largo del índice)baterías
eliminando, 33
advertencia de explosión, 34
recomendación del fabricante, 34
polaridad, 33-34
compras, 33
reemplazando, 33-34
pestañas, 33 (ilustrado)
baterías
desechando, 33
advertencia de explosión, 34
recomendación del fabricante, 34
polaridad, 33-34
compras, 33
reemplazando, 33-34
pestañas, 33 (ilustraciones)
eliminación, pilas, treinta y tres
...
polaridad, pilas, 33-34
...
advertencia, baterías, 34
...
En este ejemplo, el indexador pensó que algunos (probablemente no muchos) lectores buscarían "polaridad" primero en lugar de "pilas, polaridad". De forma similar, el indexador pensó que la gente podría buscar "eliminación" primero. Aunque posibilidades como estas sean pequeñas, inclúyelas en el índice de todos modos.- Busca Véase también y adicional Ver referencias. Hacia el final de tu fase de revisión, echa un vistazo a tu índice en busca de la posibilidad de Véase también referencias. Véase también Las referencias son para términos estrechamente relacionados que los lectores podrían elegir por error. Por ejemplo, en los antiguos sistemas DOS, había el copia comando y el xcopy comando. Los dos comandos están tan estrechamente relacionados en nombre y en función que querrías poner Véase también referencias entre sí. Y no olvides la Ver referencias: esas dirigen a los lectores desde términos sinónimos hacia los términos que prefieres usar y por los que indizas en tu libro.
- Revise el estilo y la mecánica de las entradas del índice. La organización para la que trabajas puede tener su propio manual de estilo interno o remitirte a algún estilo estándar como el Manual de estilo de Chicago. Fíjese muy cuidadosamente en estos para ver cómo le indican que debe usar mayúsculas y puntuación en las entradas del índice. Los índices comúnmente usan minúsculas en todas las entradas que no son nombres propios, pero cierto porcentaje sí utiliza mayúscula inicial en las entradas de primer nivel. La mayoría de los estilos requieren que coloque una coma justo después del término del índice y antes de los números de página; pero algunos no. Algunos estilos requieren que use el mismo resaltado en el índice que en el texto principal. Si algo está en negrita en el texto principal, también lo quieren en negrita en el índice.
Nota: Este capítulo utiliza una variedad de estilos de puntuación y uso de mayúsculas—no para confundirte, sino para hacerte consciente de la variabilidad estilística.
Un estilo común de índice Otro estilo común de índice proyectores, ciento veintitrés
compilación, 154-155
consideraciones, 156
controles, 136
definido, 124, 136, 157
perfiles de proyectos, 451-461
proyectores
compilando 154-155
consideraciones 156
controles 136
definido 124, 136, 157
Perfiles de proyectos 451-461
Observe en el ejemplo de la derecha que no hay coma entre el término del índice y las referencias de página. Además, verá que algunas normas y estilos de indexación desaprueban que haya una referencia de página en una entrada del índice que tiene subentradas: por ejemplo, "proyectores, 123" en el ejemplo de la izquierda. ¿Por qué la referencia a la página 123 no aparece entre las subentradas? ¿Cuál es exactamente el subtema en la página 123?
Agradecería sus opiniones, reacciones y críticas con respecto a este capítulo: tu respuesta.
Información y programas proporcionados por mcmassociates.io, 1995-2026.
Esta obra está licenciada bajo una Licencia Creative Commons Atribución 4.0 Internacional. - Busca entradas de "shift-up". En su trabajo de indexación, puede que tenga algunas subentradas que necesiten copiarse como entradas principales.