Vous êtes sur la page 1sur 86

Título do livro

The Art of Indexing

Autor

Larry S. Bonura

Referência

BONURA, Larry S. The art of indexing. New York: Wiley, 1994. 233 p.

Resumo

RESUMO

Um guia passo a passo para criar índices técnicos abrangentes e utilizáveis. Inúmeras pesquisas indicam que a queixa mais comum sobre documentos técnicos diz respeito a um índice mal projetado - ou à falta de um índice! Um índice organizado e ponderado não apenas garante que o conteúdo do seu livro seja acessível, mas também aumenta o valor do seu livro. Em “The Art of Indexing”, o indexador profissional e consultor editorial Larry Bonura aborda os problemas de indexação específicos da documentação técnica e apresenta soluções práticas para esses problemas. Mostra redatores técnicos, editores e gerentes de documentação como mapear os tópicos de seus livros, relatórios e documentos e apresentar um mapa conciso e preciso que leitores, pesquisadores, bibliotecas, livrarias e revisores podem usar para maximizar a utilidade do seu livro. “The Art of Indexing” mostra como se tornar um melhor indexador: Discutindo a função de um índice; Mostrando como estimar o tempo de indexação; Apresentação de métodos para seleção de entradas e subentradas; Revisar razões para referência cruzada; Descrevendo como tratar os localizadores; Oferecendo uma extensa lista de verificação para revisão de índices; Cobertura de indexação para documentos on-line; Incluindo inúmeros testes de usabilidade para verificar a força de um índice; Contendo informações sobre padrões de indexação; Fornecendo índices de amostra e um guia de estilo de indexação de amostra. (Resumo retirado do site Amazon).

Referência do

THE ART art of indexing. Amazon, 20--. Disponível em:

resumo

Acesso em: 10 maio 2019.

SUMÁRIO

1

Apresentando o Índice

9

Visão global

9

Por que indexar?

9

Adicionando valor

9

O que é um índice?

10

Funções de

um índice

10

Informação

planejada

11

Resumindo o livro

11

2

Se tornando um indexador

12

Quem deve ser o indexador?

12

Escritores técnicos como indexadores

12

Indexadores profissionais

13

Traços de bons indexadores

13

3

Índices técnicos

15

Índices de livros

15

Índices de assuntos alfabéticos

15

4

Determinando audiências

17

Usuários do índice em geral

17

Determinando audiências

17

5

Alcançar

19

Alcançar a integralidade

19

Exaustividade

 

19

Precisão

19

Fidelidade do texto

20

Usabilidade

20

6

Critérios para um bom índice

21

Cinco critérios para um bom índice

21

Precisão

21

Profundidade de indexação

21

Concisão

21

Referência cruzada

22

Cabeçalhos Lógicos

22

Critérios da Medalha Wheatley

23

7

Respondendo questões

25

Foco da tarefa

25

Mudando sua mentalidade

25

Amostra de resposta à pergunta

25

Antecipando perguntas

26

Encontrar perguntas

26

Atendendo às necessidades dos leitores

27

Conhecendo seu cliente

27

Conhecendo seu produto

27

Índice como produto

28

Alterando o papel do indexador

28

Alterando os materiais de apoio

28

Fazendo trade-offs

28

Vendendo os benefícios

28

Pensamento final

29

8

Definindo os Elementos do Índice

30

Elementos do índice

30

Entradas

30

Localizadores

30

Referências cruzadas

30

9

Selecionando tópicos

30

Analisando tópicos

31

Um método rápido para indexação

32

Informações de indexação: Mapeando documentos

32

10

Descrevendo tópicos

34

Descrevendo os tópicos

34

Selecionando termos para tópicos

34

Vantagens

34

Desvantagens

35

Sinônimos

35

Agrupamentos

35

Usando subentradas

35

Com linhas de números de página

35

Combinando Entradas

36

Relações gramaticais

36

Alfabetizando

37

Entrando termos

37

Colocando em letras maiúsculas

37

Acrônimos e abreviações

37

Jargão

38

Singular vs. plural

38

11

Organizando tópicos

39

Usando ênfase

39

Cuidado com factoring

39

Usando economias de tamanho

39

12

Tratamento de casos especiais

40

Restrições

40

Definições

40

Acrônimos e abreviações

40

Referindo-se a outras publicações

41

Assuntos numéricos e de símbolos

41

13

Escrevendo o índice em ordem alfabética

43

Métodos para escrever em ordem alfabética

43

Letra por

letra

43

Palavra por palavra

 

43

Escolhendo um ou outro

43

Ordem alfabética

44

14

Criando referências cruzadas

45

Criando referências cruzadas

 

45

Referências Ver

46

Referências ver também

46

Onde colocar o ver também

47

Abaixo do cabeçalho principal

 

47

Como o último subcabeçalho

47

A

direita do cabeçalho principal

47

No final da página referências

47

Colocação de arquivos eletrônicos

48

15

Trabalhando com localizadores

49

Números inclusivos

49

Estilos para números inclusivos

49

Regras para usar elisão

49

Referências “Nontext”

50

16

Preparando cartões de índice

51

Começando

 

51

Usando cartões de índice

51

Marcando entradas

51

Transferindo entradas

para cartões

51

Arrumando os cartões

52

Editando os cartões

53

Marcando os cartões para digitação

53

17

Automatizando o processo

54

O que significa automatizar

54

Quatro métodos automatizados

54

Programas de indexação de propósito único

54

Pacotes de publicação eletrônica

54

Processadores de texto

55

Utilitários de indexação

55

Construindo um índice eletronicamente

56

Colocação de arquivos eletrônicos

56

Alguns cuidados

56

18

Criando em vez de mestre

58

Índices mestres

58

Usando algarismos romanos

58

 

Usando

títulos abreviados

59

Usando algarismos arábicos

59

Projetos de rodapé

59

19

Formatando o índice

61

Formatos e tipografia

61

Design básico da página

61

Margens do lado direito

61

Hifenizações

61

Título do índice

61

Cabeçalhos de letras

62

Atributos de texto

62

Crie seu próprio capítulo

62

Paginação

62

Cabeçalhos e rodapés

62

Convenções notacionais

62

Formatos de entrada

62

Formulário de execução

63

Formulário linha por linha

63

Envoltórios de linha

63

Saltar entradas

63

Indução

64

Detalhes de estilo

64

20

Gerenciando o índice

66

Determinando o tamanho

66

Calculando tempo e custo

66

 

Estimando

o tempo

67

Estimando

custo

67

21

Editando o índice

69

Sempre edite o índice

69

Formato de índice

69

Localização ver e ver também

69

Índices linha a linha

70

Índices de execução

70

Lista de verificação de edição

70

22

Testando

o índice

73

Testando os cinco critérios básicos

73

Precisão

73

Profundidade apropriada

73

Concisão

74

Referências cruzadas

74

Logicalidade

75

Alguns outros testes de usabilidade

76

Escolha de Parágrafo

76

Números de página em negrito

76

Entradas de verificação de pontos, assuntos

76

Verificando a integridade

77

23

Dicas de indexação

78

Doze dicas para melhor indexação

78

Coisas que não devem ser indexadas

78

Alguns fazem e não fazem

79

24

Indexação online

80

Indexação humana vs. máquina

80

Hipertexto definido

81

Interesse crescente

81

Critérios para um bom índice online

82

Estratégias de pesquisa

82

25

Padrões de

Indexação

84

Necessidade de padrões

84

Organizações de Padrões

84

ANSI / NISO Z39.4

85

Marcação genérica

85

9

1 Apresentando o Índice

Índice definido

E em tais índices (embora pequenas picadas para seus volumes

subseqüentes) se vê A figura do bebê da massa gigante Das coisas que virão

em geral - William Shakespeare, Troilo e Cressida

Visão global Os leitores merecem índices de alta qualidade, abrangentes e fáceis de ler. É o seu trabalho como redator técnico ser minucioso, mas conciso. Um índice bem desenvolvido melhora significativamente a utilidade de um documento.

Criar um índice requer que você saiba o que constitui um índice de alta qualidade e entenda os métodos de indexação. Este livro apresenta os métodos e etapas necessários para criar índices de alta qualidade para seus documentos técnicos. Aborde a indexação com a mesma tenacidade para precisão e integridade que você usa ao escrever um capítulo.

Por que indexar? Por que você deveria indexar seu manual?

A razão mais óbvia para você indexar seu livro é porque seus clientes o querem indexado. Numerosas pesquisas indicam que as queixas mais comuns sobre documentos técnicos são a falta de um índice ou um índice mal projetado. Qualquer um é um faux pas sério. Se você não acha que precisa de um índice, pense novamente. Seu cliente diz que você faz. Se não por outro motivo, inclua um índice completo para o seu cliente.

Um índice ponderado aumenta o valor de qualquer livro. Isso ajuda a garantir que o livro seja usado com frequência porque o conteúdo desse livro está acessível.

Adicionando valor

Um bom índice torna qualquer livro mais valioso para todos os leitores:

Os pesquisadores não vão ou não podem usar um livro que não tenha um.

Pesquisadores acham um bom índice útil na avaliação de um livro.

Os leitores preferem livros com bons índices, para que possam encontrar o que lhes interessa ou localizar informações específicas.

Se o documento for vendido em uma livraria ou comprado por uma biblioteca,

considere-o: As bibliotecas normalmente não compram um livro sem um índice. Os

10

navegadores de lojas geralmente tomam decisões sobre compras de livros com base no que encontram ou não encontram em um índice. Os revisores geralmente elogiam o índice e o livro.

O que é um índice? Um índice é um dispositivo de recuperação, um auxílio de acesso. Mas não é uma lista de termos ou idéias, como uma tabela de conteúdos ou uma concordância, que é uma lista alfabética de palavras em um documento com seus contextos imediatos. Nem um índice nem uma concordância sistematicamente analisa os tópicos.

Um índice é uma análise tópica sistemática organizada em ordem alfabética ou organizada por função, comando, procedimento ou tópico. É o mapa mais importante de um leitor para localizar informações em um documento que é lido em um estilo de acesso aleatório.

Um índice é uma das partes mais importantes de um bom documento técnico.

Funções de um índice Um índice direciona o leitor para um tópico específico. Essa é a tarefa principal de qualquer índice. Deve permitir ao leitor encontrar tópicos de acordo com o modo de pensar do leitor - é perfeitamente aceitável incluir palavras e frases não técnicas em índices.

Um índice também deve permitir que leitores com diferentes graus de conhecimento localizem tópicos. Isso é feito mostrando como um tópico está relacionado a outros tópicos no documento.

tópico é uma subdivisão de outro tópico?

Abrange outros tópicos?

É independente de outros tópicos?

Um índice deve ajudar um leitor a usar um documento, mesmo que o leitor tenha tópicos confusos, não tenha conhecimento de um tópico equivalente ou esteja acostumado a uma terminologia diferente. (Use referências cruzadas para ajudar o leitor a encontrar um tópico facilmente.) Por outro lado, um índice deve ajudar um leitor a separar um documento quando um tópico desejado não é encontrado no índice.

Em geral, o índice deve ser preenchido quando o documento for para sua primeira revisão. Isso dá à equipe de revisão a chance de usar o índice. Também mostra que o índice é tão importante quanto qualquer outro capítulo no documento.

11

Informação planejada Um índice reorganiza as informações em um documento, virando-o do avesso, se você quiser. A informação deve ser dividida e remontada em seus componentes. Esses componentes são então agrupados e organizados em uma forma ao mesmo tempo planejada e consistente e, portanto, facilmente consultados.

Lembre-se de que um índice não é uma tabela de conteúdos e nunca deve ser considerado um. Uma tabela de conteúdo é um resumo do plano do autor do livro, como o autor escolheu para apresentar o tema da maneira mais interessante e pensativa Um índice é o plano do indexer da informação dada pelo autor. Apresentar o material do autor da maneira mais conveniente.

Resumindo o livro Finalmente, um bom índice fornece aos leitores o escopo e o conteúdo de todo o livro em uma visão geral altamente condensada, como se o esboço e o tratamento do autor fossem embaralhados e remontados em ordem alfabética. Como índices, os melhores índices fornecem aos leitores todas as informações necessárias sobre o conteúdo do livro. Se o redator e o editor técnico estiverem confiantes nessa pontuação, o manual e seu índice estarão prontos para impressão - e para o leitor.

12

2 Se tornando um indexador

Indexador definido

Um escritor, por exemplo, destaca-se em um plano ou em uma página de título, outro trabalha fora do corpo do livro, e um terceiro é um pouco em um índice. - Oliver Goldsmith, The Bee

Quem deve ser o indexador? Com muita frequência, a indexação foi atribuída como tarefa administrativa a um subordinado do escritor ou, pior ainda, à força bruta de uma listagem automatizada de computadores. Em vez de uma simples tarefa clerical ou o foco de um grande número

de trituradores, compilar um índice é uma atividade criativa.

A indexação é um processo de decisão complexo que envolve discriminação

perceptiva, formação de conceitos e resolução de problemas. Os indexadores selecionam assuntos específicos relatados pelo autor; parafraseie os assuntos usando palavras que guiam as amplas áreas temáticas; selecione os termos das paráfrases que melhor os guiam; traduzir os termos selecionados, se necessário, em cabeçalhos de assuntos padrão; modificações de moedas; observe as referências; e fazer referências cruzadas, quando necessário. Para tomar as decisões corretas, o

indexador deve conhecer o campo do assunto, seja por educação ou por experiência.

O indexador ideal vê o livro como um todo - tanto no escopo quanto nas limitações

arbitrárias - compreende a ênfase das várias partes e seus relacionamentos no todo, e - talvez o mais importante de tudo - ilustra claramente os leitores em potencial e antecipa suas necessidades especiais.

O trabalho do indexador é assegurar que todas as instruções pertinentes do manual

tenham sido registradas no índice e de forma que o leitor possa encontrar as

informações solicitadas sem dificuldade.

Um bom indexador também deve ter um conhecimento suficiente de publicação e tipografia para apresentar o índice de acordo com os padrões editoriais e dentro das limitações mecânicas da tipografia.

Escritores técnicos como indexadores

O escritor técnico quase se aproxima do ideal como indexador. O escritor técnico

conhece melhor do que ninguém o alcance e as limitações do manual e do público a quem é dirigido.

13

A ressalva é que os escritores técnicos às vezes são tão subjetivos em relação ao seu

próprio trabalho que são tentados a incluí-los no índice, declarações periféricas sem análise tópica e, como resultado, preparar uma concordância em vez de um índice eficiente. Alguns também argumentam que, devido ao conhecimento detalhado do autor sobre o conteúdo do documento, o autor pode não conseguir ver as árvores para a floresta e, portanto, não consegue selecionar as entradas procuradas pelo usuário do índice.

Os melhores índices são aqueles feitos por escritores técnicos que têm a capacidade de ser objetivos sobre o seu trabalho, que entendem o que é um bom índice e quem dominou a mecânica do ofício de indexação.

Indexadores profissionais

Os indexadores profissionais têm as vantagens da objetividade e experiência. Enquanto a sua familiaridade com o assunto não é tão profunda como a do escritor técnico, e eles podem perder algumas sutilezas, o indexador profissional é uma escolha lógica para a tarefa se a equipe de redação técnica é pequena ou inexperiente.

