Como redator técnico, você geralmente terá que criar índices para os livros impressos e para as ajudas online que desenvolve. O tipo de índice a que nos referimos aqui é o clássico índice no final do livro, que mostra os números das páginas em que os tópicos e subtópicos ocorrem dentro do livro. Um índice online é muito parecido, exceto que você fornece links de hipertexto em vez de números de páginas.
Índice em um documento impresso
Índice em um sistema de ajuda online (painel esquerdo)
Rascunhando um Índice
Assim como em qualquer projeto de escrita, há uma fase de rascunho para a indexação. E, claro, você precisa pensar no seu público—quem eles são, como usarão o índice, por que o utilizarão e que tipos de terminologia podem estar acostumados. Depois disso, aqui está o que fazer a seguir:
- Converter cada título em várias entradas de índice. Os cabeçalhos são um bom lugar para começar: eles indicam tópicos e subtópicos—precisamente o que um índice faz. No entanto, não copie apenas os cabeçalhos diretamente para um índice e se afaste. Como você verá abaixo, você precisa relacionar entradas baseadas em cabeçalhos de tantas maneiras quanto possível na prática.
- Liste cruzadamente cada entrada. Reorganize cada um dos seus itens baseados em títulos da maneira mais prática possível. Por exemplo, um título como "Mudando a resolução da tela" pode ser indexado como "resolução da tela, mudando" assim como "mudando a resolução da tela." Você também pode incluir "resolução, mudando a tela." Esses itens cruzados tentam antecipar todas as prováveis maneiras que um leitor pode procurar por este tópico em um índice: "tela," "resolução," ou "mudando."
Aqui estão alguns exemplos adicionais:
Cabeçalho Entradas do índice Otimização da Exibição de Vídeo exibição de vídeo, otimizando
otimização da exibição de vídeo
exibir, otimizando vídeoReproduzindo Multimídia em Streaming streaming de multimídia, reprodução
streaming de multimídia em reprodução
multimídia, jogando streamingNoções Básicas de Redes rede de computadores
redesIntroduzindo Multimedia Streaming streaming multimídia
multimídia, streaming
Observe que você não pode sempre listar entradas de índice em cada palavra. Por exemplo, "introduzindo multimídia em streaming" no anterior simplesmente não funcionaria. Algum leitor alguma vez procuraria este tópico começando com "introduzindo"? - Criar entradas de sinônimos. Os leitores não usam necessariamente a mesma terminologia que você em sua documentação. Eles podem chamar uma unidade de disquete de "unidade de disquete". Eles podem se referir a um display como "monitor". Como indexador, você deve antecipar essas variações comuns na terminologia. Nas entradas anteriores, seria uma boa ideia ter um sinônimo para "display de vídeo", como "monitor". Mas em vez de repetir os números das páginas, use um Ver referência. Dessa forma, você aponta os leitores para o termo preferido. (Claro, se houver apenas um número de página, basta repeti-lo com a entrada do sinônimo.)
Aqui estão alguns exemplos adicionais:
Entrada do índice Entradas de sinônimos volume, ajustando volume, ajustando taxa de transmissão velocidade, transmissão capturando vídeo copiando vídeo - Revise o texto para entradas adicionais no índice. Normalmente, não é suficiente apenas indexar por cabeçalhos. Você precisa aprofundar-se no texto em busca de conceitos, termos e tarefas que não estão representados pelos cabeçalhos. Por exemplo, sob o cabeçalho "Criando um Fluxo Multimídia", você pode ver definições de "captura" e "codificação". Esses são termos importantes, mas não aparecem em nenhum dos cabeçalhos—indexe-os também! Neste caso, você gostaria de criar estas entradas de índice adicionais: "captura de fluxos" e "codificação de fluxos."
- Índice de front e back matter. Não se esqueça de explorar o prefácio, avisos de segurança, apêndices e outros periféricos semelhantes em busca de entradas adicionais no índice. Normalmente, os números de suporte técnico e endereços são exibidos no prefácio. Indexe-os—e não se esqueça de criar entradas cruzadas e entradas de sinônimos para eles também.
Entrada no índice Entradas clonadas e sinônimos suporte técnico suporte, técnico
balcão de ajuda
problemas
Revisando e Refinando um Índice
Depois de gerar todas as entradas do índice que você consegue pensar, é hora de ver como o índice se parece e começar a trabalhá-lo. Para revisar um índice em rascunho:
- Construa um índice de primeira versão. Uma vez que você tenha criado o maior número possível de entradas de índice, listagens cruzadas e sinônimos, é hora de "construir" um primeiro rascunho do índice. A menos que você esteja trabalhando da maneira antiga com cartões de índice, você pode fazer seu aplicativo de software fazer isso por você. Por exemplo, se você trabalha em um sistema de editoração eletrônica, você já percorreu seu texto inserindo entradas de índice. O mesmo processo se aplica a ferramentas de criação de ajuda. Ao construir o índice do primeiro rascunho, não se desanime. É apenas um rascunho inicial, ao qual você precisará aplicar vários tipos de revisão.
- Descartar entradas inúteis. Nos passos anteriores, você esteve esboçando o índice. Nessa fase, você não se preocupa com a formulação exata das entradas ou a probabilidade de alguém utilizá-las. Mas agora é hora de começar a eliminar as entradas que nenhum leitor jamais usaria. Por exemplo, entradas de primeiro nível que começam com "introduzindo", "usando", "sobre" não são propensas a serem úteis. Apague-as! Mas não as delete do índice montado. Volte ao seu documento e elimine a entrada do índice original.
- Consolide entradas com frases semelhantes. Você também encontrará muitas entradas que têm apenas variações menores na redação. Por exemplo:
Rascunhos de entradas Entradas revisadas tecnologia, streaming de multimídia
tecnologias, streaming de multimídiatecnologias, multimídia em streaming exibição de vídeo
exibições de vídeodisplays de vídeo mudar a resolução da tela
alterando a resolução da telamudando a resolução da tela
Como você pode ver nestes exemplos, entradas singulares/plurais e variações verbais são as causas mais comuns de formulações similares nas entradas do índice. Seu estilo de redação pode ditar o uso de singulares em vez de plurais. De qualquer forma que você lidar com isso, apenas seja consistente. - Agrupe entradas similares. Você também verá entradas que precisam ser agrupadas e subordinadas. Por exemplo, todas podem começar com a mesma palavra, mas ter modificadores diferentes. Aqui está um exemplo:
Entradas similares Entradas agrupadas e subordinadas projetor, definido
projetores, compilando
projetores, considerações
projetores, criando
projetores, solução de problemas
projetores compilando
considerações
criando
definido
solução de problemas
- Reformule entradas com entradas excessivas de página. Algumas organizações têm regras de guia de estilo sobre quantas referências de página podem seguir uma entrada no índice. Três é um máximo comum; dois é agressivo, ambicioso. Por exemplo, "sintaxe de programação, 12, 45, 74, 122, 219, 222." Uma sequência de referências de páginas anônimas como essa não ajuda ninguém. Em vez disso, identifique o subtópico dessas referências de página. Aqui está um exemplo:
Referências de página não identificadas em excesso Entradas subordinadas e rotuladas projetores, 124, 136, 154-155, 156 157 projetores
compilando, 154-155
considerações, 156
controles, 136
definido, 124, 136, 157
Um toque muito bom que não se vê com frequência em índices é a faixa de páginas na qual um tópico é discutido—mesmo que não haja subentradas. Se fosse preciso, você poderia ter uma entrada assim: "projetores, 126–137" - Procure por agrupamentos de entrada. Um toque útil em índices é procurar maneiras de agrupar entradas. Por exemplo, imagine um guia do usuário que explica as várias caixas de diálogo que aparecem no aplicativo. Há a caixa de diálogo de Senha, a caixa de diálogo de Novo Usuário, a caixa de diálogo de Excluir Usuário, e assim por diante. Que tal repetir todas essas entradas sob "caixas de diálogo"?
Entradas Entradas agrupadas (os artigos estão espalhados pelo índice) Caixa de diálogo Adicionar Usuário
...
Caixa de diálogo Excluir Usuário
...
Caixa de diálogo de Novo Usuário
...
Caixa de diálogo de senhaCaixa de diálogo Adicionar Usuário
...
Caixa de diálogo Excluir Usuário
...
caixas de diálogo
Adicionar Usuário
Excluir Usuário
Novo Usuário
Senha
...
Caixa de diálogo de Novo Usuário
...
Caixa de diálogo de senha- Procure por entradas de aumento. Em seu trabalho de indexação, você pode ter algumas subentradas que precisam ser copiadas como entradas principais.
Entradas Entradas deslocadas para cima
(as entradas estão espalhadas pelo índice)baterias
descarte, 33
aviso de explosão, 34
recomendação do fabricante, 34
polaridade, 33-34
compra, 33
substituindo, 33-34
abas, 33(ilus)
baterias
descarte, 33
aviso de explosão, 34
recomendação do fabricante, 34
polaridade, 33-34
compras, 33
substituindo, 33-34
abas, 33(ilus)
descarte, baterias, 33
...
polaridade, baterias, 33-34
...
aviso, baterias, 34
...
Neste exemplo, o indexador achou que alguns (provavelmente não muitos) leitores procurariam "polaridade" primeiro, em vez de "baterias, polaridade." Da mesma forma, o indexador pensou que as pessoas poderiam procurar "descarte" primeiro. Mesmo que essas possibilidades sejam pequenas, coloque-as no índice de qualquer forma.- Procure por Veja também e adicional Ver referências. Toward the end of your revising phase, take a look at your index for the possibility of Ao final da sua fase de revisão, dê uma olhada no seu índice para a possibilidade de Veja também referências. Veja também as referências são para termos intimamente relacionados que os leitores podem escolher por engano. Por exemplo, nos antigos sistemas DOS, havia o copiar comando e o xcopy comando. Os dois comandos estão tão intimamente relacionados em nome e em função que você gostaria de colocar Veja também referências mútuas. E não se esqueça do Ver referências: aqueles que apontam os leitores de termos sinônimos para os termos que você prefere usar e indexar em seu livro.
- Verifique o estilo e a mecânica das entradas do índice. A organização para a qual você trabalha pode ter seu próprio guia de estilo ou encaminhá-lo a algum estilo padrão, como o Manual de Estilo de Chicago. Olhe para estes muito atentamente quanto à forma como eles indicam a capitalização e a pontuação das entradas do índice. Os índices geralmente usam letras minúsculas em todas as entradas que não são nomes próprios, mas uma certa porcentagem usa letras maiúsculas nas entradas de primeiro nível. A maioria dos estilos exige que você coloque uma vírgula logo após o termo do índice e antes dos números das páginas; mas alguns não o fazem. Alguns estilos exigem que você use o mesmo destaque no índice que usa no texto principal. Se algo é destacado em negrito no texto principal, eles querem que esteja em negrito no índice também.
Nota: Este capítulo utiliza uma variedade de estilos de pontuação e capitalização—não para confundi-lo, mas para torná-lo ciente da variabilidade estilística.
Um estilo de índice comum Outro estilo de índice comum projetores, 123
compilando, 154-155
considerações, 156
controles, 136
definido, 124, 136, 157
perfis de projetos, 451-461
projetores
compilando 154-155
considerações 156
controles 136
definido 124, 136, 157
Perfis de projetos 451-461
Observe no exemplo à direita que não há vírgula entre o termo do índice e as referências de página. Além disso, você encontrará que alguns padrões e estilos de indexação desaprovam ter uma referência de página em uma entrada de índice que possui subentradas: por exemplo, "projetores, 123" no exemplo à esquerda. Por que a referência da página 123 não está entre as subentradas? Qual é o subtópico na página 123?
Eu apreciaria seus pensamentos, reações e críticas em relação a este capítulo: sua resposta.
Informações e programas fornecidos por mcmassociates.io, 1995-2026.
Este trabalho é licenciado sob uma Licença Internacional Creative Commons Atribuição 4.0. - Procure por entradas de aumento. Em seu trabalho de indexação, você pode ter algumas subentradas que precisam ser copiadas como entradas principais.