Académique Documents
Professionnel Documents
Culture Documents
Referência BONURA, Larry S. The art of indexing. New York: Wiley, 1994. 233 p.
Resumo RESUMO
3 Índices técnicos................................................................................................................. 15
Índices de livros.................................................................................................................... 15
Índices de assuntos alfabéticos ............................................................................................ 15
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
9 Selecionando tópicos......................................................................................................... 30
Escolhendo tópicos para indexar .......................................................................................... 31
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
20 Gerenciando o índice........................................................................................................ 66
Determinando o tamanho ..................................................................................................... 66
Calculando tempo e custo .................................................................................................... 66
Estimando o tempo .............................................................................................................. 67
Estimando custo .................................................................................................................. 67
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.
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.
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.
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
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.
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
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.
3 Índices técnicos
Níveis de índices
Í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.
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:
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
Muitos que usam livros, documentos e outros textos todos os dias raramente
usam índices.
Muitos nunca são ensinados especificamente como usar índices.
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.
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
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
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.
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
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
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
referência. .
Cabeçalhos Lógicos
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
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.
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:
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
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.
lista de tarefas, aquelas coisas que seus usuários querem fazer com seu produto.
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
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 ver—Refere-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
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
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.
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?
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.
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
Relações gramaticais
Geralmente, há uma relação lógica entre cabeçalhos e subcabeçalhos. Há
freqüentemente um relacionamento gramatical também.
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.
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.
11 Organizando tópicos
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.
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
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.
Símbolos
!, repete o comando
&, para operação em segundo plano
+, Operador booleano
Numerais
286
386
486
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
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
é 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.
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 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.
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 also Constantine Romanesque 309,324,542. see also order,
religious
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.
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 “Nontext”
Materiais “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:
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
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.
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.
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
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.
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
indexação variam.
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.
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.
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.
3. Certifique-se de ter a capacidade de controlar o layout final do índice.
57
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
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
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.
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.
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
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.
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.
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.
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:
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.
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:
Um indexador inexperiente precisa entre 55 e 83 horas para criar o mesmo índice para
um manual de 220 páginas:
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
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
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
Í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
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
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.
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?
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
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.
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
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.
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
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
tecnologia quanto a criação de um índice melhor ... 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
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
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.
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.
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.
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.
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 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.
NISO, por outro lado, é mais especializado. Ele desenvolve padrões nacionais de
indexação e tópicos relacionados e se preocupa principalmente com padrões
relacionados a informações, trabalho de biblioteca e publicação. A NISO sucedeu ao
Comitê Z39 do Instituto Nacional de Padrões Americanos (ANSI), com o qual a NISO
agora é afiliada como um órgão independente. Todos os padrões emitidos pela NISO
são autorizados pela ANSI como American National Standards.
Marcação genérica
Mais e mais indexadores agora enviam um manuscrito eletrônico, que é um arquivo de
texto ASCII que pode ser movido facilmente de um computador para outro, porque os
caracteres ASCII foram padronizados (ISO 646).
À medida que mais e mais indexadores enviam manuscritos eletrônicos por modem e
disquete, o governo federal, os principais editores e as empresas de software
86