A verdade parece ser que o autor pode ser o indexador ideal de um documento, desde

que o autor esteja disposto a dominar a técnica.

Traços de bons indexadores

Alguns sugerem que é estranho falar de personalidade em conexão com a indexação, e ainda assim a personalidade do indexador nunca está muito atrás do índice. Um estudo cuidadoso de qualquer índice revelará algo da própria perspectiva do indexador, especialmente na seleção e enquadramento de cabeçalhos de assuntos descritivos. Bons indexadores têm características como as seguintes:

Uma mente organizada - É bom ter o jeito e o desejo de classificar e classificar automaticamente. Se você tende a colocar suas coisas de volta onde elas pertencem, você pode ter a atitude certa.

Amplo conhecimento geral - Os indexadores tendem a cultivar uma grande base de conhecimento, tanto dentro de seu campo quanto fora dele. Um bom indexador tem um nível de conhecimento geral bem acima da média. O indexador especialista geralmente possui qualificações técnicas e pelo menos alguma experiência em um campo técnico.

Uma paixão pela precisão - Os indexadores tendem a se animar quando encontram uma frase, um evento ou uma pessoa com os quais estão pouco familiarizados e que não compreendem realmente. Isso os avisa que há algo que

14

deveria ser verificado.

Motivação - Esta característica é quase universalmente enfatizada. O indexador produtivo está interessado no campo assunto e na indexação.

Dedicação - Relacionada à motivação, essa característica pode se desenvolver quando os indexadores entendem que, ao indexar e fornecer orientação aos documentos, estão contribuindo para o campo escolhido.

Um bom domínio do inglês - Um indexador deve possuir um amor pela linguagem, um desejo de brincar com as palavras e uma capacidade de definir um assunto de maneira sucinta.

15

3 Índices técnicos

Níveis de índices

Talvez o mais importante, todo manual - independentemente de sua finalidade - deve ser indexado. Este é um requisito absoluto. E nunca pegue o índice levemente. O único índice útil é aquele que foi cuidadosamente pensado e construído. - Gary A. Bolles, "Manual Labor: What's Up, Doc?" in Network Computing

Índices de livros Índices de livros compõem uma categoria grande. Esses índices são listas de palavras, geralmente alfabéticas, no final de um livro. A referência de índice fornece uma localização de página do assunto ou um nome associado a cada palavra. Este índice funciona como um ponteiro para as informações incluídas, para que o leitor não tenha que ler ou reler todo o livro.

Os princípios e objetivos dos índices do livro são uma operação bem definida:

Eles têm um começo e um fim.

Eles se concentram em um tópico geral.

Eles podem ser preparados inteiramente por uma pessoa.

Não existe um bom livro se ele tem um índice fraco ou nenhum índice. Esses

livros são incompletos e semelhantes aos livros publicados com erros, como páginas

em branco onde o texto deveria estar ou com uma página invertida.

Índices de livros servem vários propósitos úteis:

Ajude o leitor que deve retornar ao livro mais tarde para procurar algumas informações.

Ajuda o leitor que quer se referir a algo.

Ajude o leitor a determinar se o assunto desejado está em um livro, para que o livro possa ser rejeitado se não contiver o assunto.

Índices de assuntos alfabéticos Organizar um índice em ordem alfabética é o método mais comum, já que é mais conveniente e segue um padrão familiar.

Um índice alfabético é baseado nos princípios organizados de letras do alfabeto e é usado para organizar cabeçalhos principais, cabeçalhos de assunto, referências cruzadas e termos qualificados. Todas as entradas são colocadas em uma ordem

16

alfabética, incluindo assuntos, autores e lugares.

Um dos pontos fortes de um índice alfabético é que ele segue uma ordem que a maioria de nós usa todos os dias, como usar um catálogo telefônico ou procurar uma palavra no dicionário. As únicas decisões reais que precisam ser feitas são:

A ordem - você usa símbolos, números e cartas?

tipo de método de escrever em ordem alfabética que você usa: letra por letra ou palavra por palavra?

A principal desvantagem dos índices de assunto alfabético é a dispersão, o que

significa que as subcategorias de um assunto não são colocadas juntas sob o termo genérico, mas dispersas por todo o índice. Para superar isso, use referências cruzadas do termo não preferencial para o termo preferencial.

17

4 Determinando audiências

Para quem o índice funciona

Na verdade, uma parte muito grande da leitura de todo homem cai ao mar e, a menos que tenha bons índices, nunca mais a encontrará. - Horace Binney, carta para S. A. Allibone

Usuários do índice em geral Aqui estão algumas ideias gerais sobre usuários de índice:

Muitos que usam livros, documentos e outros textos todos os dias raramente usam índices.

Muitos nunca são ensinados especificamente como usar índices.

Como os índices seguem estilos, apresentações, layouts e construções diferentes, muitos usuários ficam confusos com o que vêem.

A compreensão e o uso de índices estão diretamente relacionados ao nível de detalhamento e complexidade dos índices e quanto esforço é necessário para aprender a usá-los.

Para que os usuários desejem usar um índice, torne-o uma tarefa simples. Os usuários querem índices completos e consistentes. Recuo, dispositivos tipográficos e alinhamento de cabeçalhos precisam ser consistentes. Os localizadores devem levar o usuário diretamente para a (s) página (s) requerida (s). E, o mais importante de tudo, seja completo e completo. Tudo o que um usuário precisa encontrar deve ser indexado.

Determinando audiências Determinar seu público é a primeira tarefa na criação de um índice completo. Como para qualquer coisa que esteja escrita, o público principal é o foco final de conteúdo, design e estilo.

Obviamente, seu público principal é o leitor ou usuário. Mas as audiências secundárias - pesquisadores, escritores, estudantes, etc. - são geralmente muito maiores e diversificadas e devem ser incluídas na sua conceituação da estrutura do índice.

Como você define as audiências? Existem basicamente quatro tipos de leitores. Construa seu índice com todos esses leitores em mente:

18

2. Leitores que podem saber o que querem e usam o índice para ver se essa

informação está incluída no documento

3. Leitores que são enviados para encontrar informações para outra pessoa e não

conhecem a terminologia e não podem ler o documento inteiro

4. Leitores, como bibliotecários de referência, que devem localizar informações

5. Se você criar seu índice com todos esses leitores em mente, será mais provável

que você crie um índice completo e utilizável.

19

5 Alcançar

Todas as nove jardas

A indexação não vem naturalmente, como respirar. É mais como tocar violino: alguns aprendem a fazê-lo razoavelmente bem, alguns se tornarão virtuosos, mas a maioria das pessoas nunca saberá como fazê- lo. Hans H. Wellisch, Indexing from AtoZ

Alcançar a integralidade Alcançar a perfeição em um índice envolve fazer uma escolha entre os seguintes fatores:

Exaustividade - quantas das palavras de um livro devem ser incluídas no índice?

Precisão - Quanta interpretação deve ser feita no desenvolvimento de um índice;

Quanto sacrifício de itens indexados?

Fidelidade à redação do texto - Quanto o arranjo e o texto do texto devem ditar o

arranjo e a redação dos itens do índice?

Usabilidade - Como o manual deve ser organizado para facilitar a localização das informações pelos leitores?

Exaustividade

Um índice incompleto é quase tão inútil quanto nenhum índice. A completude é indispensável. Inclua todos os principais tópicos discutidos no documento. Termos necessários de referência cruzada. Dê ao leitor todos os meios para encontrar um tópico.

A maioria dos documentos técnicos não é lida da frente para trás. Muitas vezes, o índice é a única maneira de encontrar informações. E deve ser a maneira mais eficiente de encontrar informações. Um índice incompleto frustra um leitor que sabe que a informação está no manual, mas não consegue encontrá-la. Por exemplo, a incapacidade de encontrar informações pode levar a:

Frustração do cliente com o equipamento

Insatisfação do cliente com documentação

Mais tempo de inatividade da máquina para um engenheiro de campo

Máquina desperdiçada é executada por um programador

Precisão Além de estar completo, um bom índice deve ser o mais específico e analítico possível. Por exemplo:

20

Format 20,99,152,166

não é tão útil quanto estas entradas:

Format default parameters 166 footers 152 headings 99 two-column format 20

Fidelidade do texto Cuidado com os programas de índices automatizados. Eles tendem a dirigir escritores técnicos para usar apenas palavras do texto; eles não incluem necessariamente todos os termos genéricos que um leitor pode usar ao se aproximar do índice.

Por exemplo, suponha que uma organização use a palavra terminação ao encerrar o sistema. Se apenas o indexador automatizado fosse usado, a terminação seria a única palavra que apareceria no índice para ajudar o leitor a encontrar informações sobre o desligamento do sistema. Claramente, o índice se beneficiaria de ter a seguinte referência cruzada incluída:

shutting down system, see termination

Usabilidade Usar palavras diretamente do texto sem qualquer análise ou tradução para o leitor pode levar à dispersão. A dispersão ocorre quando informações de ideias semelhantes são colocadas entre diversos cabeçalhos e vários sinônimos. O leitor deve saber procurar em vários lugares todas as informações sobre qualquer assunto.

Por exemplo, as informações sobre um determinado protocolo de comunicação de dados podem ser listadas sob o seguinte, que é disperso:

BSC 3-41 Communication 1-1,1-9,1-14 Data communications protocols 7-11 Protocols 1-2,3-4,5-6, 7-8 Sending and receiving 9-3

Para ajudar a aliviar problemas de espalhamento, use referências ver também:

BSC 3-41

see also Communication; Data communication protocols; Protocols; Sending and receiving Communication 1-1,1-9,1-14 see also BSC; Data communications protocols; Protocols; Sending and receiving

21

6 Critérios para um bom índice

Julgamento sempre vem

Não é ótimo estar em uma profissão onde você é pago por ter a última palavra? - Willowdean W. Vance, membro da ASI

Cinco critérios para um bom índice Um bom índice tem as seguintes características:

Precisão

Profundidade de indexação

Concisão

Referência cruzada

Cabeçalhos lógicos

Seja você um editor, um redator técnico ou um revisor, você deve julgar um índice por esses critérios básicos.

Precisão Precisão é a característica mais importante de um bom índice. Sem isso, nada mais importa. As ferramentas de indexação automatizadas reduzem as referências de páginas erradas, mas é sempre responsabilidade do indexador garantir que as entradas estejam corretas. Se você estiver indexando manualmente, verifique suas referências de página com cuidado ao criá-las. Uma verificação completa da precisão é impraticável, mas algumas verificações são necessárias.

Profundidade de indexação Ao observar a profundidade de indexação, decida o que é adequado para o material em questão e o público-alvo. A profundidade do índice deve ser amplamente discutida e resolvida antes de iniciar a indexação; Quando um índice atinge o estágio de revisão, é difícil mudar sua profundidade.

Um índice médio tem de três a cinco entradas principais para cada página de texto. Um índice de luz tem uma a duas entradas por página. Um índice extremamente detalhado para um manual técnico pode ter até 10 entradas por página. Bons indexadores tentam fornecer no máximo 10 a 12 referências para qualquer termo, evitando sequências de números de página.

Concisão Se um índice é nítido e útil ou longo e desmedido dependerá da escolha de termos para cabeçalhos e subcabeçalhos. Considere o seguinte exemplo:

physicians' offices full-time personnel scheduling appointments in

22

use of microcomputers in

Uma abordagem ponderada alcançaria mais concisão usando subcabeçalhos redigidos, com a palavra-chave colocada em primeiro lugar:

physicians' offices appointment scheduling computer use personnel needs

Referência cruzada Referências cruzadas são o sistema de transporte de um índice. Existem duas referências cruzadas:

A referência ver leva de um termo não usado como uma entrada de índice para o

sinônimo que é usado.

A referência ver também leva o leitor a informações relacionadas em outro título.

Reserve um tempo para verificar se os cabeçalhos ver e ver também são exatamente iguais às entradas reais. Nada é mais enlouquecedor para o leitor do que um loop de referência cruzada que leva o leitor a um caminho sinuoso. Nenhum índice deve dizer a um leitor que consulta a memória para ver a memória de acesso aleatório que diz ao leitor para ver a memória do computador.

Pior ainda, nunca encaminhe o leitor para uma entrada cega, isto é, uma entrada que não existe! Esse é o pecado mortal da indexação.

Apenas as referências cruzadas necessárias devem ser incluídas. Para uma entrada de assunto sem subcabeçalhos, é preciso menos espaço para inserir as referências de página em dois cabeçalhos diferentes (por exemplo, "usuários" e "consumidores") do que para levar o leitor desnecessariamente de um para o outro com uma referência de

Uma referência também deve levar a informações adicionais, não às mesmas referências de página em um segundo cabeçalho. Referências cruzadas precisas, lógicas e úteis são as marcas de um bom índice.

Cabeçalhos Lógicos

A capacidade de selecionar e organizar cabeçalhos apropriados separa um indexador

experiente de um novato. Os iniciantes tendem a escolher tudo o que parece uma palavra-chave e usá-la como um termo de índice. O resultado é um texto confuso, com cada entrada tendo poucas referências de página.

O erro oposto é anexar uma longa sequência de referências de página a uma única

entrada, uma prática irritante para os leitores. Ninguém quer procurar 15 páginas

23

diferentes para encontrar uma informação específica. Qualquer assunto com mais de seis referências de página deve ser dividido em subcabeçalhos.

A relação de subcabeçalhos com cabeçalhos principais deve ser lógica. Uma falha comum é usar um cabeçalho como um substantivo e um adjetivo. O exemplo a seguir mostra a palavra ácido como substantivo (primeiro exemplo) e como adjetivo (exemplo inferior). O primeiro exemplo é a construção defeituosa:

acid acetic, 453 -free paper, 12 hydrogen ions 175 neutralization, 308 rain, 15 sulfuric, 50

Uma solução melhor é organizar os cabeçalhos desta maneira:

acetic acid, 453 see also acids acid-free paper, 12 acid rain, 15 acids see also acetic acid; sulfuric acid hydrogen ions, 175 neutralization, 308 sulfuric add, 50 see also acids

Critérios da Medalha Wheatley A cada ano, a Sociedade Americana de Indexadores concede sua Medalha Wheatley ao melhor índice que julga e atende a uma lista básica de critérios. Compare seu índice com esses 15 critérios para ver como você mede até um medalhista:

1. Se houver uma nota introdutória, é clara e bem expressa.

2. O índice é exato. Os números de localização fornecidos no índice são

compatíveis com o texto.

3. Itens significativos no texto aparecem no índice.

4. Onde as entradas relacionadas no índice são cada uma das referências de local,

elas devem ser consistentes.

5. O índice tem subcabeçalhos suficientes para evitar sequências de referências

de localização indiferenciadas.

6. O índice é organizado em ordem alfabética correta ou outra ordem.

7. Itens e conceitos no texto são representados no índice por termos apropriados e

bem escolhidos.

8. Os termos são escolhidos de forma consistente.

9. Existem referências cruzadas suficientes para conectar itens relacionados no

índice.

10. Há referências cruzadas para relacionar termos desatualizados ou

idiossincráticos no texto àqueles em uso atual.

11. O layout é claro e ajuda o usuário.

24

