SEO Playbook · Element

Caixa de Aviso: Quando e Como Usá-la

Use caixas de aviso para declarar um risco específico, explicar sua consequência e fornecer a ação segura antes de trabalhos irreversíveis, dispendiosos, regulados ou perigosos.

16 min read

Uma caixa de aviso interrompe o leitor antes de uma ação que pode causar danos materiais. Não é um estilo geral de ênfase. Um aviso publicável declara o risco, a consequência e a ação que evita ou limita o dano.

Aviso: confirme o destino antes da exclusão
Excluir o workspace selecionado remove permanentemente seus projetos e relatórios armazenados. Exporte os registros que você precisa reter, verifique o nome do workspace na caixa de diálogo de exclusão e obtenha a aprovação necessária antes de selecionar Excluir workspace.

O elemento ao vivo funciona porque identifica o que pode dar errado, explica o que será perdido e fornece uma sequência segura antes do controle destrutivo. “Tenha cuidado ao excluir” não seria suficiente: transfere a avaliação do risco de volta ao leitor sem dizer o que significa um comportamento cuidadoso.

Por que este elemento é importante

Avisos existem para mudar uma decisão antes que o dano ocorra. Um leitor seguindo instruções geralmente se concentra em alcançar o resultado prometido, então pode ignorar qualificações que parecem contexto comum. Um aviso claramente delimitado interrompe esse impulso no ponto em que o leitor ainda tem escolha. Cria uma pausa deliberada, explica por que a pausa é importante e fornece uma próxima ação segura.

Este elemento serve à psicologia do leitor apenas enquanto os autores o usam seletivamente. Se conselhos rotineiros, pequenos inconvenientes e perdas irreversíveis recebem o mesmo tratamento, os leitores aprendem que o sinal visual raramente importa. Eles começam a ignorá-lo. O exagero cria portanto o exato modo de falha que um aviso deve prevenir: a mensagem importante é desconsiderada quando os riscos são reais. O tom deve informar, não assustar.

A extraibilidade por máquina significa que o software pode isolar o aviso e preservar seu significado fora dos parágrafos circundantes. Um bloco tipado com um rótulo de aviso textual e um corpo autocontido é mais fácil de identificar do que uma frase vermelha escondida dentro de uma etapa. A estrutura risco–consequência–ação também sobrevive a mudanças de apresentação. Um sistema de publicação automatizado pode mover o conteúdo entre Markdown, Hugo e WordPress sem inferir qual frase descreve o dano ou o que o leitor deve fazer.

Siga as regras de escrita de elementos ao mapear o elemento. Cor, ícone, texto em negrito ou um título chamado “Importante” não criam semântica de aviso por si só. As palavras devem permanecer completas quando copiadas como texto simples ou lidas sem o estilo visual da página.

Quando usar

Use um aviso quando o leitor está prestes a fazer uma escolha ou realizar uma ação com uma consequência material previsível. O elemento é obrigatório quando o conteúdo cobre qualquer um destes gatilhos:

  • Ação irreversível: exclusão, sobrescrita, publicação, envio, encerramento de conta ou outra ação que não pode ser desfeita de forma confiável.
  • Perda ou exposição de dados: registros podem ser apagados, corrompidos, divulgados, transferidos ou tornados inacessíveis.
  • Implicação de custo: uma ação inicia uma cobrança, renova um compromisso, consome uma franquia paga ou cria um custo que não é óbvio no ponto de decisão.
  • Risco à segurança ou saúde: seguir, combinar ou pular uma instrução pode causar lesão, doença ou atraso no atendimento.
  • Exposição legal ou de conformidade: uma ação pode violar uma lei, contrato, política, licença, regra de retenção, requisito de consentimento ou processo de aprovação regulado.

O gatilho, e não a preferência do autor ou a contagem de palavras disponível, controla a inclusão. Se um se aplicar, o aviso não pode ser reduzido a um rótulo vago, movido para uma isenção de responsabilidade genérica ou omitido para caber em um modelo. Encurte a explicação circundante primeiro.

Não use um aviso para um atalho útil, uma prática recomendada, uma definição, um pequeno inconveniente, um pré-requisito normal ou um erro reversível com recuperação óbvia. Esses são quase-acidentes porque podem ser “importantes” na linguagem cotidiana, mas não exigem uma decisão de parada. Coloque pré-requisitos necessários no procedimento, melhorias opcionais em uma caixa de dica e recuperação de falhas comum ao lado da etapa que repara.

