Avisos especiais são um recurso importante da escrita técnica profissional: eles destacam informações especiais que os leitores precisam saber para entender o que estão lendo, para realizar o que desejam fazer, para prevenir danos ao equipamento, e para evitar ferir a si mesmos ou outras pessoas.

Avisos muito especiais. Avisos de última geração com comentários inteligentes.

Diretrizes para Tipos Específicos de Avisos

Este capítulo apresenta um estilo específico de avisos. Esteja ciente de que outros estilos e formatos existem.

  1. Use avisos especiais para enfatizar pontos-chave ou advertir ou alertar os leitores sobre danos ou ferimentos.
  2. Tenha cuidado para usar os tipos de avisos especiais com precisão, para seus propósitos definidos. Use os quatro tipos de avisos especiais das seguintes maneiras:

    Nota—Para enfatizar pontos ou lembretes, ou para indicar pequenos problemas em um procedimento.

    Cuidado—Para alertar os leitores sobre possíveis danos a equipamentos ou dados, sobre potenciais problemas no resultado do que estão fazendo, ou experiências negativas em potencial (como constrangimento).

    Aviso—Para alertar os leitores sobre a possibilidade de ferimentos leves em si mesmos ou em outras pessoas.

    Perigo—Para alertar os leitores sobre a possibilidade de lesões graves ou fatais para si mesmos ou para outras pessoas.

Nota: Dê uma olhada na sua garagem ou cozinha, e observe os avisos especiais que você vê nos produtos. Você verá bastante variação, que provavelmente depende de padrões específicos da indústria ou de normas corporativas.

Decidir qual tipo de aviso usar não é uma ciência exata. Apenas não use um aviso de perigo quando um aviso de advertência for mais apropriado (o mesmo que "dar alarme falso"). Além disso, use os avisos de forma consistente em todo o documento. Faça não crie seus próprios avisos, como colocar "Important:" no lugar de "Warning."

  1. Coloque avisos especiais no ponto do texto onde são necessários. Por exemplo, coloque um aviso de cautela ou de perigo pouco antes ou logo depois discutindo uma etapa na qual os leitores podem se machucar.
  2. Evite ter muitos avisos especiais em um único ponto do texto. Caso contrário, a eficácia do seu formato especial será perdida. (Se tiver muitos, combine-os.)
  3. Com avisos, advertências e notificações de perigo, explique as consequências de não prestar atenção ao aviso. Indique o que acontecerá se o leitor não obedecer ao aviso.
  4. Os exemplos nesta seção usam negrito. Evite o uso de todas as letras em maiúsculas no texto de qualquer aviso especial.

Nota: Em uma área de publicação devidamente configurada, os redatores técnicos não teriam de decidir qual tipo de aviso usar ou mesmo redigir a linguagem do aviso. Isso deveria ser função dos advogados da organização. Ainda assim, esses advogados podem estar ocupados demais para revisar seus avisos, e assim o ônus pode continuar a recair sobre você o redator técnico ou editor.

Formato para Avisos Especiais

Use o seguinte para detalhes específicos sobre a capitalização, tipografia (negrito, sublinhado, diferentes fontes, diferentes tamanhos de tipo), e espaçamento para cada tipo de aviso especial.

Nota

Use o seguinte formato para notas simples:

  1. Digite o rótulo "Nota" seguido por dois-pontos. (Embora alguns dos exemplos a seguir usem negrito, prefira itálico para evitar confusão visual com títulos.)
  2. Comece a digitar o texto da nota um espaço após os dois-pontos. (Mas não coloque o texto da nota em negrito ou itálico.)
  3. Use espaçamento simples no texto da nota; deixe uma linha em branco acima e abaixo da nota.
  4. Comece as linhas de continuação na margem esquerda regular.
  5. Alinhe a nota com o texto ao qual ela se refere (conforme ilustrado no segundo exemplo).

    6. Example of a simple note
    Exemplo de uma nota simples

    Example of a note within a bulleted list
    Exemplo de uma nota dentro de uma lista com marcadores (não texto corrido normal). Esse mesmo princípio (de que os avisos especiais se alinham ao texto ao qual se referem) aplica-se também aos outros tipos de avisos especiais.

Notas

Use o seguinte formato para várias notas:

  1. Use este formato quando tiver tantas notas que apresentá-las individualmente acabaria por distrair.
  2. Digite o rótulo "Notes" seguido por dois-pontos. (Embora alguns dos exemplos a seguir usem negrito, prefira itálico para evitar confusão visual com cabeçalhos.)
  3. Use uma lista numerada para as notas individuais; nela, siga as regras para listas numeradas. (Não use negrito ou itálico para as notas individuais.)
  4. Alinhe as notas com o texto ao qual se referem; pule o equivalente a uma linha acima e uma linha abaixo das notas.

    5. Example of a multiple note
    Exemplo de uma nota múltipla. Use este formato se você tiver muitas anotações e quiser juntá-las todas em um só lugar para evitar distrações.

Cuidado