ser permitidas, se explicadas claramente) e nem escassas nem desnecessariamente completas.

13. O índice serve o texto e não é um veículo para expressar as visões e interesses

do indexador.

14. Se o índice se afasta das convenções, as partidas são explicadas na nota

introdutória.

15. Abreviações, acrônimos e similares são explicados.

25

7 Respondendo questões

A questão de $100 dólares

Que ato que ruge tão alto e troveja no índice? - William Shakespeare, Hamlet

Foco da tarefa E se o editor de um livro didático tivesse que absorver os custos de responder às perguntas dos leitores, ou se as vendas futuras do livro didático dependessem do acesso rápido dos leitores a essas informações sem a leitura formal? Ao contrário das editoras de livros tradicionais, essa é a situação enfrentada pela maioria das empresas que produzem documentos técnicos.

Os livros didáticos, que devem ser lidos primeiro, recebem um foco de referência. O índice é um caminho de volta para a informação. Espera-se que o leitor conheça informações. E o tempo do leitor é vagaroso.

A documentação técnica, que geralmente é usada como último recurso, exige foco na tarefa. O usuário está procurando informações sobre como fazer isso. O índice é usado como entrada pela primeira vez no material. O tempo é um problema para o usuário.

Mudando sua mentalidade A indexação sob a abordagem de resposta a perguntas requer uma mudança de paradigma para a maioria dos indexadores. Pense: "Que pergunta um usuário deste produto teria respondido por este texto?" Evite pensar: "Este texto é sobre algo", que está pensando na resposta.

Identifique a tarefa (foco do usuário) e esqueça a função (foco do produto). A tarefa é a questão (como faço isso?); a função é a resposta (usando essa função dessa maneira).

Amostra de resposta à pergunta Os usuários do seu documento técnico sempre sabem a pergunta: "Como faço isso?" Por exemplo, uma pergunta de usuário típica para um programa de processamento de texto é:

Como faço para números de página automáticos?

Se a função para gerar números de página automáticos for um subconjunto da função maior chamada cabeçalhos, faz sentido descrever números de página automáticos no capítulo ou seção que descrevem como gerar cabeçotes em execução. No entanto, se você indexar as informações dessa maneira:

running heads, 208-210 automatic page numbers, 210

26

você vai escondê-lo do usuário. O leitor teria que saber a resposta, que é que os números de página automáticos são uma sub-função dos chefes de execução. Se o leitor já soubesse disso, não haveria necessidade de usar a entrada do índice para encontrar as informações. Considere as seguintes entradas de índice para números de página automáticos. (Não faria mal manter a entrada de índice acima para usuários que sabem que os números de página automáticos são um subconjunto de cabeças de execução.)

automatic page numbers, 210 heads, running, automatic page numbers, 210 page numbers, automated, 210 running heads, automatic page numbers, 210

Antecipando perguntas Índices bem-sucedidos antecipam as perguntas que o usuário fará. A maioria das pessoas usa documentos técnicos, tanto on-line quanto impressos, para responder a perguntas. O índice bem-sucedido garantirá que essas perguntas sejam respondidas:

O que essa mensagem de erro significa?

Por onde eu começo?

Por que a tela ficou em branco?

Por que a impressora não imprime?

Por que a unidade não está sendo acessada?

Como eu instalo este software?

Preciso pressionar a tecla Esc agora?

Como saio do programa?

Quando meus dados são salvos?

Outra maneira de antecipar perguntas é criar uma lista de tarefas que não use a terminologia do produto. Ao criar o índice, use esta lista de tarefas como referência. Uma lista de tarefas sólida subdivide o produto em uma infinidade de tarefas, de acordo com o conhecimento ou experiência do leitor. Peça ao pessoal de suporte técnico para revisar e modificar a lista de tarefas conforme necessário.

Encontrar perguntas Você pode descobrir que tipo de perguntas seus usuários fazem, estudando o que acontece quando eles usam seu produto ou documento. Criar este índice orientado a tarefas pode requerer:

Criar uma lista atualizada de palavras do projeto

Aprender a terminologia de produtos concorrentes

Realizar testes de usabilidade para observar o que os usuários estão fazendo e

27

por que

Consultar os logs de linha direta de suporte ao cliente para ver quais perguntas comuns estão registradas

Observar as aulas de treinamento para aprender as perguntas que os alunos fazem

Usando o produto você mesmo para ver as perguntas que você faz, para aprender sobre os recursos prioritários e obter uma excelente visão geral do produto

Atendendo às necessidades dos leitores Para criar um índice de sucesso, ele precisa atender às necessidades do leitor, seu

cliente. Para fazer isso, você deve:

Conhecer seu cliente;

Conhecer seu produto;

Indexar sob perguntas que os usuários têm sobre seu produto.

Conhecendo seu cliente Existem vários dados sobre seus clientes. Eles:

Aprendem a fim de executar as responsabilidades do trabalho.

São focados no problema, não focados no fato.

Não tenha tempo suficiente.

Quando

procedimentos:

os

clientes

ficam

presos,

eles

se

soltam

ao

tentar

um

dos

seguintes

Peça ajuda a um amigo ou colega de trabalho.

Procure no manual por alguns segundos, no máximo.

Ligue para o suporte técnico ou atendimento ao cliente

Encontre uma solução alternativa ou corte-a.

Uma maneira de descobrir o seu cliente é fazer perguntas ao cliente. Ouvir chamadas de suporte ao produto e criar um Ust de perguntas feitas pelos chamadores é uma boa maneira de aprender sobre seus clientes. Quase 80% de todas as chamadas de suporte técnico são geradas por 20% das perguntas. Essas perguntas devem ser indexadas completamente! Outra maneira de conhecer seus clientes é visitá-los. Fale com sites beta para novos produtos. Vá em visitas de clientes para produtos existentes. O benefício é maior conscientização das tarefas, problemas e preocupações do cliente.

Conhecendo seu produto A melhor maneira de aprender seu produto é usá-lo e sua documentação. Aprenda a terminologia usada por produtos concorrentes ou complementares. Desenvolva uma

28

lista de tarefas, aquelas coisas que seus usuários querem fazer com seu produto.

Índice como produto O uso do método de indexação “answer-the-question” pode exigir algumas alterações no grupo de documentação:

Alterar o papel do indexador

Alterar os materiais de apoio

Fazer trade-offs

Vender os benefícios

Alterando o papel do indexador O método de indexação answer-the-questionpode exigir que o indexador seja uma pessoa da equipe. Essa pessoa deve estar familiarizada com o produto e deve estar bem informada sobre o cliente. O indexador se torna o defensor do leitor.

Alterando os materiais de apoio Para criar um índice bem-sucedido com o método de resposta a pergunta, são necessárias várias novas informações:

Análise de audiência para determinar as necessidades do leitor

Feedback do usuário para que perguntas importantes sejam respondidas

Listas de tarefas para garantir que todas as tarefas sejam indexadas

Terminologia da categoria para um vocabulário consistente

Fazendo trade-offs Usando este método pode exigir fazer compensações. O principal deles é que o índice irá:

Seja mais caro para produzir

Requer mais tempo para produzir

Exija mais investimento pelo indexador

Precisa de mais páginas comprometidas com o índice

Exigir mais trabalho para escritores que indexam

Vendendo os benefícios Mas os benefícios que resultam desses trade-offs significam um índice mais utilizável para o cliente. Isso também significa:

Maior satisfação do cliente

Maior fidelidade do cliente

Custos de suporte reduzidos

29

Pensamento final Se os seus leitores não conseguirem encontrar o que estão procurando em seu documento, o manual também pode não ser escrito.

30

8 Definindo os Elementos do Índice

A soma das partes

Sem índices, não poderíamos telefonar facilmente, pedir refeições em restaurantes, providenciar viagens, encontrar material de biblioteca, agendar compromissos, localizar correspondência, encontrar ruas ou fazer uma série de outras coisas que agora tomamos como garantidas. Harold Borko & Charles L. Bernier, Indexing Concepts and Methods

Elementos do índice Um índice é composto de entradas. Cada entrada contém dois elementos - um tópico e um localizador (que pode ser um número de página ou uma referência cruzada).

Entradas Existem vários níveis de entradas:

Entrada primária ou entrada de primeiro nível

Entrada secundária ou entrada de segundo nível, também chamada de

subentrada

Entrada Terciária ou entrada de terceiro nível, também chamada de sub-

subentrada

Aqui está uma série típica de entradas:

computer-assisted design 84,85 database structure 40,80 floating-point arithmetic instructions 43, 50 registers 9 identification 9 number 5

Localizadores Os localizadores consistem em números de página, também chamados de referências de páginas, referências ou localizadores, que podem incluir números de volume.

Referências cruzadas Referências cruzadas apontam o leitor para tópicos relacionados ou para terminologia preferida. Existem dois tipos de referências cruzadas:

referência cruzada verRefere-se ao leitor a um termo preferido.

referência cruzada ver também - Refere ao leitor tópicos relacionados.

9 Selecionando tópicos

O primeiro desafio

31

Todo livro sério de não-ficção deve ter um índice para alcançar sua máxima utilidade. The Chicago Manual of Style, 13th Edition

Escolhendo tópicos para indexar

representam

ser

praticamente qualquer coisa no documento, incluindo:

Palavras

Frases

Frases

Parágrafos

Capítulos

Tabelas

Entradas em tabelas

Exemplos

Diagramas

Conceitos

Idéias A chave para desenvolver um bom índice é listar tópicos da mesma maneira em que o leitor tentará encontrá-los.

O primeiro

informações que podem servir

desafio

ao

criar

um

índice

é

selecionar

de

tópicos,

Um

que

como

entradas

índice.

tópico

pode

Como autor do seu documento, você conhece melhor os objetivos, a organização e o conteúdo, e é mais capaz de determinar os tópicos adequados. Como o indexador, você deve decidir quais desses tópicos devem ser referidos no índice e, em seguida, criar entradas de assunto para esses tópicos. Ao criar temas, lembre-se de que o leitor deseja informações, não lugares em que palavras ou frases são usadas. Em outras palavras, não pense na lista; pense conceitos.

Analisando tópicos

Há várias coisas que você deve ter em mente ao escolher tópicos para o índice:

Quando um tópico explica um conceito ou uma ideia, crie uma ou mais entradas

de índice para ajudar o leitor a encontrá-lo.

Quando um tópico contém a definição de um termo, crie uma ou mais entradas de índice apontando o leitor para ele. Muitas vezes, as definições são chaves para entender um documento.

Crie entradas de índice quando acrônimos e abreviações forem usados.

Crie uma ou mais entradas de índice para um tópico que declare uma restrição - por exemplo, uma advertência, um aviso ou uma observação - para tornar o leitor ciente dessa restrição. Isso ajuda o leitor a evitar erros.

Indexar referências a nomes de lugares ou nomes pessoais usados apenas como

32

exemplos, se apropriado. Enquanto muitos indexadores não os indexam, eles ajudam na integralidade.

Se um tópico contiver uma referência a outra parte do documento, crie uma entrada de índice para ajudar o leitor a encontrar esse ponto referenciado

Como um índice é um dispositivo de recuperação de informações, indexe apenas os tópicos que podem ser úteis para seus leitores:

Evite criar uma lista de palavras e frases que aparecem no texto. Se não houver informações de uso para o leitor, não indexe.

Baseie os tópicos em seu conhecimento do tipo de documento e do leitor pretendido do documento e do índice

Um método rápido para indexação O método de indexação Time-crunch que pode ajudá-lo a criar um índice em um curto período de tempo. Siga estes oito passos para se certificar de que o seu índice está completo e contém os principais assuntos do seu documento:

1. Não tente indexar um documento de uma só vez. É mais fácil indexar como você

vai, ou um capítulo de cada vez.

2. Para começar a criar seu índice:

a. Sublinhe as palavras na página para as quais você deseja criar tópicos.

b. Na margem, escreva uma breve descrição para o tópico.

c. Crie uma entrada em um cartão de índice, em seu processador de texto ou em seu programa de layout de página.

3. Comece selecionando o material sobre o assunto principal do seu documento. Basta escolher os tópicos principais dos títulos dos capítulos, introduções, subtítulos e

conclusões.

4. Em seguida, indexe os principais termos e definições, abreviações, acrônimos e

restrições.

5. Certifique-se de incluir sinônimos para tópicos importantes. Não há problema em

encaminhar usuários para antônimos também.

6. Figuras e tabelas do índice.

7. Se um tópico é duas palavras e uma palavra modifica a outra, inverta as palavras e indexe o tópico uma segunda vez, criando uma entrada para cada uma delas. Por

exemplo, secondary audiences to audiences, secondary

8. Diga aos leitores onde eles podem encontrar tópicos relacionados usando as

referências ver e ver também.

Informações de indexação: Mapeando documentos

33

Os documentos que seguem os padrões de Mapeamento de Informações são um pouco mais fáceis de indexar do que outros documentos, devido ao seu formato modular e à introdução ordenada dos termos.

O Mapeamento de Informações usa os conceitos de um Bloco e um Mapa para estruturar a escrita. Um bloco consiste em duas partes:

Uma ou mais frases ou diagramas sobre um fragmento logicamente coerente de assunto

Um rótulo, que descreve a função ou o conteúdo do bloco, como uma definição, exemplo e assim por diante. Um bloco é sempre parte de um mapa, que é uma coleção de todos os blocos relevantes sobre um assunto limitado.

Na maioria dos casos, você pode pegar o substantivo em cada Título do Mapa como um tópico de índice e, em seguida, adicionar rótulos de Bloco selecionados como subtópicos. A análise de cada bloco já foi concluída e o rótulo do bloco reflete o objetivo, a função ou o conteúdo do bloco.

34

10 Descrevendo tópicos

Uma tarefa de sumarização

Um índice ponderado aumenta o valor de qualquer livro e ajuda a garantir que o livro seja usado com frequência porque seu conteúdo é acessível. Martha Sencindiver in "Taking the mystery out of indexing" in Intercom

Descrevendo os tópicos Ao descrever os tópicos escolhidos, aprenda a antecipar as necessidades dos seus leitores. Uma vez escolhido um tópico, descreva-o para o leitor; isso se torna o tópico da entrada do índice. Quando o índice é consultado, o leitor busca respostas para perguntas sobre um tópico. Escolha tópicos que respondam a estas perguntas:

Onde posso encontrar informações sobre um determinado item?

Quais páginas posso ignorar porque elas contêm informações que já conheço ou informações que sei que não quero?

As informações descritas por uma entrada de índice me dizem o que algo é, o que algo faz, como algo funciona ou o que deve ser feito para usá-lo?

O valor de um índice é aprimorado quando ele antecipa as necessidades do leitor e responde a essas necessidades. Esse índice reduz o tempo e o esforço necessários para que o leitor encontre as informações desejadas.

Selecionando termos para tópicos Depois de escolher o tópico e descrevê-lo, você deve selecionar uma palavra ou grupo de palavras para tópicos. Como as palavras selecionadas são resumos do tópico, elas devem ser tão descritivas quanto possível. Selecionar palavras para descrever um tópico se torna mais difícil à medida que o tamanho do tópico aumenta. Use quaisquer palavras que melhor descrevam um tópico - é perfeitamente correto usar palavras e frases não técnicas.

