Destaque e Ênfase

Diga-nos onde você está localizado!

Conteúdo deste Capítulo

Destacando fundamentos
Técnicas de ênfase específicas

Problemas comuns de destaque
Explorações adicionais
Esquema de destaque

Seus comentários sobre este capítulo

Pesquise!

Índice principal

Destaque, como o termo é usado aqui, é o uso de efeitos tipográficos para chamar a atenção para o texto. Esses efeitos podem incluir itálico, negrito, letras maiúsculas, aspas, cor, e assim por diante. Destacar chama a atenção dos leitores—ou "sinaliza"—ações que eles devem tomar ou informações que devem considerar cuidadosamente.

Um dos problemas na escrita técnica—em particular, a escrita técnica sobre computadores—envolve o uso das várias técnicas de ênfase. Infelizmente, alguns textos técnicos exageram no uso das diversas técnicas de ênfase discutidas aqui.

Destacando Fundamentos

Considere alguns princípios fundamentais de ênfase:

• Praticamente qualquer efeito textual especial que seja diferente do texto corpo regular pode funcionar como uma técnica de ênfase. Coisas como itálico, negrito, sublinhados, maiúsculas, tamanhos de fonte diferentes, fontes alternadas, cor, as várias engenhocas gráficas (mostrar, cor reversa, fontes contornadas) podem atuar como técnicas de ênfase.
• Usado em excesso, qualquer técnica de ênfase ou combinação de técnicas de ênfase pode perder sua capacidade de enfatizar e se tornar confusa e distraída. Usado em excesso, qualquer técnica de ênfase ou combinação de técnicas de ênfase pode fazer com que os leitores fiquem relutantes em ler um texto, se não o evitarem completamente. Observe como a versão excessivamente destacada do aviso é ilegível neste pop-up; também observe que não utiliza o tipo de aviso recomendado em avisos.
• Quando o texto longo deve ser enfatizado, use o formato de aviso especial (em vez de criar parágrafos totalmente em negrito ou totalmente em letras maiúsculas, por exemplo).
• Uma relação funcional cuidadosamente planejada deve existir entre o texto que é destacado e a técnica de ênfase utilizada.
• Técnicas de ênfase devem ser usadas de forma consistente para evitar que os leitores fiquem confusos.
• Para promover consistência, você deve usar um guia de estilo ou uma folha de estilo, que registra e, em seguida, dita todas as suas decisões sobre como você vai usar técnicas de ênfase.
• Para ajudar seus leitores a entender seu esquema de destaque, você pode incluir uma breve seção em algum lugar do seu documento (geralmente no prefácio) explicando como você irá usar as técnicas de ênfase.

Na discussão a seguir, você notará que qualquer sistema de técnicas de ênfase pode se tornar bastante complicado e difícil de lembrar para escritores e editores. Você notará que existem muitas maneiras igualmente válidas de usar técnicas de ênfase: por exemplo, em alguns casos, é arbitrário usar negrito ou itálico para ênfase simples. Para abordar esse problema, você deve documentar suas diretrizes de destaque em um guia de estilo que escritores e editores (ou apenas você) possam consultar. Um guia de estilo é simplesmente um registro das decisões que você e sua equipe de documentação tomaram sobre como deseja que seus documentos sejam apresentados.

Seus leitores também precisam ser informados sobre o esquema de destaque que você pretende usar. Isso pode ser tratado no prefácio: inclua uma seção chamada "Destaque" ou "Convenções Tipográficas" onde você liste como usa itálico, negrito, fontes e outros efeitos semelhantes. Para um exemplo, veja a discussão sobre prefácios no capítulo sobre componentes padrão de livros técnicos

Técnicas de Ênfase Específicas

Esta próxima seção aborda uma a uma as várias técnicas de ênfase, explicando as práticas comuns.

Nota: Para manter as coisas simples, destacando questões para tabelas, figuras, títulos, listas, e avisos são apresentados nessas seções.

Negrito

Na publicação, especialmente na publicação técnica, o uso é misto quanto a usar negrito ou itálico para ênfase básica. Por exemplo, se você quiser enfatizar que os leitores não devem desligar o computador sem antes desligá-lo, o "não" pode ser em negrito ou em itálico. Tradicionalmente, o itálico tem sido usado, mas, talvez por causa dos computadores, o negrito também é comumente utilizado.

