Modelo de Página de Elemento
Use este modelo de elemento de caixa de dica para definir propósito, posicionamento, parâmetros, sintaxe portátil, acessibilidade, exemplos, limites de conteúdo e regras de QA hoje.
Uma caixa de dica resolve um problema de priorização: conselhos opcionais úteis podem desaparecer dentro de um procedimento longo, mas movê-los para a sequência principal pode tornar um fluxo de trabalho obrigatório mais longo ou mais rigoroso do que realmente é. O elemento cria um limite visível ao redor do conselho que melhora a execução sem alterar a definição de conclusão. Esta referência renderiza cada bloco no modelo de elemento de 14 blocos bloqueado.
Por que este elemento é importante
Os leitores escaneiam páginas instrucionais em busca de decisões: o que deve acontecer, o que pode dar errado e o que pode tornar o trabalho mais fácil. Uma caixa de dica dá ao conselho opcional um papel visual e semântico estável. Seu rótulo permite que o leitor entenda o status do conselho antes de ler a frase. Isso reduz o risco de que uma otimização opcional seja confundida com um requisito obrigatório.
A extraibilidade por máquina significa que um sistema automatizado pode identificar um trecho delimitado de conteúdo e reter seu significado quando a página ao redor não está presente. O rótulo explícito de uma dica, o título curto e o corpo autocontido melhoram esse limite. A caixa ainda deve fazer sentido como texto simples: “Dica — Verifique o denominador: compare porcentagens apenas quando elas usam a mesma população e período.” O estilo visual ajuda as pessoas a escanear, mas as palavras carregam o significado.
O elemento falha quando se torna decoração. Um encorajamento genérico como “Lembre-se de criar conteúdo excelente” não adiciona decisão, técnica ou consequência. Também falha quando um autor esconde um requisito crítico dentro de um contêiner visualmente opcional.
Quando usar e quando não usar
Use uma dica quando o conselho for opcional, concreto, adjacente à tarefa que melhora e compreensível sem uma longa explicação. Bons candidatos incluem uma sequência eficiente, um diagnóstico útil, um atalho reversível, uma técnica de verificação ou uma forma específica de contexto para evitar retrabalho.
Não use uma dica para avisos de segurança, qualificações legais, ações irreversíveis, entradas obrigatórias, critérios de aceitação, definições que o leitor precisará depois ou fatos que sustentam o argumento principal. Use uma chamada important para uma condição que pode invalidar o resultado. Coloque ações obrigatórias no processo numerado. Coloque evidências na prosa ou célula de tabela que as sustentam.
Regras de posição no documento
A posição carrega significado. Uma dica funciona melhor imediatamente após a instrução ou explicação que melhora, porque o leitor pode aplicá-la sem manter o conselho na memória. Ela não deve interromper a resposta direta, separar uma frase de sua evidência, ou ficar entre um título e o parágrafo que define esse título.
Regras de posição da caixa de dica
| Localização | Permitido? | Motivo | Ação |
|---|---|---|---|
| Imediatamente abaixo do hero | Geralmente não | O leitor não recebeu contexto suficiente para julgar um conselho opcional. | Abra com a resposta direta ou problema. |
| Após a instrução relacionada | Sim | A técnica está disponível no momento do uso. | Mantenha a caixa para uma melhoria opcional. |
| Dentro de um item de lista ordenada | Não | Ênfase aninhada obscurece os limites das etapas e pode quebrar a renderização portátil. | Coloque-a após a etapa completa. |
| Antes de uma ação destrutiva ou irreversível | Não | O rótulo subestima a consequência. | Use um aviso importante e declare os limites de recuperação. |
| Após uma seção longa | Apenas se delimitada | O leitor pode não saber qual instrução a dica modifica. | Nomeie a ação alvo no título e na primeira frase. |
Anatomia
A anatomia tem quatro regiões significativas. O tipo controla a gravidade e o rótulo. O título opcional nomeia a ação ou decisão. O corpo fornece uma técnica e sua consequência. A posição ao redor conecta a dica à instrução que ela modifica. Espaçamento, borda, ícone e cor pertencem ao sistema de design; autores não os codificam no conteúdo.
A anotação deve identificar regiões semânticas, não medidas de pixels. Esses rótulos permanecem úteis se os tokens visuais mudarem depois.
Exemplos de design
A galeria deve mostrar o elemento sob pressão realista de conteúdo: uma dica curta de uma frase, uma dica de dois parágrafos, uma dica contendo código inline e a viewport estreita. Mantenha o conselho subjacente constante para que os revisores possam comparar quebra de linha e hierarquia.
Assim que os arquivos existirem, renderize-os com features-with-4-images-grid. O componente de galeria é preferível à grade de imagens de produto porque combina especificações neutras com exatamente quatro imagens e não introduz controles de comércio.
Parâmetros
Os parâmetros são um contrato de interface. Tipos e limites exatos evitam que um autor escreva um rótulo enquanto outro codifica o mesmo significado como prosa no corpo. A coluna de origem informa quem possui o valor para que os revisores saibam se devem corrigir o conteúdo, os metadados ou o componente.
Parâmetros da caixa de dica
| Nome | Tipo | Obrigatório | Mín/máx | Origem |
|---|---|---|---|---|
| type | Enum | Sim | Exatamente um de note, tip, important | Autor, selecionado com base na consequência semântica |
| title | String simples | Não | 2–7 palavras; máximo de 55 caracteres | Autor; padrão é o rótulo do tipo |
| body | Markdown | Sim | 1–2 parágrafos; 20–80 palavras | Autor a partir do briefing aprovado e evidências |
| link inline | URL mais âncora | Não | 0–1 link | Fonte interna verificada ou externa primária |
| posição | Relação no documento | Sim | Uma instrução ou explicação adjacente | Anatomia do tipo de postagem e julgamento do autor |
Estes são limites editoriais, não validação do renderizador. Excedê-los requer um motivo visível na revisão. Se o corpo precisar de vários subtítulos, listas ou citações, provavelmente é uma seção em vez de uma dica.
Sintaxe e exemplos de código
As notações abaixo carregam significado idêntico. O Markdown portátil usa uma diretiva que pode ser transformada por diferentes sistemas de publicação. O Hugo usa o shortcode callout existente. O WordPress usa uma representação de shortcode em nível de projeto; uma implementação WordPress deve registrar esse shortcode ou mapear a estrutura para um bloco personalizado.
Copie a caixa de dica no seu sistema de publicação
Mantenha o tipo, título e corpo equivalentes em todas as três notações.
Markdown portátil
:::tip{title="Verifique o denominador"}
Compare porcentagens apenas quando elas usam a mesma população e período.
:::
Hugo
{{< callout tip title="Verifique o denominador" >}}Compare porcentagens apenas quando elas usam a mesma população e período.{{< /callout >}}
WordPress
[tip title="Verifique o denominador"]Compare porcentagens apenas quando elas usam a mesma população e período.[/tip]
Isso resolve o principal risco de reutilização do modelo. O componente de abas existente aceita blocos de código, não requer imagens, expõe papéis de aba e painel e suporta os três rótulos fixos. Um novo shortcode duplicaria o comportamento funcional e adicionaria outra interface para manter.
Exemplos bons versus ruins
Isso funciona porque dá uma ação específica, explica o motivo e permanece opcional dentro de um procedimento de análise mais amplo.
A redação é clara, mas o tipo está errado. Aprovação legal é uma etapa obrigatória, portanto apresentá-la como dica subestima a consequência. Mova-a para a lista de verificação principal ou rotule a chamada como importante.
Outro exemplo fraco é “Dica profissional: otimize seu conteúdo para melhores resultados.” Não contém ação observável, restrição, método ou definição de “melhor”. Exclua-o ou substitua-o por uma técnica que o leitor possa executar e verificar.
Marcação de esquema e acessibilidade
Uma caixa de dica não requer um tipo Schema.org independente. Ela permanece parte do Article ou TechArticle que a envolve. Não marque conselhos opcionais como HowToStep; fazer isso os promoveria falsamente para o processo obrigatório. Se a página em si se qualificar para o esquema HowTo sob a política do site, apenas as etapas obrigatórias pertencem à sequência de etapas.
A acessibilidade começa com a semântica do texto. O rótulo visível deve dizer “Dica”; cor e ícone não podem carregar a distinção sozinhos. O título deve descrever a ação, o corpo deve ser legível na ordem do documento e os links devem fazer sentido fora da caixa visual. Evite texto em maiúsculas no corpo, rótulos apenas com emoji, controles interativos aninhados e uma série de caixas adjacentes que se torna mais difícil de navegar do que parágrafos comuns.
O renderizador de chamada atual produz um contêiner rotulado e corpo em Markdown. Os autores permanecem responsáveis por redação significativa, ordem de títulos ao redor da caixa, links descritivos e manter código ou tabelas fora quando criariam uma interface aninhada ilegível.
Regras de redação
Comece com a ação. Explique o benefício ou a falha evitada na mesma frase ou na próxima. Use uma ideia por caixa, 20–80 palavras, no máximo dois parágrafos curtos e no máximo um link. Prefira um título personalizado quando “Dica” sozinho não revela qual instrução próxima ela modifica.
Use linguagem direta e calma. Não inflacione conselhos opcionais com “sempre”, “nunca”, “crítico” ou “essencial”. Não adicione uma dica apenas para fazer uma página parecer projetada. Se a informação é central, retorne-a à narrativa principal. Se é apenas um encorajamento agradável, remova-a.
Dicas repetidas próximas umas das outras sinalizam um problema estrutural. Consolide conselhos relacionados em uma subseção, ou decida quais pontos são realmente etapas obrigatórias. O elemento deve aumentar o contraste na hierarquia de informações, não transformar a página inteira em um campo de caixas concorrentes.
Quais tipos de postagem usam e onde
Guias práticos usam dicas após a etapa que melhoram. Guias definitivos usam-nas após uma explicação complexa quando uma prática opcional evita retrabalho comum. Páginas de comparação usam-nas com moderação junto a uma nota de método, não como substituto de evidência. Listas de verificação usam-nas após um item quando o conselho melhora a eficiência mas não altera o status de conclusão.
O catálogo mais amplo de tipos de postagem SEO determina a ordem do documento. O hub de elementos de conteúdo SEO determina a família de elementos e alternativas relacionadas. Um autor de página deve consultar ambos: o contrato do elemento explica como a caixa se comporta, enquanto o tipo de postagem explica se aquela caixa pertence àquela posição.
Lista de verificação de QA
Um revisor deve rejeitar o elemento se qualquer verificação falhar, mesmo que seu tratamento visual pareça correto. O uso semântico incorreto se espalha quando autores copiam páginas existentes, portanto corrigir o tipo é mais importante do que preservar um layout familiar.
FAQ
Perguntas frequentes
Quantas caixas de dica uma página deve conter?
Uma caixa de dica pode conter uma etapa obrigatória?
O layout academy fornece o painel de conversão final. O exemplo visível, especificação, abas de três notações, regras de conteúdo e verificações de QA juntos formam o contrato de elemento implementável; nenhum layout adicional específico do elemento é necessário.
Mais tutoriais nesta seção
Pronto para colocar em prática?
Verificação gratuita · Teste de 7 dias · sem cartão de crédito