Use o seguinte formato para avisos de cautela:

  1. Digite o rótulo "Caution" siga-o com dois-pontos, e coloque em negrito tanto o rótulo quanto os dois-pontos.
  2. Deixe uma linha em branco e comece o texto do aviso alinhado com o início do rótulo de aviso.
  3. Use espaçamento simples no texto da advertência; deixe uma linha em branco acima e abaixo do aviso.
  4. Alinhe o aviso de cautela com o texto ao qual se refere (no trecho anterior, o aviso de advertência ocorre dentro de uma lista numerada e está recuado de acordo).

    5. Example of a caution notice
    Exemplo de aviso de precaução. Use este para alertar os leitores sobre possíveis danos ao equipamento ou problemas com o procedimento.

Aviso

Use o seguinte formato para avisos:

  1. Digite o rótulo "Warning," coloque-o em itálico, e siga-o com dois-pontos.
  2. Ou pressione Tab até o início do texto do aviso, ou use o formato de recuo suspenso (que é muito melhor). O formato de recuo suspenso para o aviso no exemplo abaixo usa 0,63 polegadas tanto para a tabulação quanto para o recuo suspenso, mas o tamanho da fonte fará esse valor variar.
    Nota: Veja Criar um recuo suspenso para um vídeo sobre como criar o formato de recuo suspenso no Microsoft Word.
  3. Use a fonte regular do corpo do texto para o texto do aviso de advertência (sem negrito, sem itálico, sem texto em maiúsculas, sem cor).
  4. Alinhe o aviso de advertência com o texto a que se refere.
  5. Pule o equivalente a uma linha acima e abaixo do aviso.

    6. Example of a warning notice
    Exemplo de aviso. Use este para alertar os leitores sobre a possibilidade de lesão leve.

Perigo

Use o seguinte formato para avisos de perigo:

  1. Digite o rótulo "DANGER" em negrito e em caixa alta.
  2. Alinhe o aviso de perigo com o texto a que se refere.
  3. Coloque o texto do aviso de perigo em espaçamento simples; deixe uma linha em branco acima e outra abaixo do aviso de perigo.
  4. Use negrito no **texto do aviso de perigo** se o tiver (mas nunca tudo em maiúsculas).
  5. Se você tiver capacidade gráfica, desenhe uma caixa ao redor do aviso de perigo (incluindo o rótulo).
    6. Example of a danger notice
    Aviso de perigo. Use este para alertar os leitores sobre a possibilidade de lesões graves ou morte.

Imagens de Aviso (Ícones)

Por favor, veja imagens de aviso comuns.

Outros problemas de formatação

Aqui estão alguns pontos adicionais a considerar sobre avisos especiais:

Alinhamento especial. Avisos especiais devem alinhar-se ao texto a que se referem. Por exemplo, se você tiver uma nota que adiciona algum detalhe especial a algo em um item de lista com marcadores, você deve alinhar essa nota ao texto do item com marcador. Claro que, se a nota segue uma lista com marcadores mas se refere à lista inteira, então você pode usar a margem esquerda normal.

Texto com espaçamento simples. Todos os exemplos e discussões nesta unidade são baseados em texto com espaçamento simples. Deixe uma linha em branco entre o texto corrido e os avisos especiais—dependendo do que lhe parecer melhor. (E, claro, tanto o texto corrido quanto o texto dos avisos especiais estariam com espaçamento simples.)

Posicionamento de avisos especiais. Coloque avisos especiais pouco antes ou logo depois o ponto em que são relevantes. Por exemplo, você pode avisar os leitores para fazer backup de todos os dados antes você diz a eles para reformatar o disco rígido deles. No entanto, na prática, avisos especiais sérios são colocados no início de um procedimento em que é provável que ocorra grande dano a dados, equipamentos ou pessoas.

Uma técnica usada por escritores muito cautelosos (talvez aqueles que já foram queimados) é colocar todos os avisos sérios (advertências, precauções e perigos) em algum lugar no início do documento, e então repeti-los individualmente onde se aplicam. É provável que uma organização tenha um guia de estilo que estabeleça requisitos sobre a colocação dos avisos.

Tabela de significados de avisos especiais. Guias do usuário costumam colocar um quadro com os significados dos diferentes tipos de avisos no prefácio, como parcialmente ilustrado na parte inferior desta figura. Observe que, neste exemplo, não há o tipo de aviso de cautela, apenas ilustrando como os avisos variam entre indústrias:

Chart of notice types
Quadro de avisos. Observe que neste exemplo não há tipo de aviso de cautela, ilustrando como os avisos variam entre indústrias.

Múltiplos avisos especiais. Você se depara com situações em que tem três ou quatro avisos especiais, todos amontoados juntos na mesma parte do texto, cada um seguindo o outro. Isto é um problema porque todo o sentido da formatação especial dos avisos se perde: algo é especial porque é diferente do que o rodeia. A solução para esse problema é criar um título identificador (por exemplo, "Notas e Avisos"), e então listar os avisos (em marcadores ou numerados) abaixo dele.

Informações relacionadas

Definições ANSI para sinais de Perigo, Advertência, Cuidado ou Aviso. Inclui imagens para download.
1910.145 - Especificações para sinais e etiquetas de prevenção de acidentes. OSHA
Categorias de Sinalização de Segurança da OSHA (50487). Muitas imagens para download.
O que significam as diferentes cores dos sinais de segurança?. inclui imagens para download. Creative Safty Supply Por que o "12:00" piscando se tornou o símbolo definitivo da frustração tecnológica dos anos 90. Sydney Butler, howtogeek.com

Agradeceria suas opiniões, reações e críticas sobre este capítulo: sua resposta—David McMurrey.