Qualquer que seja a técnica que você usar, utilize-a de forma consistente ao longo do seu texto ou biblioteca de textos relacionados. A propósito, os leitores provavelmente não serão capazes de distinguir entre os níveis de ênfase: por exemplo, usar itálico para texto importante e negrito para texto muito importante provavelmente será perdido para a maioria dos leitores.

Se você for tentado a deixar um parágrafo inteiro em negrito, lembre-se de um dos princípios de ênfase discutidos acima: usar muito uma técnica de ênfase faz com que o efeito da técnica seja perdido. Não só isso, mas muita ênfase torna os leitores menos inclinados a ler. Em vez de ler cuidadosamente um parágrafo todo em negrito, os leitores podem ignorá-lo completamente!

Em vez de criar um parágrafo todo em negrito, use o formato de aviso especial. Nele, uma palavra-chave (por exemplo, Importante, Nota, Perigo, Cuidado, Aviso) é destacada em negrito, enquanto o restante do texto fica em romano normal (ou seja, a mesma fonte e estilo do texto regular).

O uso legítimo de negrito em textos técnicos varia amplamente. Desde que você desenvolva um esquema que esteja diretamente relacionado à necessidade do leitor e às características do texto (ou tecnologia) e que não leve ao exagero, seu uso de negrito deve funcionar bem.

Aqui estão alguns usos comuns e padrão de negrito:

• Ênfase simples. Conforme discutido anteriormente, alguns textos técnicos usam negrito para ênfase simples em vez do tradicional itálico. Por exemplo, "Faça não "desligue o computador antes de desligá-lo."
• Comandos. Os textos de informática comumente usam negrito para comandos, por exemplo, "Use o mover comando para renomear arquivos UNIX." Veja a seção sobre destacar texto de computador para uma revisão do conjunto completo de técnicas de ênfase.
• Botões que iniciam comandos. Em uma interface gráfica do usuário, alguns dos botões iniciam comandos. Por exemplo, "pressione o Saída "botão para sair do aplicativo."
• Rótulos de campo. Enquanto alguns textos de computador destacam em negrito os rótulos dos campos, isso não é uma prática geral, pois leva a um excesso de destaque. Por exemplo, "No Indentaçãop área da caixa de diálogo, clique em Esquerda." Mais comum é usar o estilo de maiúsculas utilizado na tela. É preferível escrever o seguinte: "Na área de Recuo da caixa de diálogo, clique em Esquerda."
• Ícones ou botões do teclado ou do mouse. Embora não seja universalmente observado, outra técnica de destaque que segue esse sistema logicamente é colocar em negrito o nome de uma tecla de teclado ou botão de mouse. Por exemplo, "Pressione o Q chave ou a esquerda botão do mouse." Em conformidade com esse sistema, também é para usar negrito em ícones: "Clique no Começar ícone."
• Rótulos em hardware. Outra prática comum na publicação de computadores é destacar em negrito o nome de uma etiqueta de hardware. Por exemplo, "Pressione o Redefinir "botão para reiniciar o computador."

Você notará que a discussão anterior não estabeleceu regras absolutas. É assim que é—a prática de publicação técnica é bastante variada. A ideia principal é desenvolver um sistema lógico e controlado de destaque, usá-lo de forma consistente e documentá-lo em um guia de estilo para que você e os membros da sua equipe de documentação possam se referir a ele.

Itálico

Aqui estão alguns dos usos padrão para itálico:

• Ênfase simples. Como mencionado anteriormente, o uso é misto sobre se deve usar negrito ou itálico para ênfase simples, embora o itálico tenha sido tradicional: por exemplo, "Faça não desligue o computador antes de desligá-lo." Qualquer que você use, seja consistente e documente em seu guia de estilo ou folha de estilo para que todos em sua equipe de documentos possam ver. Se você não tiver certeza de qual usar, use itálico para ênfase simples: é menos carregado.
• Variáveis . Na publicação digital, um dos usos mais comuns de itálico é para variáveis. Por exemplo:
  
  cópia arquivo_antigo arquivo_novo
  
  Os usuários sabem que não devem digitar arquivo antigo ou novoarquivo mas para substituir seus próprios nomes de arquivo em vez disso.
• Definições em listas de definição (duas colunas). Embora o negrito seja mais comum para os itens na coluna da esquerda de uma lista de duas colunas, a itálica também é utilizada. (Veja a discussão sobre listas de duas colunas na seção anterior sobre negrito.)
• Termos onde o termo é definido. Um toque agradável é italicizar uma palavra onde é definida no texto principal.