Muitos escritores escolhem assuntos de palavras que aparecem no texto. Faça isso com cautela. Palavras do texto são como citações diretas. Eles são bons para quem conhece a terminologia usada no documento. Para aqueles leitores que não conhecem

a terminologia, você deve fornecer tópicos escritos para que eles possam encontrar as informações desejadas sem conhecimento explícito do assunto.

Vantagens

A vantagem de escolher tópicos de palavras que aparecem no texto é:

Os olhos têm algo para escanear.

Os leitores não precisam fazer nenhuma substituição mental ao digitalizar o texto para a cotação.

35

Desvantagens As desvantagens de escolher tópicos de palavras que aparecem no texto são:

Quando a palavra ou frase aparece repetidamente, a citação pura falha como assunto. Para superar isso, tente combinar a cotação com outras palavras ou frases para diferenciar as várias ocorrências da cotação.

Muitas vezes, a citação não é descritiva o suficiente para identificar claramente o tópico. Adicione palavras ou frases à cotação para resolver esse problema.

Sinônimos Se for possível, não se limite a palavras que aparecem no texto. Crie os tópicos a partir de sinônimos ou outras palavras descritivas.

Agrupamentos Use tópicos comuns como um grupo de subentradas sempre que possível. Para o leitor novo ou casual, esses agrupamentos têm pouco valor, mas para um leitor experiente, esses agrupamentos facilitam a seleção da referência desejada. Por exemplo, use um dos seguintes termos para descrever o tópico:

Definições

Descrições gerais

Teoria das operações

Discutido

Restrições

Escolha quaisquer palavras que produzam um assunto mais significativo para o leitor. A regra mais importante para realizar isso é colocar o substantivo principal ou assunto da referência primeiro. Por exemplo:

Usar a obtenção de suporte de hardware não é tão eficaz quanto o suporte de hardware, obtendo, porque uma pessoa normalmente não procuraria o verbo ou ação obtida em um índice.

Usando subentradas Você deve decidir se determinados tópicos serão tratados como tópicos principais ou como subentradas. As principais preocupações na preparação do índice devem ser garantir que todas as informações pertinentes do documento sejam registradas, seja como entrada principal ou como subentrada, e que o leitor possa encontrar as informações com um mínimo de pesquisa.

Com linhas de números de página Entradas principais que não são modificadas por subentradas não devem ser seguidas por longas filas de números de página. Essa entrada força o leitor a folhear várias

36

páginas antes de encontrar a informação exata. Como regra geral, tente fornecer pelo menos uma subentrada se houver mais de quatro ou cinco referências a um único título. Ao invés de

symbols 73,150,168,171

você pode tentar o seguinte:

symbols

alphabetizing 171 in examples 73 indexing 168 numbers and 150

Combinando Entradas As subentradas podem ser exageradas. Uma entrada principal que consiste apenas em subposições, cada uma com um número de página, é tão indesejável quanto uma entrada longa e não analisada. Neste exemplo, tente combinar entradas usando categorias mais amplas. Por exemplo, em vez de beta distribution conditions for 2-29 explanation of 2-28 to 2-30 parameters for 2-28 skewness in 2-29 use with Bayesian statistics 2-28

você pode tentar o seguinte:

beta distribution 2-28 to 2-30

Relações gramaticais Geralmente, há uma relação lógica entre cabeçalhos e subcabeçalhos. Há freqüentemente um relacionamento gramatical também.

Relacionamentos gramaticais desempenham um papel no texto das subposições:

Tente usar substantivos e frases nominais para os cabeçalhos principais. Por

key

Use modificadores para reforçar as relações entre os cabeçalhos principais e subcabeçalhos. Por exemplo:

exemplo: finger

ftp_attr

function

entries em spaces in see also references placement of semicolons in cross-references

Use a inversão para obter palavras-chave na frente da frase, quando necessário. Por exemplo:

device driver driver, device

37

keyboard mapping mapping, keyboard

No entanto, não inverta: *

Adjetivo + compostos nominais, por exemplo: civil rights hot springs social group

- Substantivo + compostos nominais, por exemplo: fuel crisis reference works water power Não use adjetivos como título principal por si mesmos; geralmente um substantivo segue como um modificador. Ao invés de:

green

apples

thumbs

use

green apples green thumbs

Alfabetizando Organize as subentradas em ordem alfabética. Normalmente, alfabetize a palavra mais importante primeiro. Palavras-chave não vêm necessariamente em primeiro lugar. Para maior clareza, um cabeçalho secundário pode começar com uma preposição ou conjunção que ajuda a mostrar uma relação precisa entre o rumo e o rumo secundário. A preposição ou conjunção é desconsiderada durante a o processo de escrever em ordem alfabética. Por exemplo:

weights abbreviating of panels symbols

Entrando termos Aqui estão algumas coisas para observar ao digitar os termos.

Colocando em letras maiúsculas Ao inserir um termo, não coloque em maiúscula a entrada, exceto os nomes próprios, acrônimos, instruções de linguagem ou comandos com distinção entre maiúsculas e minúsculas. Por exemplo:

The Chicago Manual of Style, as reference guide electrostatic discharge (ESD), causes of entries, capitalizing ESD, causes of

Acrônimos e abreviações Acrônimos e abreviaturas são aceitáveis em documentos técnicos. No índice, é melhor usar a sigla ou a abreviação e a versão explicitada. A referência ESD, causas de, também deve ser listada sob descarga eletrostática (ESD), causas de.

38

Se você optar por usar apenas a versão de acrônimos e sinônimos, crie uma referência cruzada (ver) no acrônimo ou sinônimo para a versão explicitada. Coloque o acrônimo ou sinônimo entre parênteses após a versão soletrada. Por exemplo:

electrostatic discharge (ESD) causes of 29 preventing 45 ESD. see electrostatic discharge (ESD)

Jargão Evite o jargão. Se você deseja indexar o jargão, insira a palavra e use uma referência cruzada para apontar para a entrada mais comumente aceita.

Singular vs. plural Não há problema em usar o singular ou o plural; apenas seja consistente. A uniformidade - na ortografia, na pluralidade e na descrição - é necessária para manter os assuntos juntos no índice para evitar que eles sejam dispersos.

39

11 Organizando tópicos

Colocando entradas em ordem

Longe de ser a parte mais fácil e tediosa de escrever um documento, o índice é uma tarefa difícil e penosa. Também é impossível com o software que existe agora. Não há um software que possa fazer o trabalho, então minha única recomendação real deve ser, se você precisar de um índice, obter um indexador (um humano) para fazê-lo. William Gallagher in "Indicing with death" in Personal Computer World

Usando ênfase Sempre organize entradas para ênfase. Coloque a palavra mais importante primeiro, se a legibilidade não for afetada adversamente. Baseie suas decisões de organização de palavras no propósito do documento e seu público.

Cuidado com factoring Ao agrupar entradas, tenha cuidado com o factoring, que é o processo de dividir grupos de palavras para que os significados sejam alterados. Factoring é um posicionamento ilógico de entradas em categorias falsas e faz com que os usuários passem por etapas adicionais para encontrar um tópico. O uso indevido de factoring irá induzir em erro e confundir o leitor. Para reduzir o fatoração, não use um adjetivo sozinho como assunto de uma entrada principal.

Usando economias de tamanho Você pode usar certas economias de tamanho sem prejudicar o índice. Uma das economias mais usuais é combinar tópicos e as operações associadas a eles. Por exemplo, em um livro sobre finanças, pode haver várias referências a bancos e várias outras à prática bancária. Se houver um grande número de referências a ambos, faça referências separadas; mas se houver apenas alguns, considere se esses dois poderiam ser combinados com segurança sob o mesmo título. Por exemplo:

computing 56,69 computers 58,68

pode ser combinado com

computers and computing 56, 58,68,69

40

12 Tratamento de casos especiais

Coisas para assistir

[Thomas] Jefferson era um indexador inveterado; ele indexou livros contábeis, periódicos e livros de memorandos. Fazer listas, classificar, ordenar, colecionar e salvar eram sintomas de sua personalidade compulsiva. A indexação não era meramente utilitária; foi uma necessidade. Jack McLaughlin in "The Organized President" in American Heritage

Restrições O leitor deve ser capaz de encontrar todas as restrições e o índice deve tornar o leitor ciente delas. Não apenas liste a restrição. Certifique-se de descrevê-lo também. Existem vários tipos de restrições que devem ser indexadas:

Conjuntos de regras

Valores ou opções padrão

Avisos

Cuidados

Notas

Definições Embora os glossários não precisem ser indexados, às vezes ajuda o leitor se o glossário estiver indexado. Seria um bom hábito indexar todas as definições, tanto no glossário quanto no texto. Se a definição aparecer no texto e no glossário, cada um com pequenas variações no significado, você poderá mostrar as diferenças no índice escolhendo um termo que seja usado consistentemente para definir cada um.

Neste exemplo, cada vez que um tópico no glossário foi indexado, o termo definido foi usado. Quando o mesmo tópico foi descrito em texto, o termo descrito foi usado.

Acrônimos e abreviações

Colocar siglas e abreviações no índice permite que o leitor saiba se a informação representada pela sigla ou abreviação está no documento. Por exemplo:

CPU. see central processing unit (CPU)

No termo soletrado, coloque a abreviação no final do termo. Por exemplo:

central processing unit (CPU)

Essas entradas geralmente atualizam a memória de um leitor.

41

Referindo-se a outras publicações

Se o documento que está sendo indexado for uma continuação de uma publicação de pré-requisito ou co-requisito, você poderá fornecer entradas de índice para outras publicações para garantir que um leitor possa prosseguir facilmente desse documento para o seu documento e vice-versa.

Digamos que você esteja produzindo um índice para o ABC Manual. Um livro anterior, o Manual XYZ, contém a seguinte declaração em vários lugares:

Consulte o ABC Manual para uma listagem e descrição dos programas de conversão.

No Manual ABC, cada programa de conversão recebeu um nome específico. Se os nomes dos programas de conversão aparecessem no índice apenas sob os nomes

específicos, o leitor do Manual XYZ não os encontraria. Ao criar entradas de índice para

o ABC Manual, forneça ao leitor que procurará por "programas de conversão".

conversion programs aconvert 40

bconvert 80 cconvert 100

Assuntos numéricos e de símbolos Embora seja melhor colocar entradas numéricas e de símbolos nas porções numérica

e de símbolo do índice, é perfeitamente correto colocá-las sob os cabeçalhos como se estivessem explicitadas. Os símbolos geralmente precedem os numerais quando colocados juntos, e ambos vêm sob cabeçalhos de letras separadas. Aqui está um exemplo de símbolos e numerais sendo colocados sob os símbolos e numerais que estão no cabeçalho:

Símbolos

!, repete o comando

&, para operação em segundo plano

+, Operador booleano

Numerais

286

386

486

Aqui estão os mesmos símbolos e numerais colocados como se fossem escritos:

Um e comercial (&), para operação em segundo plano

E ponto de exclamação (!), Para repetir o comando

42

F

486 (quatro oitenta e seis)

P

sinal de mais (+), operador booleano

T

386 (três oitenta e seis) / 286 (dois oitenta e seis)

43

13 Escrevendo o índice em ordem alfabética

O arranjo de entradas

O sistema letra por letra tende a facilitar um pouco a escrita em ordem alfabética para o indexador, enquanto o sistema palavra por palavra pode ser mais fácil para o leitor porque agrupa palavras únicas idênticas. Mas as diferenças são pequenas, e qualquer um dos sistemas pode, às vezes, resultar em uma série de aparência estranha.- Manual de estilo americano padrão de Webster

Métodos para escrever em ordem alfabética

Existem dois métodos principais para escrever em ordem alfabética:

Letra por letra

Palavra por palavra

Na verdade, toda a ordem alfabética é letra a letra, porque os leitores consideram primeiro a letra inicial da palavra, depois a segunda letra, depois a terceira e assim por diante. A necessidade de escolher entre os dois métodos surge quando você coloca em ordem alfabética não um conjunto de palavras isoladas, mas um conjunto de cabeçalhos , alguns dos quais consistem em mais de uma palavra.

Letra por letra No método letra por letra, escreva em ordem alfabética até ao primeiro sinal de pontuação. Ou seja, ignore espaços de palavras e coloque em ordem alfabética até o hífen, vírgula, dois pontos ou ponto no final do cabeçalho, ou para a vírgula após a primeira parte do cabeçalho invertido.

Palavra por palavra No método palavra por palavra, escreva em ordem alfabética até o final da primeira palavra e depois pare. Use palavras secundárias e subsequentes somente quando dois ou mais cabeçalhos começarem com a mesma palavra ou palavras. Se houver um hífen separando as palavras, trate as palavras como elementos individuais.

Escolhendo um ou outro Cada sistema tem seus prós e contras. Os adeptos do método palavra por palavra dizem que o sistema letter-by-letter é fácil no indexador e difícil para o leitor. Detratores do método palavra por palavra dizem que todos estão familiarizados com um dicionário e, portanto, estão totalmente familiarizados com o método letra por letra. Em ambos os casos, ambos são aceitáveis, com o método letra por letra sendo

44

mais popular.

Ordem alfabética Quando você coloca em ordem alfabética, use esta seqüência:

Símbolos, pontuação e caracteres especiais

Numerais

Letras maiúsculas

Letras minúsculas

Computadores colocam em ordem alfabética de acordo com o seu número de código decimal ASCII. Por exemplo, o ponto de exclamação (!) É sempre alfabetizado primeiro porque possui o código decimal ASCII mais baixo. Números em ordem alfabética antes das letras. Letras maiúsculas em ordem alfabética antes das letras minúsculas.

Você pode colocar símbolos, caracteres especiais, pontuação e números no agrupamento de letras para seus nomes, em vez de sob o símbolo, número, pontuação ou caractere especial. Por exemplo, coloque a entrada para um * sob asterisco (*) em vez de sob o símbolo *. E coloque a entrada para 64.000 sob 64 mil em vez de sob o cabeçalho numérico.

45

14 Criando referências cruzadas

Ver e ver também

O índice é a ferramenta de descoberta mais importante que uma publicação

pode fornecer. Deve ser extenso, indo muito além do glossário e do índice referências cruzadas devem estar corretas e completas. - Padrões de publicação da Xerox

As

Criando referências cruzadas Referências cruzadas no índice guiam o leitor para informações relacionadas no documento. Usados apropriadamente, são adjuntos úteis para um índice, mas nunca devem ser usados, a menos que realmente levem a informações adicionais, não apenas à mesma informação indexada sob outros cabeçalhos . Enquanto referências cruzadas são geralmente em itálico, a única vez que eles geralmente não estão em itálico é quando usado em uma referência cruzada que também está em itálico. Por exemplo:

The Chicago Manual of Style, ver Chicago Manual of Style

Em referências cruzadas, cabeçalhos e subcabeçalhos são geralmente citados na íntegra, com inversão e pontuação exatamente como indicado na entrada referenciada. Por exemplo:

electrostatic discharge (ESD), 334338 ver também humidity

humidity, 176 ver também electrostatic discharge (ESD)

Exceções às vezes são feitas, no entanto, para cabeçalhos muito longos. Quando vários cabeçalhos principais são citados, estes devem ser separados por ponto e vírgula. Múltiplas referências cruzadas são organizadas em ordem alfabética. Por exemplo:

elisions, 34 ver também inclusive numbers; locators

Se a referência for a um subcabeçalho, o cabeçalho principal deve ser o primeiro, seguido de dois pontos ou uma vírgula e, em seguida, o subcabeçalho. Por exemplo:

electrostatic discharge (ESD) static prevention, 3-12 to 3-24,6-156 static prevention, ver electrostatic discharge (ESD), static prevention.

Referências cruzadas são usadas no lugar de uma referência de página ou localizador. Use referências cruzadas com moderação, mas não economize nelas apenas para manter o índice curto. Como sempre, o principal critério para usar referências cruzadas

46

é a integralidade.

Referências cruzadas assumem duas formas gerais:

Referência Ver

Referência Ver também

Referências Ver Use referências ver nas seguintes situações:

Quando o escritor escolheu uma entre várias palavras-chave ou frases e o leitor pode procurar em outra, por exemplo:

virgule. see slash

Quando o assunto foi tratado como uma subentrada para uma entrada principal, por exemplo:

Iroquois Indians, see Indian tribes, Iroquois

Quando uma entrada foi colocada em ordem alfabética mas em outra letra do alfabeto, por exemplo::

Hague, see The Hague

Protege contra uma entrada cega, que é uma referência cruzada a uma entrada que não está listada no índice. Usando o primeiro exemplo de marcador acima, se você listar virgule como referência cruzada e apontar o leitor para slash como o termo sob o qual você lista entradas para virgule, certifique-se de incluir slash como uma entrada primária. Se você não fizer isso, você criou uma entrada cega.

Enquanto referências ver geralmente são colocadas em itálico quando usadas em índices, a única vez em que eles geralmente não estão em itálico é quando usados em uma referência cruzada que também está em itálico.

A referência ver segue imediatamente a palavra referenciada.

Alguns indexadores não usam referências ver. Em vez disso, eles colocam números de página em ambos os assuntos, usando parênteses para indicar usos alternativos.

Referências ver também Referências ver também são usadas quando uma informação adicional ou relacionada pode ser achada em outra entrada ou subentrada.

Uma referência ver também é uma informação adicional que ajuda o leitor a usar o índice. Aponta informações relacionadas, identifica assuntos semelhantes em forma ou propósito, ou sugere alternativas ou equivalentes se a primeira escolha do leitor

47

estiver errada.

Enquanto referências ver também geralmente são colocados em itálico quando usados em índices, a única vez que eles geralmente não estão em itálico quando usados em uma referência cruzada que também está em itálico.

Onde colocar o ver também Coloque as referências ver também em um desses quatro locais:

Imediatamente abaixo do cabeçalho principal

Como a última entrada de subcabeçalhos

Imediatamente à direita do cabeçalho principal

No final da página, referências

Onde você coloca a referência ver também é a sua escolha. No entanto, a maioria dos indexadores o coloca logo abaixo do título principal para que o leitor saiba imediatamente que existe um termo relacionado. Isso geralmente é feito para evitar que o usuário passe pela lista de entradas para descobrir que o assunto realmente procurado está em outro lugar.

Abaixo do cabeçalho principal Nesse local, a referência cruzada ver também é a primeira entrada do subcabeçalho. Por exemplo:

Churches see also Constantine; orders, religious Roman 273-275 Romanesque

309,324,542

Como o último subcabeçalho Nesse local, a referência cruzada ver também é a última entrada do subcabeçalho. Por exemplo:

Churches Roman 273-275 Romanesque 309,324,542 see also Constantine; orders, religious

A direita do cabeçalho principal Nesse local, a referência cruzada ver também é colocada à direita do cabeçalho principal, geralmente entre parênteses. Por exemplo:

Churches

Roman (see also Constantine) 273-275 Romanesque (see also order, religious) 309,324,

542

No final da página referências

48

Nesse local, a referência cruzada ver também é colocada no final das referências da página. Por exemplo:

Churches Roman 273-275. see religious

order,

also

Constantine Romanesque 309,324,542. see

also

Colocação de arquivos eletrônicos Aqui está uma ótima dica sobre onde colocar suas referências cruzadas ao usar arquivos de computador. Coloque todos os ver e ver também em um só lugar - como no final do prefácio ou capítulo um. É mais fácil encontrar os termos desta forma se você precisar editá-los. Se você espalhar as referências cruzadas em todos os arquivos, terá dificuldade em localizar o que precisa editar.

49

15 Trabalhando com localizadores

Por favor, vá para a página 3

o Index Expurgatorius emitida pelo Papa Sixtus V em 1589 afirma em sua Regra XXI: "Não serão apenas livros expurgados, mas também notas marginais, quadros obscenos, índices, letras, prefácios e tudo o que o livro contenha". William Popper, The Censorship of Hebrew Books

Números inclusivos Os números de página inclusivos informam aos leitores onde os tópicos começam, são interrompidos e continuam. Se o tópico discutido for executado em páginas contínuas, as páginas devem ser vinculadas a um travessão:

24-25

Se as referências forem duas separadas e descontínuas, os números das páginas são separados por vírgulas:

24,25

Por

exemplo,

as

referências

212-216,219-220,222

indicam que há uma longa discussão do tópico nas páginas 212 a 216, com uma menção mais curta nas páginas 219 a 220 e uma breve menção na página 222.

Estilos para números inclusivos Existem duas maneiras de apresentar números inclusivos:

1. Coloque os números completos: 232-234,504-506,3-6 a 3-9

2. Elide os números: 232-34,504-6

Regras para usar elisão 1 Se você decidir usar a elisão de números inclusivos, siga

estas regras:

1. Não elide números inclusivos que tenham apenas dois dígitos: 33-37, não 33-7.

2. Não elide os números inclusivos quando o primeiro número terminar em 00: 100- 108, não em 100-08 e não em 100-8.

3. Em outros números, omita apenas os dígitos de centenas do número mais alto:

232-34, não 232-4.

1 Na lingüística, uma elisão ou exclusão é a omissão de um ou mais sons em uma palavra ou frase.

50

4. Onde o próximo ao último dígito de ambos os números for zero, escreva apenas um

dígito para o número mais alto: 103-4, não 103-04.

5. Não use elisão em localizadores usando intervalos de números de páginas de

capítulos: 3-6 a 3-9, não 3-6 a 9 ou 3-6-9.

Referências “NontextMateriais “Nontext” tais como tabelas, gráficos, fotografias, mapas, diagramas e outras ilustrações são algumas vezes identificados como tal em índices. Uma maneira de identificar ilustrações é imprimir em itálico ou em negrito qualquer número que localize esse material. Se você usar esse método, precisará adicionar uma nota no início do índice para explicar o procedimento. Por exemplo:

Nota: Números em negrito referem-se a fotografias; números em itálico referem-se a tabelas.

back plane, 33-50,45 chemical notation, 101,102

Outro método é que os números do localizador sejam precedidos por um termo de identificação, como map, table, Ulus, em itálico. Esses localizadores especiais podem ser posicionados no final dos números regulares. Por exemplo:

power supply 25-28, 67, illus. 54

Eles também podem ser colocados em seqüência com outros localizadores, que é a prática mais comum. Por exemplo:

power supply 25-28, illus. 54,67

Alguns indexadores preferem listar ilustrações como subcabeçalhos separados para torná-los mais óbvios. Por exemplo:

networks backing up 44-45 configuring 23,68 illustrated 24

51

16 Preparando cartões de índice

A mecânica

Quando a biografia de Andy Warhol saiu

Warner Books supostamente defendeu o movimento dizendo: "Nós sentimos que o livro deveria ser lido como um corpo completo de trabalho". Várias revistas, incluindo Spy e Fame, compensaram a falta inventando seus próprios índices e criando entradas como 'Ono, Yoko, ganância de' e 'Ross, Diana, fealdade de The Wiz'. Martin R. Dowding, Books in Canada

sem um índice, um porta-voz da

Começando Uma maneira excelente de iniciar a indexação é usando o método da caixa de sapatos. Use cartões de índice para registrar suas entradas. Coloque-os todos em uma caixa de sapatos e, em seguida, alfabetize e edite-os. Isso lhe dará uma boa idéia de como a mecânica é feita - seja com um programa de indexação independente ou um pacote de editoração eletrônica.

Usando cartões de índice Cada entrada de índice é gravada em um cartão de índice separado de 3 polegadas por 5 polegadas. Use esses cartões para preparar o índice final. Se você estiver usando um programa de computador, processador de texto ou editoração eletrônica, altere ou adapte os procedimentos discutidos neste capítulo conforme necessário para refletir os recursos de seu sistema específico.

Marcando entradas Na sua página, teste, sublinhe ou circule tópicos que devem ser incluídos no índice. Se a palavra ou frase exata desejada para o índice não aparecer no texto, escreva as palavras exatas na margem da prova. Esta marcação é para sua conveniência, faça o máximo ou o mínimo que achar necessário.

Transferindo entradas para cartões Depois de marcar suas entradas nas provas da página, copie os itens de índice em cartões de 3 polegadas por 5 polegadas. Use um cartão separado para cada entrada principal e subentrada, repetindo a entrada principal no topo de cada cartão. Isso é feito por conveniência e precisão nos arranjos finais do índice. Cada cartão tem dois ou três elementos: um título, uma modificação (se necessário) e um localizador.

Para indexadores iniciantes, seria melhor manter os cartões na ordem em que foram feitos até você terminar de criar cartões para o documento inteiro. Isso significa que você não poderá adicionar novos números de página aos cartões que você já fez; mas o trabalho adicional é justificado pela vantagem de poder verificar todos os cartões contra as páginas a que se referem antes de serem reorganizados em ordem

52

alfabética.

Quando todas as cartas estiverem completas, passe pelo arquivo mais uma vez com as provas de página ao seu lado e faça duas coisas:

1. Verifique cada cartão para se certificar de que o que está em seu rosto é

exatamente o que você pretendia.

2. Percorra as provas de página mais uma vez para verificar omissões na indexação.

Itens previamente desmarcados podem ter se mostrado indexáveis à luz de temas desenvolvidos em capítulos posteriores.

Em cada caso, faça cartões agora e adicione-os ao arquivo antes de alfabetizar.

Embora a criação do índice seja lenta no início, devido à necessidade de escrever muitos cartões, ele se tornará gradualmente mais rápido, à medida que menos e menos cabeçalhos tiverem que ser escritos, e o trabalho se tornará principalmente um de adicionar aspectos e referências de página a os cartões existentes. Para este fim, é aconselhável adicionar referências de títulos sinônimos, assim que surgirem, para evitar desperdício de esforço na criação de entradas duplicadas em cabeçalhos diferentes.

Verifica-se, de um modo geral, que embora o indexador se lembre habitualmente dos títulos utilizados durante as primeiras 20 a 30 páginas, a memória do indexador nem sempre grava todas durante a indexação subsequente, especialmente se isso ocorrer durante um longo período. Fazer referências, por escrito, a partir de títulos sinônimos, ajudará a transformar o indexador nos títulos principais que foram decididos anteriormente. Se eles não forem registrados, o indexador poderá encontrar deficiências de dispersão no índice.

Arrumando os cartões Colocar os cartões na ordem alfabética pode ser feito de duas formas:

Um cartão de cada vez enquanto são escritos

Depois que todas as cartas estão escritas

Alguns indexadores esperam até que todos os cartões estejam prontos. Então, em um cartão, eles:

Combine entradas duplicadas

Eliminar entradas sinônimas

Listar todos os números de página para uma entrada na ordem correta

53

Outros indexadores preferem colocar cartões em ordem alfabética assim que forem escritos, o que:

Evita a duplicação de cartões

Ajuda no planejamento de um arranjo consistente

Economiza tempo na revisão final dos cartões

Na revisão de cartões, observe os seguintes problemas:

Use nomes de assunto consistentes. Por exemplo, tanto a energia atômica quanto a energia nuclear podem ter sido usadas.

Observe formas singulares e plurais da mesma palavra. Por exemplo, mouse e mouse.

Verifique se há frases que podem estar em mais de uma forma, como herança de características adquiridas e características adquiridas, herança de. Se ambos os formulários forem mantidos, certifique-se de que os mesmos números de página sejam fornecidos nos dois locais.

Verifique as referências cruzadas para garantir que os itens a que se referem não tenham sido alterados de eliminados.

Editando os cartões Depois que os cartões estiverem em ordem alfabética, edite-os agrupando títulos, determinando subtítulos e fornecendo um número adequado, mas não excessivo, de referências cruzadas.

A partir dos cabeçalhos e modificações nos cartões, agora você precisa tomar decisões finais sobre entradas primárias e entradas de subtítulos. Escolha entre termos sinônimos ou intimamente relacionados e prepare referências cruzadas adequadas para refletir essas escolhas.

Marcando os cartões para digitação Após os cartões terem sido organizados, eles devem ser marcados para digitação. Em um grupo de subentradas sob um único cabeçalho, todas as entradas principais, exceto a primeira na primeira carta, devem ser riscadas, mas não obliteradas. Se uma subentrada é seguida por um item secundário, tanto a entrada principal como a subentrada devem ser riscadas. Em um índice impresso, as subentradas são recuadas em espaços e entradas secundárias em espaços.

54

17 Automatizando o processo

Dang it eletronicamente O trabalho de indexação não é recomendado para aqueles que não têm uma mente organizada e uma capacidade para tomar dores. Um bom índice é uma pequena obra de arte, mas também é produto de um pensamento claro e cuidados meticulosos. - Peter Farrell, como ganhar dinheiro em casa

O que significa automatizar Automatizar o processo de indexação está realmente levando o modelo de cartão de índice um passo adiante. O computador ajuda a acelerar o processo de inserção de títulos e inversões, colocando automaticamente em ordem alfabética a lista e imprimindo os resultados.

Quatro métodos automatizados Existem basicamente quatro tipos de métodos de indexação automatizados:

Programas de indexação de propósito único ®

Pacotes de publicação eletrônica

Processadores de texto ®

Utilitários de indexação

Programas de indexação de propósito único

O programa de indexação de propósito único é projetado apenas para criar índices. Esses pacotes geralmente são projetados para aplicativos intensivos e são usados por indexadores profissionais para produzir índices grandes e complexos.

Esses programas geralmente possuem recursos integrados que tornam os títulos de inversão fáceis. Eles também têm fortes recursos de alfabetização que oferecem flexibilidade de escolha ao usuário. Eles permitem que o indexador indexe vários níveis. Além disso, os programas de indexação de propósito único permitem flexibilidade na formatação do índice e no layout do índice para impressão final.

Esses pacotes permitem a criação de vários índices ou combinações de índices em um índice mestre ou cumulativo.

Pacotes de publicação eletrônica A maioria dos softwares de publicação eletrônica, ou software de editoração eletrônica, incorpora a indexação como um recurso padrão. Os recursos do recurso de

55

indexação variam.

Esses pacotes estão ficando altamente sofisticados em sua capacidade de criar, formatar e imprimir um índice. Eles oferecem controle máximo ao entrar em termos, criando referências cruzadas, permitindo muitos níveis de títulos, oferecendo uma alfabetização flexível, permitindo uma variedade de formatos e imprimindo o índice final. Muitos desses pacotes estão se aproximando, e alguns estão superando, os recursos de pacotes de indexação de propósito único.

