` Escrita Técnica Online: Referência Cruzada

Por favor, clique aqui para ajudar David McMurrey pague pela hospedagem na web: Doe qualquer quantia que puder!
A Redação Técnica Online continuará gratuita.

Relatórios técnicos e instruções costumam exigir referências cruzadas—aqueles apontamentos para outros locais no mesmo documento ou para outras fontes de informação onde informações relacionadas podem ser encontradas.

Uma referência cruzada pode ajudar os leitores de várias maneiras diferentes:

  • Ele pode direcioná-los para informações mais básicas se, por exemplo, eles tiverem entrado em um documento acima de suas cabeças.
  • Pode direcioná-los a informações mais avançadas se, por exemplo, já souberem das coisas que você está tentando lhes dizer.
  • Além disso, pode direcioná-los para informações relacionadas.

Informações relacionadas são a área mais difícil de explicar porque, no final das contas, tudo está relacionado a tudo mais—não poderia haver fim para as referências cruzadas. Mas aqui está um exemplo do DOS—aquele troll que se esconde dentro dos computadores do tipo PC e supostamente ajuda você. Existem várias maneiras de copiar arquivos: o comando COPY, o comando DISKCOPY e o comando XCOPY. Cada método oferece vantagens diferentes. Se você estivesse escrevendo sobre o comando COPY, você gostaria de referências cruzadas para esses outros dois para que os leitores pudessem fazer um pouco de comparação.

Claro, a discussão anterior assume referências cruzadas dentro do mesmo documento. Se houver informações de fundo demais para cobrir no seu documento, você pode fazer uma referência cruzada a algum site externo, livro ou artigo que forneça esse contexto. Assim, você não precisa se preocupar em explicar tudo!

Componentes de Referências Cruzadas

Referências cruzadas podem ser interno (dentro do mesmo documento) ou externo (fora do documento atual). A maioria das diretrizes de referências cruzadas depende se a referência cruzada é interna ou externa.. Com fontes externas, você não pode controlar os títulos de livros, capítulos, cabeçalhos, números de página. Eles podem mudar!

Com referências cruzadas a documentos externos:

  • Não cite títulos de livros, capítulos, cabeçalhos exatamente palavra por palavra de forma verbatim. Em vez disso, faça referência ao tópico geral abordado.
  • Não cite números exatos de capítulos ou seções ou números de páginas exatos.

Agora, uma boa referência cruzada consiste em vários elementos:

  • Nome da fonte sendo referenciada—Isso pode ser tanto o título quanto uma referência de assunto geral. Se for um título de capítulo ou uma seção, coloque entre aspas; se for o nome de um livro, revista, relatório ou obra de referência, coloque em itálico. (Títulos de artigos individuais também vão entre aspas.)
  • Número da página—Obrigatório se estiver no mesmo documento. Se a referência cruzada for para o início de um capítulo e o número e título do capítulo forem citados (seja interno ou externo), não há necessidade do número da página. Os leitores podem usar o índice. Se a referência cruzada incluir um título interno a um capítulo numerado, inclua o número da página onde esse título ocorre.
  • Assunto da referência cruzada—Freqüentemente, você precisa mencionar o que está no material cruzado e indicar por que o leitor deve se dar ao trabalho de verificá-lo. Isso pode exigir indicar o assunto do material cruzado ou declarar explicitamente como ele está relacionado à discussão atual.

Essas diretrizes estão mostradas na ilustração a seguir. Observe nessa ilustração como as regras são diferentes quando a referência cruzada é "interna" (ou seja, para alguma outra parte do mesmo documento) em comparação com quando é "externa" (para informações fora do documento).

Exemplos de Referências Cruzadas

Referências cruzadas internas são referências a outras áreas dentro do mesmo documento; as externas são aquelas a recursos de informação externos ao seu documento.

Exemplos de Referência Cruzada Interna e Externa
Exemplo Para detalhes sobre como criar gráficos e então incorporá-los em um documento, veja a seção sobre gráficos neste guia na página 16.
Explicação Neste cruzamento de referência interna, a seção é referenciada genericamente. É padrão citar o número da página em referências cruzadas internas.
Exemplo Para detalhes sobre como criar gráficos e depois incorporá-los em um documento, consulte "Gráficos" no Guia Online de Redação Técnica.
Explicação O título do capítulo está entre aspas duplas. O título do livro em que o capítulo ocorre está em itálico.
Exemplo Para detalhes sobre como criar gráficos e depois incorporá-los em um documento, veja o capítulo sobre gráficos em guia de redação técnica online.
Explicação se você não quiser citar os títulos exatos do capítulo, basta usar letras minúsculas.
Exemplo Para detalhes sobre como criar gráficos e incorporá-los em um relatório, veja "Ilumine Esse Relatório Mensal!" no Boletim Informativo do Escritório.
Explicação Se você citar um artigo em uma publicação, coloque o artigo entre aspas e itálico o nome da publicação.

Fraseado Explicativo em Referências Cruzadas

É inútil e irritante encontrar referências cruzadas como esta: (veja Fig. 3)

Os leitores precisam saber sobre o que é o material de referência cruzada, por que eles devem ir vê-lo.

Eles também precisam de apenas uma ideia breve de como entender o texto interno com referências cruzadas, imagens, tabela, gráfico ou diagrama—apenas uma dica. Aqui está um exemplo (um fundo cinza foi adicionado ao texto de referência cruzada):

O lítio é extraído por dois métodos principais: técnicas tradicionais de mineração a céu aberto e extração de salmouras [6]. Como mostrado na Figura 3, os pegmatitos representam 26% dos recursos mundiais de lítio, enquanto as salmouras correspondem a 66% [6].

explanation of this image will be supplied Figura 3. Percentagem das reservas globais de lítio por tipo [6].

Exemplo de uma referência cruzada explicativa a um gráfico. Fonte: James Ball.

Uma vez que a salmoura em um lago de evaporação tenha atingido uma concentração ideal de lítio, a salmoura é bombeada para uma instalação de recuperação de lítio para processamento e extração adicionais. A solução de salmoura restante é devolvida ao reservatório subterrâneo [9]. A Figura 5 mostra a escala de um sistema típico de poço de evaporação de lítio. Observe o tamanho das estradas e dos postes de utilidade para escala.

explanation of this image will be supplied
Figura 5. Lagoas de evaporação de lítio [10].
Exemplo de uma referência cruzada explicativa. Fonte: James Ball.

Aqui está outro exemplo; o fundo cinza não está no original:

Mineração a Céu Aberto. A pegmatita é extraída de em diferentes níveis usando técnicas de mineração tradicionais. Os blocos de pegmatita extraídos são então moídos mecanicamente para reduzir seu tamanho. O minério moído é triturado ainda mais para produzir um produto mais fino, que é mais adequado para separação adicional. O processamento resulta em um concentrado que é quimicamente processado para criar carbonato de lítio ou hidróxido de lítio [3]. A Figura 4 fornece um exemplo de uma mina de lítio a céu aberto que mostra a escala típica dessas operações.

explanation of this image will be supplied
Figura 4. Mina de lítio a céu aberto [7].
Exemplo de uma referência cruzada explicativa. Fonte: James Ball.

Informações Relacionadas

Questionário de leitura. Use este questionário para testar sua compreensão deste capítulo.

Treinamento disponível. Pratique escrever com McMurrey como seu instrutor.


Agradeço seus pensamentos, reações e críticas em relação a este capítulo: sua resposta.