Sublinhados

Quase não há razão para usar sublinhados em textos técnicos. Nos tempos de textos datilografados, certamente havia. No entanto, nestes tempos, em que negrito, itálico e outros efeitos tipográficos estão prontamente disponíveis, sublinhados parecem obsoletos. Se você quiser enfatizar algo, siga suas diretrizes padrão—por exemplo, use itálico ou negrito. Não tente criar gradações de ênfase: por exemplo, uma escala de importância crescente que vai de itálico a negrito a sublinhado será perdida para seus leitores.

Se você observar um bom uso de underlines em textos técnicos, provavelmente ocorrerá no design de cabeçalhos.

Capitalização

Na publicação técnica, parece haver uma disputa constante entre redatores técnicos e especialistas técnicos sobre a capitalização. Especialistas técnicos gostam de usar letras maiúsculas para praticamente todos os componentes e processos em um sistema. Além disso, especialistas técnicos (e a gestão) normalmente usam letras maiúsculas para textos que consideram importantes e que desejam que os leitores prestem atenção. Enquanto isso, redatores e editores técnicos (corretamente) insistem em usar letras maiúsculas apenas para nomes próprios.

Como redator técnico, mantenha a linha contra a capitalização. Letras maiúsculas são distrativas; texto em letras maiúsculas é desconfortável de ler. Letras maiúsculas criam um texto confuso, que envia muitos sinais desnecessários. Letras maiúsculas são tradicionalmente destinadas a nomes próprios, como Microsoft, Netscape, Gateway, Dell Computers, WordPerfect e assim por diante. A diretriz clássica na publicação técnica é capitalizar os nomes de produtos separadamente disponíveis para pedido somente. No entanto, a política das organizações distorce essa diretriz consideravelmente. Se uma empresa está orgulhosa de uma determinada característica em seu novo lançamento, por exemplo, EnergyMiser, ela a destacará, mesmo que você não possa pedi-la separadamente.

Aqui estão algumas diretrizes típicas para a capitalização:

• Use o estilo exato de capitalização das mensagens exibidas na tela do computador, menus ou nomes de tela, nomes de campo, rótulos de hardware, e assim por diante. (Em interfaces mais antigas, usava-se letras maiúsculas para coisas como nomes de campo, menu e tela. Uma prática comum nesses casos é usar letras maiúsculas iniciais para referências a essas coisas no texto regular. O princípio aqui é que o uso desnecessário de letras maiúsculas no texto regular é distrativo.)
• Fazer não USE LETRAS MAIÚSCULAS PARA ÊNFASE; USE ITÁLICO OU NEGRITO EM VEZ DISSO.
• Não use letras maiúsculas para nenhum texto extenso; use a formato de aviso especial em vez disso.
• não capitalize os nomes dos componentes ou processos de um produto. capitalize apenas os nomes dos produtos, ou seja, componentes que podem ser pedidos separadamente.
  
  Por exemplo, seu produto pode ser chamado WordStuff e, claro, deve ser escrito com letra maiúscula de acordo com o estilo ditado pelos planejadores de marketing e produtos. No entanto, uma das funcionalidades do WordStuff chamada "verificador ortográfico" não deve ser escrita com letra maiúscula—quase todo mundo tem um desses. No entanto, o WordStuff pode ter um recurso chamado "ZippyFormat" e outro chamado "Image Worker." Embora esses não sejam encomendáveis separadamente, você vai querer usar o estilo de inicial maiúscula por causa do seu estilo especial e seu valor de marketing. "Image Worker" é obviamente algo que a WordStuff, Inc., quer exibir—portanto, as maiúsculas.
  
  Mas quando você tem que quebrar regras assim, as exceções precisam estar no guia de estilo ou na folha de estilo.

Aspas simples ou aspas duplas

As aspas são frequentemente usadas de forma equivocada como técnicas de ênfase em textos técnicos. Como redator técnico, limite o uso de aspas ao uso tradicional, que inclui fala citada; números, letras ou palavras referidas como tais. As aspas, assim como as letras maiúsculas, tendem a criar um texto carregado e distraído e, portanto, devem ser evitadas.

Um uso legítimo de aspas duplas é a forma estranha, peculiar e não padronizada de usar palavras (chamadas de "aspas de medo" por Manual de Estilo de Chicago). Por exemplo:

Em um core dump, o computador "joga fora" todos os dados em um único arquivo.

Um texto de computador bem elaborado evita aspas de forma bastante rigorosa. Uma das principais razões é que alguns leitores podem supor erroneamente que devem incluir as aspas nos comandos que digitam.

Nota: Enquanto alguns textos técnicos têm usos bem definidos para aspas simples, geralmente não há um uso padrão para aspas simples, além da regra tradicional de citação dentro de uma citação e da regra de uso peculiar. Quando você vê aspas simples dentro de um texto técnico, geralmente não há mais justificativa para seu uso do que para aspas duplas.

Fontes alternativas

Um dos estilos mais comuns que envolvem fontes alternadas é usar Courier ou alguma fonte monoespaçada similar, no estilo de uma máquina de escrever antiga, em contraste com a fonte padrão do corpo (como Times New Roman ou Helvetica). Você pode criar este efeito em uma página da web usando um estilo CSS como <span class="example_text">. Por exemplo, "digite instalar para instalar o programa."

Aqui está uma revisão dos usos comuns de fontes alternativas:

• Texto de exemplo. Para sinalizar que está sendo mostrado um exemplo em vez de uma entrada obrigatória, uma fonte alternativa como Courier é frequentemente utilizada:

Por exemplo, se você quiser copiar um arquivo, digite copie seuarquivo.txt meuarquivo.txt. Um arquivo chamado meuarquivo.txt será criado, e seu conteúdo será o mesmo que seuarquivo.txt.

• Texto exibido. Computadores e outros equipamentos normalmente exibem coisas como avisos, códigos de status ou mensagens de erro. Estes aparecem em monitores ou em painéis LCD e semelhantes. Quando você se refere a este texto exibido, pode usar uma fonte alternativa como Courier. Por exemplo, "Se o diretório não existir, o sistema responderá com Nenhum arquivo ou diretório desse tipo." Ou, "À medida que o computador inicializa, a janela de leitura digital exibirá 8888."
• Códigos extensos de exemplo. Em textos de programação de computadores, amostras de programação extensas são frequentemente mostradas em Courier, por exemplo:

#verifique se há hackers mal-intencionados se ($address1 eq "" & $address2 eq "") { &wicked_address (500, "Erro de Pesquisa", "Por favor, insira um nome."); } elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/) { &wicked_address (500, "Erro de Pesquisa", "Endereço de e-mail malformado. Por favor, não destrua nossa pobre, humilde, escola de uma única sala virtual!."); }

Cor

A cor é usada em textos técnicos, mas é cara e difícil de gerenciar durante o ciclo de publicação.

No entanto, a cor é fácil de usar em informações online. É comum ver links de hipertexto, por exemplo, utilizando cor. Os ajudas online normalmente usam verde, enquanto páginas da web tipicamente usam azul para novos links e roxo para links que o usuário já explorou.

A tendência de usar cores indiscriminadamente em informações online é muito semelhante à tendência de exagerar com negrito, itálico, tamanhos de fonte e fontes alternativas em informações impressas. A sensação deve ser algo como: "Está lá, é legal, então vamos usar!"

Se você quiser usar cores, planeje isso com cuidado. Não espere que os leitores se lembrem de que o vermelho sinaliza uma ideia, o azul outra ideia e o verde ainda outra ideia. Fique com uma só cor. Em geral, evite usar cores para textos extensos. Em vez de fazer todo um aviso em vermelho, apenas deixe o rótulo de Aviso em vermelho e mantenha o texto do aviso em fonte normal (como o texto do corpo regular).

Melhor ainda, leia algumas das literaturas padrão sobre cor no campo da comunicação técnica. Existem questões gerais de design e questões internacionais:

• Usando cor. Fornecido pelo Sistema de Design da Web dos EUA (USWDS).
• Um Guia Internacional para o Uso de Cores em Marketing e Publicidade. Diferentes significações que o vermelho, por exemplo, tem internacionalmente. Confira sua Tabela de Simbolismo de Cores Internacional. Fonte: Six Degrees, LLC
• Lembre-se de que, de acordo com um artigo Na Wikipedia, "Cerca de 8% dos homens e 0,4% das mulheres são daltônicos em relação à cor vermelho–verde de alguma forma, seja uma cor, uma combinação de cores ou outra mutação."

Combinações do anterior