Processadores de texto Mais processadores de texto estão adicionando recursos de indexação aos seus pacotes. Esses programas de indexação são bastante sofisticados e permitem que o indexador destaque palavras ou digite palavras para entradas. Eles também permitem flexibilidade no layout e no formato. Eles geralmente não permitem muita flexibilidade nas escolhas de alfabetização. Muitos desses pacotes estão se aproximando dos recursos de pacotes de publicação eletrônica e de propósito único.

Utilitários de indexação Esses programas são recursos complementares a pacotes existentes, sejam eles processadores de texto ou software de publicação eletrônica. Esses utilitários ajudam a agilizar os aspectos tediosos da marcação de índice, passando pelo documento e marcando palavras e frases.

Basicamente, para usar esses programas, você diz ao utilitário as palavras e frases que deseja indexar. O programa então passa pelo seu documento e os marca Depois de passar pelos seus arquivos e inserir as entradas de índice escolhidas, você é livre para retornar ao seu processador de texto ou programa de publicação eletrônica para gerar o arquivo de índice e formatá-lo.

Uma utilidade de indexação deprecia a comunidade de indexação profissional, implicando que o programa poderia indexar, assim como um profissional. "[Este programa] torna a indexação tão fácil que você provavelmente não contrata um indexador profissional", diz o guia de referência.

A marcação de texto nada mais é do que um aspecto mecânico da indexação. As

verdadeiras exigências estão em reconhecer as passagens apropriadas a serem incluídas e que não podem ser aprendidas da noite para o dia, nem podem ser transferidas para um utilitário de indexação. Se um indexador ruim usar um utilitário de

indexação, o resultado será um índice gerado rapidamente, mas um índice ruim.

A força real no uso de utilitários de indexação é usá-los para ajudar o indexador

iniciante, fornecendo uma maneira fácil de marcar tudo à vista. Em seguida, o indexador pode usar a lista gerada para escolher os termos mais usados e criar

56

entradas para eles.

Utilitários de indexação não são um substituto para um indexador profissional.

Construindo um índice eletronicamente Indexar eletronicamente é basicamente o mesmo que indexar com cartões de índice. Envolve a marcação de texto em todo o documento, inserindo essas informações em seu programa, gerando o arquivo de índice para esse documento, aplicando uma folha de estilo ou modelo ao arquivo de índice gerado e, em seguida, imprimindo o arquivo.

A marcação de texto é feita exatamente como na indexação manual, como discutido no Capítulo 16. Você pode marcar à medida que avança ou volta e faz tudo de uma só vez. Você deve inserir referências cruzadas ao marcar sua cópia. Você coloca as informações no programa através da interface do software. A geração do índice é realizada pelo programa, geralmente com o indexador capaz de determinar vários atributos de texto e número de página. Depois que o índice é gerado, o arquivo é anexado a uma folha de estilos ou modelo, que formata o índice. Imprimir o índice também é uma função realizada dentro do pacote de software.

Além disso, você poderá combinar índices em um índice mestre ou cumulativo ou criar vários índices para o mesmo livro.

Depois de imprimir o índice, edite-o. Para fazer correções, você deve retornar ao pacote de software e editar as entradas do índice. Também é possível ajustar manualmente o arquivo de índice gerado. Se isso for feito, as alterações não serão feitas nas entradas originais e, quando o índice for regenerado, as correções necessárias deverão ser feitas novamente. É melhor editar as entradas do índice. Você deve então testar o índice como se fosse um índice criado manualmente.

Colocação de arquivos eletrônicos Aqui está uma ótima dica sobre onde colocar suas referências cruzadas ao usar arquivos de computador. Coloque todos os as referências ver e ver também em um único lugar. É mais fácil encontrar os termos dessa maneira se você precisar editá-los. Se você espalhar as referências cruzadas em todos os arquivos, terá dificuldade em localizar o que precisa editar.

Alguns cuidados Ao avaliar qualquer software para automatizar sua processo de indexação, tenha estas considerações em mente:

1. Certifique-se de que você pode controlar o formato do índice.

2. Certifique-se de que você pode controlar os métodos de alfabetização.

57

4. Verifique a capacidade de editar entradas facilmente.

5. Certifique-se de que o manual explique detalhadamente o processo de indexação.

6. Não acredite no hype se o seu pacote disser que ele pode substituir o indexador.

7. Até conhecer o pacote, verifique sempre a precisão da alfabetização, referências

cruzadas e localizadores.

58

18 Criando em vez de mestre

Colocando eles juntos

A National Library of Medicine gasta mais de US $ 2 milhões e emprega 44 indexadores equivalentes em tempo integral apenas para indexar o MEDLINE todos os anos; simplesmente como uma proposição econômica, portanto, a indexação humana logo se tornaria um luxo para os fabricantes de bancos de dados muito grandes. - Tom McFadden em "Nós somos o que falamos" no boletim AS1

Índices mestres Índices principais são aqueles índices que abrangem vários volumes. Esses índices incluem entradas de todos os documentos em um determinado conjunto de documentos. É necessário algum planejamento especial por parte do designer para produzir índices mestre efetivos. Particularmente importante é a estrutura do título, capítulo e número da página do livro.

O

índice mestre facilita a localização de um assunto específico em todos os volumes.

O

índice pode estar localizado em vários locais no conjunto de documentos:

No final de cada volume físico

Como um documento separado

No final do último volume físico

Usando algarismos romanos Um método para identificar o volume de cada um faria você colocar um numeral romano no rodapé, que é o texto que é executado na parte inferior da página e indica o número da página e outras informações. Qualquer que seja o método usado no índice mestre, você deve identificar o estilo no início do índice e talvez colocar lembretes na parte inferior de cada página. Consulte a página 194 para algumas notas de amostra.

Digamos que você tenha uma série de três manuais de diagnóstico, conforme indicado

abaixo:

Diagnostics Documentation Processor Diagnostics (volume I) Diagnóstico do sistema de E / S de PBUS (volume II) Utilitários de diagnóstico (volume III)

Para criar uma entrada de índice para este exemplo, preceda cada número de página com um numeral romano que indique o volume referenciado. Coloque um período entre

o número do volume e o capítulo, depois um hífen e, em seguida, o número da página:

scripts de comando, criados pelo usuário 1.6-23, II.2-1, III.3-1

Essa entrada indica que as referências a scripts de comando criados pelo usuário aparecem no volume I (Diagnósticos do processador) na página 23 do Capítulo 6, no

59

volume II ( Diagnóstico do Sistema I / O PBUS) na página 1 do Capítulo 2 e no volume III (Diagnóstico). Utilitários) na página 1 do Capítulo 3.

Usando títulos abreviados Outro método é criar títulos abreviados em vez de numerais romanos. Por exemplo:

Documentação de Diagnóstico Diagnóstico do processador (pd) Diagnóstico do sistema de E / S de PBUS (io) Utilitários de diagnóstico (ut)

Usando esse método, você teria a seguinte entrada: scripts de comando, pd.6-23,

io.2-1, ut.3-1 criados pelo usuário

Usando algarismos arábicos Outro método é usar algarismos arábicos. Por exemplo:

Documentação de Diagnóstico Diagnóstico do processador (1) Diagnóstico do sistema de E / S PBUS (2) Utilitários de diagnóstico (3) Usando este método, você teria a seguinte entrada:

scripts de comando, criados pelo usuário 1.6-23,2.2-1,3.3-1

Os localizadores podem ser difíceis de detectar rapidamente usando algarismos arábicos com um período. Usar uma barra (/) ajudaria o leitor a localizar o número do capítulo mais rapidamente. Por exemplo:

scripts de comando, criados pelo usuário 1 / 6-23, 2 / 2-1,3 / 3-1

Projetos de rodapé Para tornar os índices mestre úteis, certifique-se de que os rodapés, que são

refletidos nas referências de página no índice, contenham todas as informações necessárias para as referências de sua página.

• O numeral romano, título abreviado ou numeral arábico

• O número do capítulo

• O número da página

60

Quarta Parte Completando o Índice

61

19 Formatando o índice

Criando o layout

Um índice é um instrumento necessário, e nenhum impedimento, de um livro, exceto no mesmo sentido em que as carruagens de um exército são denominadas impedimentos. Sem isso, um grande autor é apenas um labirinto, sem uma pista para direcionar o leitor a ele. - Thomas Fuller, Worthies da Inglaterra

Formatos e tipografia Considere as diretrizes a seguir ao projetar o formato do seu índice.

Design básico da página Os índices geralmente são definidos em duas colunas por página e no tipo que tem dois tamanhos de ponto menores que o tamanho usado no texto. Esse design funciona bem se você tomou uma média entre seis e dez referências por página e se o tamanho desejado do índice está entre dois e cinco por cento do total de páginas do livro. Se houver cinco ou menos referências por página do livro, o índice estará no final curto desse intervalo; Se houver mais de 10 referências por página, o índice pode ser até mais do que 5% do total do livro.

Alguns índices têm três colunas por página e um livro muito grande pode ter um índice de quatro colunas. Índices de múltiplas colunas são usuários espaciais eficientes, especialmente para índices indentados com suas muitas linhas curtas de títulos e subtítulos. Se o índice estiver definido em mais de duas colunas, o tamanho do tipo geralmente é reduzido para três ou quatro tamanhos de ponto menores do que o texto do livro.

Margens do lado direito

A maioria dos índices usa um estilo certo-esfarrapado em vez de uma margem direita

justificada. O problema com uma margem direita justificada é que, por causa das larguras estreitas das colunas, as linhas do tipo seriam freqüentemente lotadas ou espaçadas para sair justificadas.

Hifenizações

A maioria dos editores não permite quebras de palavras por causa da dificuldade que

podem causar ao leitor. Você tem que quebrar uma palavra, faça no começo ou no fim

da palavra, não no meio.

Título do índice Dê ao índice um título (geralmente Index). Isso pode ser centralizado ou colocado à esquerda. Elementos simples de design linear podem ser adicionados, e o título pode

62

ser enfatizado por sua escolha de tamanho e estilo.

Cabeçalhos de letras Deixe um espaço em branco extra entre as diferentes seções alfabéticas do índice. Você pode colocar a letra maiúscula ou o símbolo apropriado em negrito acima de cada seção.

Atributos de texto Use opções de estilo, como negrito e itálico, para enfatizar determinadas partes do índice. Por exemplo, você pode:

Coloque referências ver e referências ver também em itálico

Coloque números de página para ilustrações em itálico

Coloque números de página para o tratamento primário de um tópico em negrito

Diga ao leitor no início do índice quais convenções você está usando em seu índice.

Crie seu próprio capítulo Faça o índice uma divisão separada do seu documento e formate-o em duas ou três colunas.

Paginação Paginar o índice como se fosse uma continuação do texto principal. Os números das páginas devem seguir o mesmo estilo e ser colocados na mesma posição do texto principal.

Cabeçalhos e rodapés Crie um cabeçalho ou rodapé em execução, ou ambos, para o índice. O cabeçalho ou rodapé deve corresponder ao estilo e formato do cabeçalho ou rodapé no texto principal.

Convenções notacionais Ao indexar nomes de diretório, nomes de arquivos, nomes de teclas do teclado, comandos e afins, use o mesmo tipo de fonte e fonte como no texto. Por exemplo:

/ hwdoc / lib / doc CTRL

Formatos de entrada Formatos de entrada de índice vêm de duas formas:

• Run-on, também chamado de parágrafo

• Linha por linha, também chamada de recuado

63

Formulário de execução Em um trabalho narrativo, o formulário para entradas é um bom arranjo, porque na maioria das vezes a seqüência dos números das páginas corresponderá aproximadamente à seqüência dos eventos registrados ou à sequência temporal em que as questões discutidas foram levantadas. O formato de execução é assim:

Dipolo: impedância característica de secção transversal circular 109; definição de, 55; efeito da forma perto do ponto de acionamento, 108; elétrica, 55,66

Não use o formato de execução para índices com mais de dois níveis de títulos porque a entrada torna-se difícil, se não impossível, de decifrar.

Formulário linha por linha O formulário de execução não é eficiente. O índice é mais eficiente se os subtítulos de qualquer cabeçalho principal forem impressos em linhas separadas, organizados em ordem alfabética. Por exemplo:

Dipolo impedância característica de seção transversal circular, 109; gaiola multiwire, 113 seção transversal quadrada, 112 seção transversal triangular, 112 definição de, 55 efeito de forma perto do ponto de acionamento, 108 elétrico, 55,66

Neste exemplo, o subtítulo "impedância característica de" é dividido em quatro subcabeçalhos. Esta é uma prática bastante comum, mas evite ir além do terceiro estágio da subdivisão.

Envoltórios de linha Sempre que uma linha do seu índice for envolvida, ou continuar para uma segunda ou terceira linha, você deve recuar a linha para separá-la das linhas de texto anteriores e posteriores à linha. Um bom padrão é um espaço maior que o número máximo de níveis em seu índice. Observe o espaçamento após a entrada principal no exemplo a seguir, que é um índice de dois níveis:

rubricas alfabéticas 35 alfabetização letra por letra 69 ver também alfabetização; palavra por palavra em ordem alfabética discutida 22,67 exemplo 36

Saltar entradas As entradas que continuam de uma coluna para outra no índice são chamadas de entradas de salto. Quando uma entrada salta, você deve duplicar os níveis de títulos que precedem a entrada saltada. Se você usar uma entrada de salto de terceiro nível, você deve tomar os dois títulos de nível anteriores com o título de terceiro nível.

64

Indução Todos os índices são definidos com recuo suspenso. Ou seja, a primeira linha de cada entrada completa é alinhada à esquerda, enquanto todas as outras linhas da entrada são recuadas até certo ponto. A indentação de suspensão é usada porque as listagens alfabéticas são mais prontamente digitalizadas quando a palavra-chave é ativada.

Com os índices de execução (parágrafo), as decisões de recuo são simples: a entrada principal começa com o alinhamento à esquerda e todas as linhas de execução nessa entrada são recuadas no mesmo grau. Com um índice recuado, no entanto, pode haver vários níveis de recuo, cada um indicando uma relação específica entre as partes da entrada.

A medida usual de recuo é um espaço em branco, que é o espaço horizontal que a letra

maiúscula "M" ocupa para o tamanho do tipo do índice. Para um índice linha-a-linha (recuado), a entrada principal é à esquerda. As linhas de passagem de todas as entradas - entradas principais e subentradas - são recuadas no mesmo grau, o que geralmente é um espaço maior do que o maior número de subtítulos. Por exemplo, se você tiver três níveis de recuo, as linhas de passagem serão recuadas em quatro espaços.

Detalhes de estilo

É importante decidir sobre um estilo de indexação antes de inserir entradas de índice em seu documento. Descubra se o seu departamento ou empresa já possui um guia de estilo de indexação. Se houver um guia de estilo de indexação, atenha-se a ele.

O guia de estilo de indexação contém um resumo de por que indexar, assim como o

que indexar e o que não indexar. Outros padrões descritos incluem como:

Criar entradas e subentradas

Usar referências cruzadas

Formatar o índice

Quebrar colunas

Entradas e subentradas separadas