Não avise apenas porque um resultado é indesejável. “Títulos de baixa qualidade podem reduzir cliques” é uma explicação de desempenho, não um aviso. Torna-se material de aviso apenas quando uma ação próxima cria uma consequência específica e material: por exemplo, alterar a estrutura de URL de um site ativo sem redirecionamentos pode quebrar links de entrada e remover destinos indexados. Nesse caso, declare a ação preventiva antes da mudança.

Onde colocar

Um aviso pertence imediatamente antes da primeira ação à qual se refere. “Ação” inclui uma instrução numerada, comando, envio de formulário, controle de compra, download, recomendação ou decisão sobre a qual um leitor pode agir. Coloque a caixa após contexto suficiente para identificar a situação, mas antes da primeira instrução executável. Nunca revele o risco após a ação, em notas de rodapé ou apenas em um FAQ de encerramento.

Se um aviso rege uma sequência, coloque-o antes da sequência e nomeie seu escopo: “As próximas três etapas substituem o banco de dados de produção.” Não repita o mesmo aviso dentro de cada etapa. Se uma etapa posterior introduzir um risco diferente, adicione um segundo aviso imediatamente antes dessa etapa.

Um aviso não pode estar diretamente ao lado de outra chamada, uma chamada para ação promocional ou um banner decorativo. Caixas adjacentes competem por atenção e podem fazer o aviso parecer parte de um conjunto de marketing. Ele não deve separar uma instrução de sua entrada necessária, uma afirmação de sua evidência ou um título de tabela da tabela. Adicione uma transição simples ou reestruture a seção para que o aviso qualifique claramente uma decisão.

Coloque textos legais padronizados de acordo com a política aplicável, mas mantenha o aviso operacional junto à ação arriscada. Mover o aviso para um rodapé porque uma isenção já existe prejudica seu propósito.

Anatomia

O elemento renderizado tem seis regiões semânticas:

  1. Rótulo de gravidade: texto visível que indica que isto é um aviso; não pode ser transmitido apenas por cor ou ícone.
  2. Título específico: nomeia a decisão ou perigo, como “Aviso: exporte registros antes da exclusão.”
  3. Risco: declara qual ação ou condição pode dar errado.
  4. Consequência: declara o resultado crível e quem ou o que é afetado.
  5. Ação: diz ao leitor como evitar, reduzir, verificar ou escalar o risco antes de prosseguir.
  6. Relação de posição: conecta o aviso à próxima ação que ele rege.

A legenda permanece como texto vivo da página em vez de estar embutida na imagem. Isso mantém cada rótulo disponível para tecnologia assistiva e permite que o design mude sem tornar a especificação imprecisa.

Exemplos de design

A biblioteca atual suporta um nível de gravidade de aviso: Hugo o renderiza com type="important". Não há variante separada para cautela, aviso, perigo, crítico ou emergência. Essa simplicidade deliberada torna a escolha do autor consistente e reduz a chance de dois autores atribuírem cores diferentes à mesma consequência. A desvantagem é que o componente não pode distinguir visualmente perda financeira recuperável de perigo físico imediato. Os autores devem declarar a gravidade no título e na consequência em vez de depender de uma cor mais forte.

A galeria portanto testa o único nível de gravidade sob suas variações de conteúdo suportadas: o rótulo padrão, um título personalizado específico, no máximo dois parágrafos e uma viewport estreita. Estes são casos de renderização, não níveis de gravidade diferentes.

Não invente gravidade adicionando emoji, letras maiúsculas, pontos de exclamação repetidos, classes personalizadas ou valores de tipo não suportados. Se a biblioteca ganhar múltiplos níveis no futuro, seus limites devem ser baseados na consequência e na resposta necessária, não no quão fortemente um autor se sente sobre o trecho.

Parâmetros

O renderizador tem apenas entradas de type, title e corpo. Risco, consequência e ação são campos editoriais dentro do corpo; mantê-los explícitos neste contrato evita que uma chamada visualmente válida publique orientação incompleta.