Em geral, é uma má ideia combinar técnicas de ênfase, por exemplo, negrito e itálico. Em textos técnicos não profissionais, você verá combinações chamativas como todas as letras maiúsculas em negrito-italico ou todas as letras maiúsculas em negrito-italico com aspas duplas. Evite isso!

Uma combinação legítima é usar itálico com fontes alternadas. Por exemplo, quando você mostra a sintaxe de um comando, você quer que todo o texto esteja em Courier, mas também quer que as variáveis estejam em itálico:

copiar NomeArquivoAntigo NovoNomeDoArquivo

Nomes Funcionais para Estilos de Personagem e Etiquetas

Se você já esteve no meio da indústria editorial, pode ter se deparado com algo chamado markup semântico. Isso significa nomear seções de texto de acordo com o papel estrutural que desempenham no documento—por exemplo, cabeçalho. O leitor não vê esses nomes, mas eles desempenham um papel importante na forma como o documento é formatado e como pode ser reutilizado.

Essa mesma ideia se aplica a palavras em frases dentro do texto. Por exemplo, no HTML de uma página da web, você pode usar o <b>palavra em negrito</b> tags para deixar uma palavra em negrito. Mas o negrito não indica a função da palavra ou frase. Em vez disso, comando ou teria rótulo_interface Portanto, na marcação semântica usando HTML e CSS, as coisas são mais funcionais se parecerem assim: <span class="comando">palavra em negrito</span>.

Arquivos que usam HTML e CSS são tipicamente convertidos para outros meios, como PDF ou até mesmo de e para XML. Usando funcionalmente Estilos de destaque nomeados, como descrito acima, podem facilitar muito o processo de conversão.

Explorações Adicionais

Depois de ler o que foi dito anteriormente, uma boa coisa a fazer em seguida é explorar publicações técnicas para ver quais esquemas de destaque elas usam. Observe a maneira como coisas como negrito, itálico, maiúsculas, fontes alternativas e outros efeitos semelhantes são utilizados. É muito provável que você veja um uso muito diferente do que leu aqui. Ao explorar, pense na lógica das técnicas de ênfase que você vê sendo utilizadas; tente formular as regras que os escritores parecem estar usando; observe inconsistências no destaque; e pense criticamente sobre o uso que você vê—é lógico? excessivo? "insuficiente?"

Depois de ter feito algumas explorações como esta, o próximo passo lógico é ler o capítulo sobre guias de estilo, se você ainda não o fez. Esquemas de destaque devem ser documentados em guias de estilo para que você não os esqueça e seus membros da equipe de documentação possam consultá-los.

Esquema de Destaque

Se todas as opções e alternativas discutidas anteriormente o deixaram sobrecarregado, considere usar o seguinte esquema de destaque. Baseia-se em destaques que você encontrará em muitos documentos UNIX, Windows e Linux.

Notas:

1. romano regular refere-se a qualquer fonte e tamanho de fonte que é usado para o texto do corpo.
2. Embora essas sugestões recomendem "estilo em maiúsculas na tela," os desenvolvedores às vezes têm uma tendência infeliz de usar todas as letras maiúsculas. Como um estilo em todas as maiúsculas reduz a legibilidade, use letras maiúsculas iniciais (estilo título) de qualquer maneira.
3. Se você mostrar aos usuários como inserir um comando, incluindo texto de exemplo, não destaque o comando que ocorre no texto de exemplo:

Use o mv comando para mudar o nome ou localização de um arquivo, por exemplo:
mv estearquivo.txt aquelearquivo.txt.

4. Se você mostrar aos usuários como inserir um comando, incluindo texto de exemplo, e incluir variáveis no texto de exemplo, use itálico nas variáveis.

Use o mv comando para mudar o nome ou a localização de um arquivo:
mv meu_arquivo.txt seu_arquivo.txt.

5. Se você simplesmente se referir ao nome de uma tela ou menu que não é clicado ou não inicia nenhum evento, use o estilo maiúsculo para a tela e a fonte romana regular.
6. Alguns estilos destacam a ação que os usuários devem tomar (por exemplo, pressionar, entrar, excluir). Isso certamente é uma opção, mas para mim é muita ênfase.

Os guias do usuário frequentemente apresentam um gráfico com os significados de destaques, fontes, cores e tipografia no prefácio:

Agradeceria suas opiniões, reações, críticas em relação a este capítulo: sua resposta.