Pontuar o índice

Ordenar o índice

Editar e verificar o índice

Criar índices mestre

Ao preparar o índice, siga estes detalhes do estilo:

iniciais

As

palavras

podem

ser

maiúsculas

consistente.

ou

minúsculas

-

basta

ser

65

Linhas contínuas de entradas de mais de uma linha são recuadas na profundidade de um espaço em branco.

Um cólon ou um espaço em um segue um tópico quando é modificado.

Uma vírgula ou um espaço em-seguinte segue um tópico quando não é modificado.

Vírgulas separam números de página dentro de uma entrada ou subentrada.

Um período precede uma referência cruzada ver.

Os pontos-e-vírgulas separam duas ou mais entradas nas referências cruzadas.

Não há pontuação final.

Parênteses podem ser usados para diferenciar homônimos, que são pessoas ou coisas com nomes idênticos, por exemplo:

tela de tela (computador) (para cobrir)

Evite ir além do terceiro nível de entradas.

66

20 Gerenciando o índice

Cálculo do tamanho, tempo e custo

A maneira mais eficaz de usar livros no presente é dupla: ou, primeiro, servi-los como senhores, - aprender seus títulos exatamente e depois se vangloriar de seu conhecimento; ou, em segundo lugar, que é, na verdade, o método captor, o método mais profundo e mais polido, para obter uma visão completa do índice, pelo qual todo o livro é governado e transformado, como peixes pela cauda. - Jonathan Swift, um conto de banheira

Determinando o tamanho Embora o tamanho de um índice não seja uma indicação de qualidade, um índice curto em um documento longo deve torná-lo suspeito. O tamanho mínimo de um índice pode ser calculado de várias maneiras.

Uma entrada para cada 100 palavras de texto

Uma página de coluna dupla (o tamanho do tipo é A2 em uma linha de 18 picas de largura por 56 picas) de entradas de índice para cada 20 páginas de texto, sem incluir:

o

Fluxogramas

o

Matéria de frente

o

Listas de códigos de operação, abreviações, rótulos de programas e mensagens

o

Figuras, exemplos, tabelas e páginas em branco com mais de três quartos de uma página

Por exemplo, um manual típico de 200 páginas, com 50 páginas de figuras, exemplos, etc., deve ter um índice de cerca de sete páginas de duas colunas.

Para o livro médio de 282 páginas, existem 1.045 linhas de índice desenvolvidas (cerca de oito páginas de texto de três colunas no tipo de 8 pontos em uma diretriz de 9 pontos).

índice típico contém 3,7 linhas por página indexada.

Calculando tempo e custo Você não pode criar um índice durante a noite. Nenhum índice adequado para um manual de qualquer complexidade pode ser - ou deveria ser - concluído em um final de semana. A indexação requer intensa concentração intelectual.

Uma boa indexação requer reflexão e a reflexão exige tempo. Você deve ter tempo para parar com frequência, revisar um pouco do trabalho que acabou de concluir, tentar se colocar no lugar do escritor técnico, por um lado, e do leitor, por outro, e decidir se ambos foram atendidos pelas decisões que você tomou. fez.

67

Estimando o tempo Como a indexação é uma atividade bastante complexa, é preciso mais tempo do que muitos escritores técnicos imaginam. Criar um índice não é diferente de criar um capítulo típico de texto.Um indexador experiente precisa de 30 a 44 horas para crie o índice para um manual de 220 páginas:

3 horas Leitura rápida preliminar do texto

10 horas Lendo texto e marcando passagens on-line para

entradas de índice (adicione mais 14 horas se esta parte for

feito em cópia impressa) Entrando Entradas no Sistema de Publicação Edição de índice e inserção de correções Índice de geração e impressão

8

7

2

30 a 44 horas

horas

horas

horas

Um indexador inexperiente precisa entre 55 e 83 horas para criar o mesmo índice para um manual de 220 páginas:

3 horas Leitura rápida preliminar do texto

20 horas Lendo texto e marcando passagens on-line para

entradas de índice (adicione mais 28 horas se esta parte for feito em cópia impressa) Entrando Entradas no Sistema de Publicação

Edição de índice e inserção de correções Índice de geração e impressão

16

14

2 horas

55-83 horas

horas

horas

A adição de 14 a 28 horas para marcação de texto em cópia impressa é o tempo necessário para converter os cartões ou marcações impressas em papel para inserir as entradas de índice no programa de computador. É muito mais rápido indexar online!

Estimando custo É mais fácil calcular o custo de criação e edição de um índice pelo número de páginas no manual. O sistema por página é a melhor maneira de determinar quanto tempo o indexador gastará em um projeto. Esse método também é usado com frequência

68

porque cada página de texto precisa ser lida e avaliada para itens indexáveis. As taxas típicas por página são de US $ 3 a US $ 5 por página, dependendo da localização geográfica, do grau de dificuldade técnica e da densidade do texto. Usando as taxas acima, o índice de um manual de 200 páginas custaria algo entre US $ 400 e US $ 800 para produzir.

69

21 Editando o índice

Uma lista de verificação útil

O refrão mais comum foi que a documentação do software é mal indexada e, como resultado, você não consegue encontrar as respostas de que precisa. - Christine Grech em "Documentação de computador não passa em revista " em PCjComputing

Sempre edite o índice Marcar o texto e inserir as entradas é apenas o começo do processo de indexação. Durante a elaboração do índice, você está mais preocupado em criar entradas individuais e suas subentradas. Durante a edição, a preocupação muda para o índice como um trabalho coeso, preciso e consistente.

Assim como quando você edita seu manual, a edição do índice pode exigir:

A criação ou exclusão de entradas

Divisão ou combinação de entradas

Reagrupamento ou reformulação de entradas

Verificação de entradas para torná-las livres de erros

Garantindo a ordem e a consistência das entradas

Formato de índice O formato e a disposição do índice são importantes. A sequência geral é:

Símbolos e caracteres especiais

Assuntos alfabéticos

Assuntos numéricos

Ao formatar o índice, torne a primeira linha da entrada um recuo deslocado. Recue entradas secundárias em um espaço. Inserção de entradas terciárias em dois espaços. Por exemplo:

entrada primária entrada secundária entrada terciária

Também é importante observar as entradas que envolvem outra linha. A linha que envolve deve ser recuada em um espaço mais profundo que o último nível do subtítulo. Por exemplo:

mapa de configuração da população, abreviar PCM 176,354

Localização ver e ver também Uma referência de ver segue imediatamente a entrada principal. Geralmente, uma referência ver também está localizada como a primeira ou a última entrada secundária

70

ou terciária. Entradas com apenas um subtítulo devem estar em uma linha.

Índices linha a linha Nos formatos linha a linha, a entrada principal é seguida por entradas secundárias e terciárias. O localizador é precedido por uma vírgula ou um espaço em. Por exemplo:

dipolo ver também impedância característica do magnetismo de secção transversal circular, gaiola com 109 fios, 113 secções quadradas, 112 secções triangulares, 112 definição, 55 efeito de forma perto do ponto de acionamento, 108 elétrico, 55,66

Ou faça assim: dipolo

ver também impedância característica do magnetismo de secção transversal circular 109 gaiola multi-fios 113 secção transversal quadrada 112 secção triangular 112 definição de 55 efeito da forma perto do ponto de acionamento 108 elétrico 55,66

Índices de execução No formato de execução, o tópico é digitado seguido por dois-pontos, depois os subtítulos e, em seguida, o localizador. Um ponto e vírgula separa cabeçalhos secundários. Por exemplo:

dipolo: impedância característica de secção transversal circular 109; definição de, 55; efeito da forma perto do ponto de acionamento, 108; elétrica,

55,66.

ver também magnetismo

Lista de verificação de edição Para garantir um índice preciso e completo, siga a lista de verificação para verificar os itens específicos no índice.

Verifique a sequência alfabética ao longo de cada passagem de edição e particularmente na edição final. Verifique as entradas principais por ordem alfabética estrita.

Verifique os níveis de subentrada para que o recuo adequado mostre a relação de cada entrada com a precedente.

Verifique os assuntos para determinar se pequenas variações de texto são intencionais ou se apenas um texto deve ser usado.

Verifique os assuntos para duplicação devido a diferenças na capitalização.

Verifique o número de referências de página seguindo um assunto. Se houver mais de quatro, considere a criação de subentradas mais específicas.

71

Como parte da verificação de integridade e precisão, verifique cada ocorrência de um tópico para ver se as referências de página são as mesmas e se aparecem em todas as ocorrências.

Verifique cada subentrada para determinar se também deve aparecer como uma entrada principal.

Verifique para determinar se as subentradas devem ser reorganizadas para enfatizar um determinado ponto.

Verifique o número de subentradas nas várias formas do mesmo tópico para ver se são iguais.

Verifique cada ver referência para verificar que se trata de uma entrada que é seguido por subentries com as referências apropriadas página.

Verifique o texto dos assuntos em referências ver e ver também.

Verifique as referências de texto para verificar se elas ainda existem no índice na mesma forma que na referência de texto.

Verifique as referências cruzadas para se certificar de que eles vão em algum lugar e que os títulos são idênticos. Certifique-se de que as referências cruzadas sejam necessárias; se apenas algumas referências de página estiverem envolvidas, adicione-as ao título original e exclua a referência cruzada. Verifique também se a veiculação nas entradas é consistente.

Verifique a razoabilidade dos números de página (não "12122" ou "193-93") e certifique-se de que as sequências de referências de página estão em ordem crescente.

Verifique as subentradas em busca de consistência de ordem, seja alfabética, cronológica ou outra. Se mencionado ou algum outro dispositivo desse tipo for usado, verifique se o uso é consistente.

Se algumas entradas parecem super analisadas (muitas subentradas com apenas uma página referenciam cada uma), tente combinar algumas delas. Se os subtítulos forem mais longos e mais elaborados do que o necessário, tente simplificá-los.

Verifique se as referências a nomes de lugares ou nomes pessoais usados apenas como exemplos são indexados ou omitidos de forma consistente. Enquanto muitos indexadores não os indexam, eles ajudam na integralidade.

Verifique se há pelo menos uma entrada de índice para cada tabela, ilustração, diagrama, fotografia, figura, gráfico, gráfico, mapa ou outra ajuda visual.

Verifique se as convenções de notação no texto, como monoespaçada, fonte de capa de tecla ou itálico, também são aplicadas às entradas de índice.

Certifique-se de que as entradas de salto - aquelas que continuam em outra coluna - tenham os cabeçalhos apropriados transportados para o topo da

72

coluna.

Verifique se as linhas de quebra automática (linhas de uma entrada com mais de uma linha) são recuadas em pelo menos um espaço de tempo maior que o número de níveis de subtítulos usados no índice.

73

22 Testando o índice

Ajudas de usabilidade

O propósito principal de um índice é a destilação e, ao realizar essa tarefa, pode conseguir sugerir incongruências de uma vida com uma concisão de que

o estilista biográfico mais poderoso terá problemas para se adaptar.

- Thomas Mallon em "A melhor parte de cada livro chega por último" no The New York Times

Testando os cinco critérios básicos Esta seção discute maneiras de testar os cinco critérios básicos para um bom índice. Um bom índice:

É preciso

Tem profundidade apropriada

É conciso

É cruzado

É lógico

Precisão Teste a precisão, primeiro, verificando algumas páginas. Escolha duas ou três entradas em cada coluna e procure todas as referências de páginas dadas. O assunto está listado no índice coberto nas páginas citadas? Se o índice falhar neste primeiro teste de precisão, todos os outros testes se tornam desnecessários.

Verifique a ordem alfabética, mesmo no índice gerado por computador. Isso parece uma tarefa fácil, mas a alfabetização é um processo surpreendentemente complexo. Use a ordem alfabética palavra por palavra ou letra a letra, mas o uso deve ser consistente em um único índice.

Faça estas perguntas para determinar a precisão do seu índice:

- Os termos são usados corretamente no índice?

- A ortografia, capitalização, itálico e pontuação usados no livro são seguidos?

- A ordem alfabética é exata, seja palavra por palavra ou letra por letra?

- Verifique uma amostra de referências para se certificar de que o material indexado está realmente na página citada.

A precisão na escolha dos termos do índice pode ser testada verificando alguns termos técnicos e alguns ambíguos no índice em relação às passagens a que eles se referem, a fim de garantir que os termos escolhidos sejam apropriados.

Profundidade apropriada Você pode avaliar a profundidade tirando algumas páginas de amostra de texto, identificando os tópicos importantes abordados e procurando os tópicos no índice

74

para garantir que eles sejam incluídos. Este teste também revelará como você usou cabeçalhos e subtítulos para organizar o material.

Faça a si mesmo estas perguntas para determinar se seu índice tem a profundidade necessária para seu usuário:

- Todos os tópicos importantes (conceitos, assuntos, nomes próprios e assim por

diante) e instruções pertinentes são representados no índice? Verifique vários.

- As entradas são suficientemente específicas para permitir acesso imediato ao

material desejado, mas suficientemente abrangentes para evitar o espalhamento de termos relacionados? Os cabeçalhos escolhidos devem ser concisos, cada um referindo-se a um assunto específico.

- Existem referências cruzadas adequadas para orientar o usuário para entradas principais ou outras entradas que oferecem informações adicionais?

- Existem entradas duplicadas em vez de referências cruzadas onde o espaço permite?

Teste o índice de profundidade de duas maneiras:

1 Escolha algumas passagens do trabalho e verifique o índice para os termos que representam os principais tópicos discutidos. Se o índice não conseguir localizar as passagens selecionadas através dos termos escolhidos em mais de 5% das tentativas, algo está errado.

Nesse caso, um teste adicional deve ser feito: Tente localizar as passagens selecionadas através de termos mais gerais ou mais amplos do que os originalmente escolhidos. Se isso for bem-sucedido, os termos no índice não serão suficientemente específicos.

2 Analise o índice quanto a termos com um número notavelmente grande de referências de páginas. Bons indexadores tentam fornecer no máximo 10 a 12 referências para qualquer termo, evitando sequências de números de página.

Concisão O propósito da concisão é eliminar o espalhamento. A dispersão ocorre quando as

informações de ideias semelhantes são distribuídas entre diversos títulos e vários sinônimos. Dois pontos ajudam a resolver este problema:

- Analise seu público e descubra qual termo é o termo de ponteiro mais

apropriado. Procure nos manuais dos concorrentes para ver quais termos individuais aparecem com mais frequência em seus índices.

- Coloque referências ver também sob as palavras para direcionar o leitor a sinônimos que apontam para informações relacionadas.

Referências cruzadas

75

Outra maneira de garantir que as referências cruzadas sejam usadas corretamente é listar os mesmos tópicos em dois ou mais locais. Por exemplo, você pode listar o rádio estéreo em dois lugares: uma vez como rádio estéreo e uma vez como rádio, estéreo.

Você deve reservar um tempo para verificar se os títulos " ver e ver também" são exatamente iguais às entradas reais. Nada é mais enlouquecedor para o usuário do que um loop de referência cruzada que leva o leitor a um caminho sinuoso. Nenhum índice deve dizer a um leitor que procura memória para ver a memória de acesso aleatório,que então envia o leitor para ver a memória do computador.