NomeTipoObrigatórioMín/máxPadrãoOrigem
typeEnumSimExatamente importantNenhum para este elementoAtributo do shortcode
titleString simplesSim3–9 palavras; 70 caracteresO padrão do renderizador é Important, mas o contrato de aviso exige um título específicoAtributo do shortcode
riskMarkdown simplesSim1 frase; 8–30 palavrasNenhumCorpo, primeira frase ou oração
consequenceMarkdown simplesSim1 frase; 8–35 palavrasNenhumCorpo após o risco
actionMarkdown simplesSim1–2 frases; 8–40 palavrasNenhumCorpo após a consequência
bodyMarkdownSim25–90 palavras; 1–2 parágrafosNenhumCorpo do shortcode
inlineLinkURL mais âncoraNão0–1 linkOmitidoCorpo
positionRelação de documentoSimUma ação ou uma sequência nomeadaImediatamente antes da ação governadaPosicionamento do elemento

O título deve começar com “Aviso:” a menos que um vocabulário regulado exija outra palavra explícita de gravidade. O corpo pode combinar risco e consequência em uma frase, mas todas as três funções devem permanecer identificáveis. Um link pode apontar para política detalhada ou instruções de recuperação; não pode substituir a ação segura imediata.

Sintaxe e exemplos de código

Todos os três mapeamentos carregam o mesmo tipo, título e corpo. A diretiva portável é a forma canônica de autoria. Hugo usa o shortcode callout existente. O WordPress pode implementar o mesmo contrato como um bloco registrado; uma forma de shortcode é aceitável apenas onde essa instalação o registrou.

Diretiva Markdown portável

:::warning{title="Warning: export records before deletion"}
Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.
:::

Shortcode Hugo

{{< callout type="important" title="Warning: export records before deletion" >}}Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.{{< /callout >}}

Use parâmetros nomeados juntos. Não misture o valor posicional important com um parâmetro title nomeado.

Bloco ou shortcode WordPress

<!-- wp:amicited/warning {"title":"Warning: export records before deletion"} -->
<p>Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.</p>
<!-- /wp:amicited/warning -->
[warning title="Warning: export records before deletion"]Deleting the workspace permanently removes its stored reports. Export the records you must retain and verify the workspace name before confirming deletion.[/warning]

A apresentação pode diferir entre sistemas, mas a gravidade textual, risco, consequência, ação e posição pré-ação devem sobreviver à conversão.

Exemplos

Bom: reprocessamento pago com risco de sobrescrita

Aviso: preserve a exportação aprovada
Executar esta importação com Substituir registros existentes sobrescreve valores revisados e consome outra execução de processamento paga. Baixe a exportação aprovada, confirme que o modo de importação é Adicionar novos registros e peça ao proprietário da conta que aprove qualquer execução de substituição antes de continuar.

Este exemplo nomeia dois riscos concretos, declara ambas as consequências e fornece ações que as previnem. Seu tom é factual: não afirma que a conta será arruinada ou que os dados serão irrecuperáveis se uma exportação retida fornecer um caminho de recuperação.

Ruim: risco sem orientação

Aviso: operação perigosa
Esta operação pode ter consequências graves. Prossiga por sua conta e risco.

O exemplo ruim não identifica a operação, descreve a consequência crível ou diz ao leitor como prosseguir com segurança. “Sério” é uma afirmação de gravidade não fundamentada, enquanto “por sua conta e risco” transfere a responsabilidade em vez de guiar o comportamento. Substitua pela mudança de estado exata, o que pode ser perdido ou violado, e a verificação, backup, aprovação, alternativa ou condição de parada necessária antes da ação.

Outra falha é o alarmismo excessivo: “Nunca toque nesta configuração ou seu site inteiro pode ser destruído!” Mesmo que a configuração seja importante, a redação não é limitada por um resultado provável e não fornece uma rota segura. Leitores que descobrem que a afirmação é exagerada desconsiderarão avisos posteriores.

Uma isenção de responsabilidade e um aviso desempenham funções diferentes. Uma isenção define escopo, qualificações, incerteza, status profissional ou os limites da responsabilidade. Um aviso identifica um perigo previsível em um ponto de decisão e muda o que o leitor deve fazer a seguir. Um não pode substituir o outro.

Para material legal, financeiro, de saúde, segurança, privacidade ou outro material regulado, mantenha a isenção aprovada em sua localização de página exigida e adicione um aviso antes de qualquer ação específica que possa criar exposição. Por exemplo, uma declaração geral de que um artigo é educacional não remove a necessidade de avisar antes de instruir um leitor a interromper o tratamento prescrito, transferir dados regulados, publicar uma declaração sem aprovação ou aceitar uma cobrança recorrente.

