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 que queremos dizer aqui é o clássico índice no final do livro que mostra os números de página em que os tópicos e subtópicos ocorrem dentro do livro. Um índice online é muito semelhante, exceto que você fornece links de hipertexto em vez de números de página.
Índice em um documento impresso
Índice em um sistema de ajuda online (painel esquerdo)
Rascunho de um Índice
Assim como em qualquer projeto de escrita, há uma fase de esboço 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 tipo de terminologia eles podem estar acostumados. Depois disso, aqui está o que fazer a seguir:
- Converter cada título em múltiplas entradas de índice. Títulos 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 basta simplesmente copiar títulos diretamente para um índice e ir embora. Como você verá abaixo, você precisa criar entradas baseadas em títulos de maneira cruzada da forma mais prática possível.
- Liste cruzadamente cada entrada. Rearranje cada uma de suas entradas baseadas em cabeçalhos de tantas maneiras práticas quanto você puder. Por exemplo, um cabeçalho 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." Essas entradas cruzadas tentam antecipar todas as maneiras prováveis que um leitor pode procurar por este tópico em um índice: "tela," "resolução," ou "mudando."
Aqui estão alguns exemplos adicionais:
Título Índices de entradas Otimização da Exibição de Vídeo exibição de vídeo, otimizando
otimizando a exibição de vídeo
exibição, otimizando vídeoReproduzindo Multimídia em Streaming streaming multimídia, tocando
jogando mídia multimídia em streaming
multimídia, reprodução de streamingNoções Básicas de Rede rede de contatos
redesIntroduzindo Multimídia em Streaming streaming multimídia
multimídia, streaming
Observe que você nem sempre pode listar entradas de índice de palavras cruzadas em todas as palavras. Por exemplo, "introduzindo multimídia em streaming" no trecho anterior simplesmente não funcionaria. Algum leitor já procuraria esse tópico começando por "introduzindo"? - Criar entradas de sinônimos. Os leitores não necessariamente usam a mesma terminologia que você usa na sua documentação. Eles podem chamar uma unidade de disquete de "driver 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. Assim, você indica aos leitores 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 de í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 de índice adicionais. Normalmente, não é suficiente indexar apenas pelos cabeçalhos. É preciso aprofundar-se no texto em busca de conceitos, termos e tarefas que não estão representados pelos cabeçalhos. Por exemplo, sob o título "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 essas entradas de índice adicionais: "fluxos de captura" e "fluxos de codificação".
- Índice de matérias iniciais e finais. Não se esqueça de vasculhar o prefácio, avisos de segurança, apêndices e outros periféricos para entradas adicionais no índice. Normalmente, números e endereços de suporte técnico são mostrados 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 de índice Entradas clonadas e sinônimos suporte técnico suporte, técnico
mesa de ajuda
problemas
Revisando e Refinando um Índice
Uma vez que você tenha listado todas as entradas do índice que consegue pensar, é hora de ver como o índice fica e começar a trabalhá-lo. Para revisar um índice em rascunho:
- Crie um índice de primeira versão. Uma vez que você tenha criado o máximo de entradas de índice, listagens cruzadas e sinônimos que puder, é 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 com que seu aplicativo de software faça isso por você. Por exemplo, se você trabalha em um sistema de editoração eletrônica, você revisou 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.
- Descarte entradas inúteis. Nos passos anteriores, você esteve rascunhando o índice. Nessa fase, não se prenda à formulação exata das entradas ou à probabilidade de que alguém as utilize. Mas agora é hora de começar a eliminar as entradas que nenhum leitor jamais usaria. Por exemplo, entradas de primeiro nível começando com "introduzindo", "usando", "sobre" provavelmente não serão úteis. Delete-as! Mas não as exclua do índice já construído. Volte ao seu documento e elimine a entrada original do índice.
- 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, multimídia em streamingtecnologias, multimídia em streaming exibição de vídeo
exibições de vídeoexibições de vídeo alterar a resolução da tela
mudando a resolução da telamudando a resolução da tela
Como você pode ver nesses exemplos, entradas singulares/plurais e variações de verbos são as causas mais comuns de frases semelhantes em entradas de índices. Seu estilo de escrita pode ditar o uso de singulares em vez de plurais. De qualquer maneira que você lide com isso, apenas seja consistente. - Agrupar entradas semelhantes. 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 semelhantes 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
- Refazer entradas com entradas excessivas na página. Algumas organizações têm regras de guia de estilo reais sobre quantas referências de página após uma entrada de índice são permitidas. 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ágina anônimas como esta não ajuda ninguém. Em vez disso, identifique o subtópico para essas referências de página. Aqui está um exemplo:
Referências de página não identificadas demais 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 você não costuma ver em índices é o intervalo de páginas em que um tópico é discutido—mesmo que não haja subitens. Se fosse preciso, você poderia ter uma entrada como esta: "projetores, 126–137" - Procure por agrupamentos de entradas. 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 (as entradas estão espalhadas pelo índice) Caixa de diálogo Adicionar Usuário
...
Caixa de diálogo Deletar Usuário
...
Caixa de diálogo para Novo Usuário
...
Caixa de diálogo da 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 de nível. No seu trabalho de indexação, você pode ter algumas subentradas que precisam ser copiadas como entradas principais.
Entradas Entradas deslocadas para cima
(os itens estão espalhados 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 pensou que alguns (provavelmente não muitos) leitores procurariam "polaridade" primeiro em vez de "baterias, polaridade." Da mesma forma, o indexador achou que as pessoas poderiam procurar "descarte" primeiro. Embora possibilidades como essas sejam pequenas, coloque-as no índice assim mesmo.- Procure por Veja também e adicional Ver referências. Próximo 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 um ao outro. E não se esqueça do Ver referências: essas direcionam 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 interno ou referenciá-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 costumam usar letras minúsculas em todas as entradas que não sejam 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. Alguns estilos exigem que você use o mesmo destaque no índice que usa no texto principal. Se algo estiver 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 projeto, 451-461
projetores
compilando 154-155
considerações 156
controles 136
definido 124, 136, 157
Perfis de projetos 451-461
Note no exemplo à direita que não há vírgula entre o termo do índice e as referências da 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 do í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 é, afinal, 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 Creative Commons Atribuição 4.0 Internacional. - Procure por entradas de aumento de nível. No seu trabalho de indexação, você pode ter algumas subentradas que precisam ser copiadas como entradas principais.