Pior ainda, nunca encaminhe o leitor para uma entrada cega, isto é, uma entrada que não existe! Esse é o pecado mortal da indexação.

Apenas as referências cruzadas necessárias devem ser incluídas. Para uma entrada de assunto sem subtítulos, leva menos espaço para inserir as referências de página em duas categorias diferentes (por exemplo,utilizadores e consumidores) do que para levar o leitor desnecessariamente de um para o outro com uma referência ver.

Uma referência também deve levar a informações adicionais, não às mesmas referências de página em um segundo cabeçalho. Referências cruzadas precisas, lógicas e úteis são as marcas de um bom índice.

Logicalidade

Você pode avaliar se um índice tem tópicos lógicos fazendo a si mesmo estas perguntas:

- A entrada é apropriada para o material indexado?

- Permite a digitalização fácil e rápida e a identificação precisa das referências desejadas?

- As entradas principais são facilmente diferenciadas das subentradas?

- O arranjo de subentradas é prontamente aparente?

- As subentradas têm uma relação lógica e gramatical com as entradas

principais?

- Se alguma explicação for necessária, elas são facilmente identificadas e

lúcidas?

- Quando uma referência abrange várias páginas consecutivas, o início e o final da referência são indicados claramente?

- As referências de página diferenciam entre discussão principal e menção

superficial do tópico?

- Se houver desvios da ordem alfabética normal, ou se alguma outra ordem (como

cronológica) for empregada, isso é necessário e é óbvio para o usuário?

76

- Os termos são usados consistentemente no índice?

- Um tópico que é indexado por um termo específico em uma passagem indexada

pelo mesmo termo (não mais amplo ou mais restrito) em outra passagem? (Se uma receita de ensopado de borrego é indexada em um livro de receitas sob cordeiro, então uma receita de perna de cordeiro também deve ser indexada em cordeiro, não em carne.

Alguns outros testes de usabilidade O teste de usabilidade é um método para testar a eficácia do seu índice. A melhor maneira de certificar-se de que seu índice é tão bom quanto possível é para você estudar os melhores índices em seu campo e ver como eles estão estruturados. Em seguida, verifique se seus índices seguem essa estrutura. '

Não importa o livro, o índice deve ser examinado e testado. Testes como os listados abaixo irão em breve preencher os requisitos de um bom índice e os tipos de referências necessários. Tente alguns desses métodos para determinar se seu índice está completo e é útil.

Escolha de Parágrafo Uma boa maneira de testar é ler um parágrafo e tentar descobrir os tópicos nos quais ele foi indexado. Se é fácil descobrir os tópicos, o índice é bom; se eles são difíceis de descobrir, o índice é ruim.

Números de página em negrito Verifique se as referências da página principal, ilustrações, tabelas ou semelhantes estão indicadas no índice. Por exemplo, se você tiver várias referências de página para um determinado tópico, indique qual é a referência da página principal colocando o número da página em negrito:

rádio estéreo 3,10,19,50

Entradas de verificação de pontos, assuntos A exaustividade de um índice pode ser um rápido preditor da qualidade de um manual. Um teste de índice é:

- Escolha um ou dois itens de cada seção alfabética do índice e procure-os no

documento.

-

Em seguida, escolha um ou dois itens das páginas selecionadas e procure-os no

índice.

Se o índice falhar em ajudá-lo a encontrar itens facilmente ou se o índice estiver incompleto, isso é insatisfatório. Esse teste simples pode servir como um forte indicador da qualidade de outras partes do manual que não são tão aparentes.

77

Verificando a integridade Para verificar a integridade de seu índice e texto, compare seu índice com o índice de um concorrente. Se o Concorrente não tiver uma palavra ou termo de índice, verifique se é porque você não incluiu a palavra no índice ou se o manual omitiu essa informação.

78

23 Dicas de indexação

Alguns pensamentos finais

Eu não posso acreditar que eu sou a única pessoa no mundo que acha necessário estar perpetuamente saltando da mesa de refeição para expor alguma referência adequada de sua biblioteca. Os leapers-leais saberão muito bem que metade de um índice é freqüentemente pior do que nenhum índice, e que a inadequação nesse departamento resulta em um retorno, de mãos vazias, a uma mesa de raiva anapolaustica. - Rodney Dale, O Tumor na Baleia: Uma Coleção de Mitos Modernos

Doze dicas para melhor indexação

Aqui estão 12 dicas para tornar a indexação uma experiência mais fácil e precisa:

- Sempre indexe da mesma maneira. Desenvolva o hábito de indexar enquanto

escreve.

-

Coloque os termos de índice na palavra ou frase a ser indexada ao indexar on-

line.

-

No mínimo, crie uma referência para cada tabela e figura. Você é encorajado a

incluir várias referências para cada tabela e figura. Tabelas e figuras geralmente

contêm grandes quantidades de informações detalhadas e variadas. Por ter acesso a várias referências diferentes, é mais provável que os leitores encontrem as informações de que precisam.

- Gere o índice com frequência e mantenha-o à mão para verificar ortografias, plurais e assim por diante.

- Ser consistente.

- Integre a indexação no processo de documentação.

- Agende-o no seu plano de documentação.

- Comece a indexar cedo; Não deixe ir até o fim.

- Revise o índice com o restante da documentação.

- Dê cópias do documento e do índice de rascunho para os testadores beta e suporte ao produto.

- Dê cópias a outros escritores para verificar a precisão, a profundidade apropriada, a concisão, a referência cruzada e a lógica.

- Sempre tem o índice editado por um editor.

Coisas que não devem ser indexadas Aqui estão algumas coisas que normalmente não são indexadas:

- Autores e títulos listados na bibliografia e citados como referências

- Menções sem importância de assuntos em notas discursivas

- Nomes das pessoas mencionadas no prefácio, como confirmações e históricos de revisão

79

- Informações na página de título

Alguns fazem e não fazem

Aqui estão algumas das coisas que você deve fazer ao indexar:

- Demore bastante tempo para o planejamento inicial - os erros cometidos aqui nunca serão recuperados.

- Seja exato. Nunca adivinhe ou confie em ser praticamente certo - confira.

- Verifique todas as consultas antes de colocar as cartas ou entradas em ordem alfabética.

- Treine sua memória.

Aqui estão algumas coisas que você não deve fazer ao indexar:

- Não insira referências diferentes para a mesma pessoa, lugar, coisa, evento ou tópico em tópicos diferentes.

- Não faça referências a coisas ou tópicos semelhantes em um tópico.

- Não sobrecarregue as primeiras 50 páginas.

- Não, por conveniência na edição, economize nas descrições e modificações. Isso ajudará você a remover o índice no último comprimento que desejar.

80

24 Indexação online

Aponte o caminho

A solução para a documentação inacessível pode ser tão simples e de baixa

Com a indexação

adequada, dez por cento a mais de esforço duplicarão a acessibilidade das informações. Além disso, a maioria de seus esforços para melhorar a indexação de documentos on-line também melhorará os documentos em papel. - William Horton, "Uma correção rápida (e não muito suja) para documentação on-line", em Comunicação Técnica

tecnologia quanto a criação de um índice melhor

Indexação humana vs. máquina Para que a documentação - online ou impressa - seja bem-sucedida, o acesso é o ingrediente essencial para a usabilidade do documento. Um bom índice facilita o acesso, e esse é o objetivo principal do índice. E a indexação de documentos on-line é exatamente igual à da cópia impressa!

Para criar os melhores índices, isso deve ser feito manualmente, não gerado por um computador ou por meio de pesquisa de texto completo. Algumas razões pelas quais os humanos devem gerar o índice, em vez de usar a indexação baseada em ferramentas, incluem:

- Um índice é um processo de análise intelectual, que os computadores ainda

precisam dominar mesmo primitivamente.

- Como o texto do corpo contém as respostas às perguntas de um usuário e não

a pergunta em si, um ser humano pode antecipar o texto necessário ao indexar pelo método da resposta à pergunta.Mesmo que o sistema automatizado possa inferir o

significado das palavras presentes, falta-lhe a sutileza de expressar esse significado em termos que um usuário ingênuo empregará ao pesquisar essas informações.

- A indexação baseada em ferramentas requer um auxílio de vocabulário

controlado, como um tesauro, portanto os termos são os mesmos e apenas as pessoas podem decidir quais termos manter, remover e colocar em termos mais amplos ou mais restritos, o que é particularmente útil na indexação de equipes ou para

manter consistência.

- Embora os computadores como sistemas especialistas possam ser valiosos,

eles não podem ser substituídos pela intervenção humana para coisas como verificação ortográfica, uso de ordem de palavras adequada, manutenção do índice e

permutação de frases, como inverter termos.

- Pesquisas mostram que duas pessoas correspondem a menos de 50% do

tempo ao analisar a mesma passagem, e algumas deduzem que os termos criados por humanos falham com mais frequência do que o obtido. Porém, a maioria dos testes de

recuperação mostra que a maioria dos termos criados por computador também não corresponde a 50% do tempo.

81

- Os documentos técnicos, por sua natureza, contêm palavras e frases incomuns

que dificultam o reconhecimento por sistemas automatizados.

- Índices conceituais fornecem acesso direto a idéias significativas de qualquer ponto em um documento, não apenas os nomes das coisas que podem ser encontradas facilmente pelos recursos de pesquisa.

- Muitas das informações em documentos técnicos são gráficas, como tabelas,

diagramas de sintaxe e imagens de tela, as quais a maioria dos sistemas automatizados não pode perscrutar e entender, nem os rótulos curtos e legendas de muita ajuda para o sistema automatizado.

Hipertexto definido O hipertexto é uma extensão do texto ou documento. É uma maneira de se mover sobre um documento via hiperespaço, que é uma geometria com muitas dimensões. O hipertexto é um texto multidimensional. Uma dimensão é a estrutura interna. Outra dimensão é a relação entre o texto. Outra dimensão ainda é a capacidade das pessoas de se comunicar enquanto manipulam o texto.

Existem quatro tipos de texto no hipertexto:

- Texto, que é um documento

- Microtexto, que é uma parte de um documento

- Macrotexto, que é muitos documentos

- Grouptexto, que é onde o texto é compartilhado para que as pessoas possam se comunicar diretamente.

Existem três maneiras de acessar documentos de hipertexto:

- Leitura, o que implica a abordagem tradicional, sequencial, linha por linha, da página um até o final

- Navegação, que envolve saltar de um lugar para outro e apenas ler pequenos segmentos em cada um desses lugares

- Searching, que ocorre quando uma pessoa conhece o nome de alguma informação e quer apenas aquela informação específica

Interesse crescente

Há um interesse crescente em usar o hipertexto para propósitos de indexação. Esse interesse é baseado em:

- Maior disponibilidade de material eletrônico on-line

- Reconhecimento de benefícios decorrentes da união de hipertexto e indexação

- Fabricantes de software adicionando recursos de hipertexto aos seus novos produtos.

82

Estudos mostram que a leitura de papel é mais rápida do que a leitura de telas de computador por um fator de 30%. Em alguns casos, como quando há confusão sobre comandos de virada de página ou há ansiedades que alguns usuários têm na leitura de um computador, o tempo para ler um texto na tela do computador dobra. No entanto, a documentação on-line está se tornando uma realidade devido aos custos e porque as interfaces gráficas com o usuário e o software facilitam o uso.

Critérios para um bom índice online Um bom índice online atende aos seguintes critérios:

- Fornece vários pontos de entrada

- Inclui rotas de acesso consistentes

- Segue as ideias dos usuários

- É muito detalhado

- Garante acesso rápido a informações

- É fácil de ler

O critério mais importante é fornecer vários pontos de entrada para que haja muitos termos diferentes que apontem para a mesma informação. Por essa definição, um bom índice é aquele em que todos os palpites do leitor parecem encontrar um ponto de entrada no índice.

Um bom índice on-line também fornece rotas de acesso consistentes. Isso é facilmente realizado garantindo que você use termos invertidos. Por exemplo, se você usar

vírgulas com números de telefone, 234

em seguida, certifique-se de inverter os cabeçalhos para garantir rotas de acesso consistentes:

números de telefone commas, 234

Ou coloque uma referência cruzada ver também na entrada:

números de telefone veja também vírgulas

Estratégias de pesquisa Os usuários trazem seu próprio mundo de experiência e conhecimento ao usar um índice. Por causa disso, os usuários abordarão um índice de maneira diferente. Alguns examinarão as listagens de palavras e deixarão a lista avisá-las. Alguns procuram um item relacionado e vão para essa seção. Alguns tentam usar as sugestões tipográficas

83

dadas. Alguns perdem a noção de onde estão quando realizam uma pesquisa.

Como há muita diferença na estratégia, é importante tornar seu índice o mais completo possível. A maioria dos usuários de índice pode pensar em apenas três ou quatro palavras ou categorias alternativas como pontos de entrada para as palavras que encontrarem. Para fazer com que as estratégias de busca funcionem para os índices online, tenha sempre em mente que é o conhecimento de base do usuário sobre qualquer assunto determinado que determina como a pesquisa será feita.

84

25 Padrões de Indexação

Para quem é a norma

um bom índice fornece aos leitores o escopo e o conteúdo de todo o livro em uma visão geral altamente condensada, como se o esboço e o tratamento do autor fossem embaralhados e remontados em ordem alfabética. - June Morse em "Como Reconhecer um Bom Índice" no Olho Editorial

Necessidade de padrões Um padrão é algo que é considerado um modelo a ser usado como base de comparação. Embora a indexação seja uma atividade criativa, o próprio processo

desafia a padronização. Se o mesmo texto for indexado por diferentes indexadores, os resultados serão ligeiramente ou mesmo substancialmente diferentes. Mesmo quando

o mesmo texto é indexado uma segunda ou terceira vez pelo mesmo indexador , os índices resultantes irão variar.

No entanto, os detalhes técnicos da indexação se prestam à padronização. Desde a década de 1950, várias organizações nacionais e internacionais vêm desenvolvendo padrões de indexação. Esses grupos tentaram criar padrões na construção de índices, desde a alfabetização até a terminologia de indexação, para obter consistência sem comprometer a natureza dinâmica inata da indexação.

Um índice ruim ou a falta de um índice são as principais reclamações sobre documentos técnicos. Por que existem tantos índices ruins? Muitas das causas podem ser encontradas na ignorância ou negligência de usar as boas práticas de indexação recomendadas pelos padrões de indexação. A adesão aos padrões promove

menos problemas. Embora os padrões nunca sejam perfeitos, eles geralmente contêm

a melhor orientação disponível para novatos e indexadores experientes.

Organizações de Padrões

A National Information Standards Organization (NISO) nos Estados Unidos e a British

Standards Institution (BSI) no Reino Unido são as duas organizações que são

fundamentais na produção de padrões de indexação.

O padrão britânico, BS 3700, é intitulado Recomendações do Padrão Britânico para Preparar Índices para Livros, Periódicos e Outros Documentos e foi lançado em 1988.

O padrão dos EUA, ANSI / NISO Z39.4, é intitulado American National Standard Guidelines for Indexes for Information Retrieval, e uma nova versão foi programada para lançamento em 1993.

O BSI é um órgão nacional independente que emite padrões em praticamente todos os

campos e em milhares de assuntos técnicos, científicos e intelectuais.