Os autores não devem improvisar conclusões legais dentro do aviso. Use a redação aprovada pelo revisor de assunto ou conformidade responsável, preserve qualquer terminologia exigida e forneça a ação operacional que o leitor pode realmente tomar: pausar, obter consentimento, reter registros, consultar um profissional qualificado, usar um canal aprovado ou escalar para revisão. Um link vago para “consultar os termos” é insuficiente quando a página pode declarar a condição de parada imediata.

Marcação Schema e acessibilidade

Uma caixa de aviso não tem uma propriedade dedicada de Marcação Schema e não deve criar um objeto JSON-LD independente. Permanece como conteúdo visível dentro do artigo que a contém. Quando qualifica um procedimento estruturado, seu texto completo pode ser incluído na instrução visível da etapa relevante e no HowToStep.text correspondente; não deve se tornar uma etapa falsa ou existir apenas em dados estruturados.

Os papéis de Accessible Rich Internet Applications (ARIA) comunicam o comportamento da interface à tecnologia assistiva quando o HTML nativo não o fornece. Avisos estáticos presentes quando a página carrega devem permanecer na ordem normal do documento e não precisam de role="alert". Um papel de alerta causa anúncio imediato e é apropriado apenas quando um aviso urgente aparece dinamicamente após uma interação. Aplicá-lo a toda chamada estática pode interromper usuários de leitores de tela e tornar a entrada rotineira na página ruidosa. O renderizador Hugo atual gera um <div> rotulado sem um papel ARIA, o que é aceitável para um bloco estático quando seu texto e posicionamento carregam o significado.

Independência de cor significa que o aviso permanece reconhecível em monocromático, modo de alto contraste, exportação apenas de texto e saída de leitor de tela. Use um título explícito “Aviso:” e descreva a gravidade em palavras: “exclui permanentemente”, “inicia uma cobrança recorrente”, “pode expor dados pessoais” ou “requer atenção médica”. Não escreva “evite a opção vermelha” nem dependa do texto alternativo de um ícone para fornecer o perigo.

Mantenha o título e o corpo na ordem de leitura antes da ação governada. Links precisam de texto âncora descritivo, o acesso por teclado não deve depender da chamada, e instruções essenciais não podem aparecer apenas em uma captura de tela. Se um componente interativo futuro permitir descarte, o descarte não deve ocultar um aviso obrigatório enquanto a ação permanecer disponível.

Regras de escrita

Escreva um aviso específico em 25–90 palavras e no máximo dois parágrafos curtos. Use um título de 3–9 palavras, normalmente começando com “Aviso:”. Nomeie a ação ou condição desencadeadora, a consequência crível e a resposta segura. Coloque a razão antes da regra: leitores obedecem de forma mais confiável quando entendem o que a regra previne.

Use verbos proporcionais. “Exclui permanentemente”, “sobrescreve”, “cobra”, “expõe”, “invalida” e “pode causar” descrevem mecanismos ou resultados. “Devasta”, “desastroso”, “aterrorizante” e “catastrófico” geralmente dramatizam em vez de especificar. Declare a incerteza honestamente quando o resultado depende do contexto, e nunca garanta segurança apenas porque um leitor segue uma precaução.

Mantenha um ponto de decisão por caixa. Uma lista curta é aceitável apenas quando várias verificações devem todas acontecer antes dessa única ação; caso contrário, use prosa. Não coloque texto promocional, benefícios, depoimentos, piadas, emoji decorativos, dicas não relacionadas, um procedimento completo, uma tabela de comparação, vários cabeçalhos ou uma chamada para ação dentro do aviso. Não oculte instruções necessárias atrás de um link.

Nunca use a caixa para proteger uma afirmação não fundamentada, intimidar um leitor a comprar ou criar urgência artificial. Se a ação for necessária, mantenha a ação no procedimento principal além de declarar a etapa preventiva no aviso. A caixa muda a atenção; ela não substitui a estrutura operacional do documento.

Tipos de postagem que o utilizam

O frontmatter postTypes registra os formatos registrados nos quais os gatilhos de aviso são previsíveis. Em cada linha, “obrigatório” significa que o autor não tem discrição uma vez que o gatilho declarado aparece; o elemento não pode ser removido ou comprimido abaixo de risco, consequência e ação para atingir uma meta de tamanho.

Tipo de postagemGatilho obrigatórioPosição exigida
guia definitivoO guia inclui instruções de segurança, saúde, legais, conformidade, pagas, destrutivas ou de manipulação de dados.Antes da primeira instrução arriscada em cada seção independentemente acionável.
guia práticoQualquer etapa é irreversível, pode perder ou expor dados, inicia um custo, cria exposição regulada ou apresenta risco de segurança ou saúde.Após os pré-requisitos relevantes e imediatamente antes da etapa ou sequência afetada.
página o que éA explicação inclui conselhos sobre os quais um leitor poderia agir em um contexto regulado, médico, sensível à segurança ou legalmente consequente.Antes da primeira recomendação acionável, não dentro da definição.
página de produtoUm controle, compra, cancelamento, migração, exclusão, integração ou uso de dados tem um custo material ou consequência irreversível não óbvia a partir de seu rótulo.Junto e antes da ação ou decisão relevante; nunca apenas nos termos do rodapé.
página de categoriaO conselho de seleção pode criar uma consequência de compatibilidade, custo total, segurança, saúde, legal ou conformidade.Antes da recomendação ou escolha de filtro que expõe o leitor ao risco.
página de caso de usoO fluxo de trabalho promovido manipula dados regulados, automatiza uma decisão consequente, incorre em custo ou pode produzir resultados irreversíveis ou inseguros.Antes da etapa do fluxo de trabalho ou ação do produto que introduz a exposição.

Outros tipos de postagem podem usar um aviso sempre que os mesmos gatilhos aparecerem. A tabela define casos recorrentes e não opcionais; não concede isenção a formatos omitidos de postTypes.

Lista de verificação de QA

Antes da publicação, verifique todos os seguintes itens:

  • A caixa nomeia uma ação, condição ou decisão específica que cria o risco.
  • A consequência declara o que pode acontecer e quem ou o que é afetado sem exagero.
  • A ação diz ao leitor como evitar, reduzir, verificar, parar ou escalar o risco.
  • O aviso aparece antes da primeira ação governada e nomeia claramente seu escopo.
  • Nenhuma dica, promoção, banner ou segundo aviso compete diretamente com ele.
  • Um gatilho obrigatório não foi omitido ou encurtado por layout ou contagem de palavras.
  • O tipo important e o título textual específico de aviso estão presentes.
  • A gravidade permanece clara sem cor, ícones, imagens ou contexto circundante.
  • Um aviso estático não usa um papel de alerta desnecessário; um aviso urgente dinâmico é anunciado adequadamente.
  • Qualquer isenção de responsabilidade permanece separada e não substitui a orientação no ponto de ação.
  • A redação regulada e a terminologia exigida têm a aprovação de assunto apropriada.
  • Os mapeamentos em Markdown, Hugo e WordPress preservam o mesmo título, corpo e posição.
  • O corpo permanece entre 25–90 palavras, não contém linguagem de marketing e usa no máximo um link necessário.
  • Os comentários de captura de tela nomeiam apenas as capturas futuras necessárias; nenhum caminho de imagem inexistente é renderizado.

FAQ

O que toda caixa de aviso deve conter? O risco específico, sua consequência crível e a ação segura devem estar todos presentes. O elemento está incompleto sem qualquer um deles.

Uma caixa de aviso pode aparecer após a ação arriscada? Não. Deve aparecer antes que o leitor possa agir, mesmo quando isso exigir reestruturar as etapas circundantes.

Uma isenção de responsabilidade legal substitui uma caixa de aviso? Não. A isenção define escopo ou limitações; o aviso muda o comportamento em um ponto de decisão específico. Páginas reguladas podem exigir ambos.

Uma caixa de aviso deve usar um papel de alerta? Não quando já está presente no carregamento da página. Reserve o papel de alerta para informações urgentes introduzidas dinamicamente após uma interação.

Quantas caixas de aviso uma página pode conter? Use uma por ponto de decisão distinto e consolide avisos com o mesmo alvo. Se os avisos dominarem a página, reestruture o procedimento ou reconsidere se a ação deve ser oferecida.

Uma caixa de aviso ganha seu destaque visual apenas quando previne um dano concreto. Declare o risco, a consequência e a ação com calma, coloque-os antes da decisão e preserve esse significado em toda saída.

← All SEO Playbook guides

Pronto para colocar em prática?

Verificação gratuita · Teste de 7 dias · sem cartão de crédito