Frontmatter do Conteúdo: Campos e Metadados SEO
Use esta especificação de frontmatter e metadados para definir identidade da página, pré-visualizações de busca, propriedade, datas, URLs canônicos, taxonomia e schema de FAQ claramente.
Frontmatter é o elemento da página que os leitores nunca veem como um bloco e do qual todo sistema de publicação depende. Ele dá a um documento uma identidade, contrato de renderização, pré-visualização de busca, registro de propriedade, datas e entradas de schema. Um frontmatter quebrado pode selecionar o template errado, criar conflitos canônicos, perder o autor ou emitir marcação que contradiz a página.
O exemplar vivo é um registro ao nível do documento, exibido como código porque o frontmatter não deve se tornar uma caixa decorativa no corpo.
+++
entity = "guide-how-to"
id = "reset-api-key"
title = "How to Reset an API Key"
seoTitle = "How to Reset an API Key Safely"
description = "Reset an API key safely, replace it in every dependent service, verify the new credential, and revoke the exposed key without avoidable downtime."
url = "/academy/reset-an-api-key/"
image = "/images/academy/reset-api-key.png"
imageAlt = "API key settings with the Rotate key action highlighted"
date = "2026-08-27 10:00:00"
updated = "2026-09-03 14:30:00"
author = "maya-chen"
reviewedBy = "alex-rivera"
keywords = [ "reset API key", "rotate API key", "revoke API key" ]
taxonomy = [ "security", "account-administration" ]
canonical = "https://amicited.com/academy/reset-an-api-key/"
[[faq]]
question = "Does rotating an API key revoke the old key immediately?"
answer = "Not necessarily. Confirm the provider's rotation behavior before changing dependent services."
+++
Por que o frontmatter existe
Para um leitor, os metadados reduzem a incerteza. Um título preciso define o escopo, uma descrição útil conquista o clique, as identidades tornam as afirmações responsáveis e as datas revelam se a informação pode estar desatualizada. Esses sinais não compensam conteúdo fraco, mas sua ausência força o leitor a adivinhar.
Para as máquinas, o frontmatter substitui inferência por valores nomeados. Os templates mapeiam campos para títulos do navegador, links canônicos, registros de pessoas, datas, feeds, índices e JSON-LD sem extrair informações do texto. Isso é extraibilidade mecânica: fatos importantes têm uma localização e tipo consistentes.
Siga as regras de escrita de elementos: os metadados pertencem ao nível do documento; os elementos voltados ao leitor pertencem ao corpo. Uma linha de assinatura pode ser renderizada a partir do frontmatter, mas seu identificador autoritativo permanece lá.
Quando usar — e quando não usar
Toda página indexável precisa de um registro de frontmatter para identidade, renderização e roteamento. Rascunhos precisam dele quando entram em produção para que a validação possa falhar cedo.
Não oculte fatos do artigo no frontmatter. Limitações do produto, avisos de segurança, divulgações de afiliados, métodos e fontes devem permanecer visíveis onde os leitores possam avaliá-los. Um valor estruturado nunca substitui uma divulgação.
Quase-acertos causam mais dano:
- Rótulos de navegação, cópia de campanha e legendas sociais que variam independentemente são configurações de canal; não sobrecarregue o
title. - Fatos da organização compartilhados em todo o site pertencem ao registro da organização do site, não copiados em cada página onde se desviarão.
- Uma seção de perguntas e respostas pertence a
[[faq]]apenas quando o mesmo conteúdo é renderizado visivelmente. FAQ oculto apenas para schema é inválido. - Um rótulo de tópico pertence à
taxonomy; não deve substituir aentityque identifica o tipo de postagem do documento. - Um redirecionamento pertence à configuração de roteamento ou a um campo de aliases aprovado. O
canonicalidentifica a versão preferida; ele não redireciona visitantes.
Onde posicionar
O frontmatter começa no primeiro byte com +++ e termina no delimitador correspondente antes do corpo. Nenhum cabeçalho, comentário, nota, shortcode ou bloco de metadados pode precedê-lo. Campos e arrays TOML pertencem a esse único registro.
O corpo começa após o delimitador de fechamento. O frontmatter não pode ficar entre o H1 e a introdução, ao lado de uma captura de tela, dentro de um componente ou no final. Uma marca de ordem de byte ou um comentário perdido pode impedir o reconhecimento. Chaves duplicadas, delimitadores YAML e segundos blocos são inválidos.
Anatomia
A legenda renderizada permanece na página para que permaneça legível e traduzível independentemente da imagem:
- Limite: os delimitadores de abertura e fechamento
+++definem a única região de metadados. - Identidade:
entity,id,typeeurlinformam aos sistemas o que é o documento e onde ele está. - Descoberta:
title,seoTitle,description,image,imageAltekeywordsapoiam pré-visualizações e recuperação. - Proveniência:
date,updated,authorereviewedByindicam quem é responsável e quando o trabalho foi validamente alterado. - Classificação:
taxonomyjunta a página a coleções de tópicos controladas sem redefinir sua identidade. - Controle de duplicação:
canonicalnomeia a URL pública preferida quando versões equivalentes podem ser alcançadas em outro lugar. - Coleções estruturadas: cada
[[faq]]cria um registro tipificado de pergunta e resposta para renderização visível e schema.
Exemplos de design
O frontmatter tem variantes de contrato de dados, não estilos visuais. As capturas de tela emparelham registros fonte com sua pré-visualização ou linha de assinatura resultante.
Parâmetros
Estes são limites editoriais mesmo quando um analisador aceita mais. “Condicional” significa obrigatório quando sua condição declarada é verdadeira.
| Nome | Propósito | Tipo | Obrigatório | Mín./Máx. | Padrão | Formato | Origem | Consumido por |
|---|---|---|---|---|---|---|---|---|
entity | Distingue o tipo exato de postagem | string | Sim | 1 identificador estável | Nenhum | kebab-case minúsculo | atributo | validação, templates, análises, migrações |
id | Dá ao documento uma identidade interna imutável | string | Sim | 1 identificador estável | Nenhum | kebab-case minúsculo ou UUID aprovado | atributo | CMS, junções, migrações, deduplicação |
title | Nomeia a página para conteúdo e exibição padrão | string | Sim | 30–70 caracteres | Nenhum | texto simples; sem HTML | atributo | fallback H1, navegação, feeds, headline do schema |
seoTitle | Fornece um título específico para busca quando necessário | string | Opcional | 30–60 caracteres | title | texto simples; sem símbolos de truncamento forçado | atributo | HTML <title>, adaptadores de busca e compartilhamento |
h1 | Substitui o cabeçalho principal visível quando o contexto o exige | string | Opcional | 20–80 caracteres | title | texto simples; um cabeçalho por página | atributo | template da página, esquema de acessibilidade |
description | Resume o valor e conquista o clique | string | Sim | 150–160 caracteres | Nenhum | uma frase específica | atributo | meta description, cards, fallback de pré-visualização de busca |
url / slug | Define a rota pública | string de caminho | Sim | uma rota única | derivada apenas por convenção aprovada | caminho minúsculo com barra inicial e final | atributo | roteador, sitemap, verificação de links internos |
image | Seleciona a imagem representativa | caminho ou URL absoluta | Condicional | um recurso existente | fallback do site se aprovado | URL resolvível; proporção de aspecto estável | atributo | cards sociais, listagens, imagem do schema |
imageAlt | Descreve a imagem informativa | string | Condicional com image | 5–160 caracteres | Nenhum | descrição objetiva; sem “imagem de” | atributo | texto alternativo da imagem renderizada, QA de acessibilidade |
date | Preserva o momento da primeira publicação | string datetime | Sim para páginas publicadas | um timestamp | Nenhum | AAAA-MM-DD HH:MM:SS | atributo | linha de assinatura, feeds, datePublished, auditorias |
updated | Registra a última alteração ou revisão substantiva | string datetime | Opcional | não anterior a date | omitido | mesma convenção de fuso horário do site que date | atributo | linha de assinatura, dateModified, auditorias de atualização |
author | Identifica o criador responsável | identificador(es) | Sim para páginas editoriais substantivas | 1+ pessoas registradas | Nenhum | identificador de perfil estável | atributo | linha de assinatura, junção Person, autor do Article |
reviewedBy | Identifica um revisor qualificado real | identificador(es) | Condicional por risco ou política | 1+ pessoas registradas | omitido | identificador de perfil estável | atributo | bloco de revisor, grafo de proveniência, QA |
keywords | Registra um conjunto compacto de consultas e terminologia | array de strings | Sim neste manual | 6–8 entradas únicas | [] | frases naturais; sem duplicatas | atributo | QA editorial, análise de busca, ferramentas internas |
taxonomy | Junta a página a coleções de tópicos controladas | array de strings ou tabela chaveada | Condicional | 1–5 valores por vocabulário controlado | [] | apenas slugs registrados | atributo | arquivos, filtros, breadcrumbs, recomendações |
canonical | Declara a URL preferida para cópias equivalentes | URL absoluta | Condicional; recomendado quando a derivação não é segura | exatamente 1 | self-URL derivada se a política permitir | URL absoluta HTTPS | atributo | link canônico, verificações de sitemap, URL da entidade principal do schema |
[[faq]] | Armazena perguntas de acompanhamento visíveis como registros estruturados | array de tabelas | Condicional | 4–8 itens úteis em páginas do manual | [] | cada item tem question e answer | array tipo corpo dentro do frontmatter | renderizador de FAQ visível, schema FAQPage, QA |
Referência por campo
Esta referência define o contrato de publicação para cada campo. “Obrigatório” significa que a validação deve interromper a publicação quando o campo ou sua derivação válida estiver ausente. “Condicional” significa que o requisito é ativado por um fato declarado, como uma imagem ser renderizada ou uma revisão independente ter ocorrido. Um padrão é seguro apenas quando produz o mesmo significado que um editor teria escolhido deliberadamente.
Identidade e roteamento
title, h1 e seoTitle
- Propósito —
titledá ao documento seu nome editorial durável.h1controla o cabeçalho principal na página quando o contexto do layout precisa de uma redação diferente.seoTitlecontrola o título do navegador/busca quando o padrão precisa de um qualificador conciso ou tratamento de marca. Separar esses campos evita que um rótulo de navegação, um cabeçalho de página e uma pré-visualização de busca sejam forçados em uma única string estranha. - Tipo e formato — Cada um é uma string de texto simples.
titleé o valor fonte; substituições ausentes devem recorrer a ele. HTML, Markdown, decoração com emojis e marcas de truncamento manual não são valores válidos. - Obrigatório? —
titleé obrigatório em toda página pública.h1eseoTitlesão opcionais e devem ser omitidos quandotitlefunciona em todos os três contextos. - Limites — Use 30–70 caracteres para
title, 20–80 parah1e 30–60 paraseoTitlecomo faixas editoriais, não promessas de que uma interface de busca exibirá todos os caracteres. Deve haver um H1 renderizado. - Quem ou o que consome — Templates de página, títulos do navegador, adaptadores de busca e redes sociais, cards de navegação, feeds,
headlinedo schema, esquemas de acessibilidade e listagens editoriais. - Regras — Todas as versões devem identificar o mesmo assunto, intenção e escopo. Uma diferença legítima resolve uma restrição de canal: por exemplo, o H1 pode dizer “Como Rotacionar uma Chave de API Sem Indisponibilidade”, enquanto o título SEO mais curto diz “Rotação de Chave de API: Guia Passo a Passo Seguro”. A seção posterior Título, H1 e título SEO explica o teste editorial.
- Erros comuns — Repetir uma palavra-chave nas três variantes, colocar um sufixo de marca no H1, mudar a promessa para perseguir cliques, incorporar o ano atual quando a página não é mantida anualmente, ou criar três valores meramente porque três campos existem.
slug e url
- Propósito — O slug é o segmento final do caminho;
urlé a rota pública relativa ao site que o contém. Juntos, eles dão à página um endereço estável para leitores, rastreadores, links, relatórios e migrações. A estabilidade é importante porque cada link conquistado e marcador salvo se torna dependente desse endereço. - Tipo e formato — Use uma string de caminho em minúsculo, separada por hífen, como
/academy/rotate-an-api-key/. Este repositório registra a rota completa emurl; um CMS que possui um camposlugseparado deve derivar o mesmo segmento final. - Obrigatório? — Uma rota única é obrigatória para toda página pública. Pode ser gerada apenas onde uma seção tem uma regra determinística aprovada e verificações de colisão; as páginas do manual usam seus valores de
urlregistrados. - Limites — Prefira um slug curto e legível que preserve o assunto distintivo, geralmente de três a oito palavras úteis. Remova pontuação e modificadores vazios. Remova palavras de paragem como “o” ou “um” apenas quando o resultado permanecer natural e inequívoco; não há limite arbitrário de caracteres que justifique danificar o significado.
- Quem ou o que consome — Roteamento Hugo, links internos, breadcrumbs, geração canônica, sitemaps, feeds, análises, redirecionamentos e referências externas.
- Regras — Trate um slug publicado como um compromisso permanente. Decida-o a partir do tópico durável, não de um título de campanha ou ano transitório. Quando o título muda mas o tópico e a intenção não, mantenha o slug antigo. Se a página realmente se mover, crie a nova rota, retenha a rota antiga em
aliases, atualize os links internos e teste o destino do redirecionamento. - Erros comuns — Regenerar o slug sempre que o título muda, incluir sinônimos no caminho, reter datas que fazem o conteúdo perene parecer obsoleto, usar maiúsculas/minúsculas misturadas ou underscores, criar duas URLs que diferem apenas por uma barra final e alterar uma rota sem preservar a antiga.
canonical
- Propósito — Um canonical identifica a URL preferida entre versões equivalentes ou quase equivalentes acessíveis. Ele consolida a identidade; não move um visitante nem desculpa duplicação descontrolada.
- Tipo e formato — Uma URL absoluta HTTPS, incluindo o host pretendido e o caminho normalizado:
https://amicited.com/academy/rotate-an-api-key/. O template pode derivar uma auto-referência do permalink da página quando o site tem um host e política de rota confiáveis. - Obrigatório? — Toda página indexável deve emitir um canonical. O campo em si é condicional quando um valor correto de auto-referência é derivado automaticamente; defina-o explicitamente para um canonical excepcional ou entre domínios aprovado.
- Limites — Exatamente um destino canônico. O destino deve retornar um documento indexável bem-sucedido, usar o protocolo e host preferidos e representar substancialmente o mesmo conteúdo.
- Quem ou o que consome — O HTML
<link rel="canonical">, motores de busca, verificações de sitemap e links internos, relatórios de desduplicação e identificadores de URL do schema. - Regras — Auto-referência por padrão. Use um canonical entre domínios apenas quando outro publisher possui o equivalente preferido e ambas as partes pretendem a consolidação. Use um redirecionamento, não um canonical, quando a URL antiga foi substituída e os usuários devem sempre cair na nova. Mantenha canonical, URL do sitemap, hreflang, links internos e identidade do schema alinhados.
- Erros comuns — Apontar toda página paginada ou localizada para um pai genérico, canonicalizar conteúdo distinto, direcionar uma página de redirecionamento ou erro, misturar HTTP e HTTPS, usar o campo como substituto para um alias e assumir que as diretivas canônicas são garantidamente obedecidas.
aliases
- Propósito —
aliasespreserva rotas que anteriormente identificavam a mesma página, para que uma mudança não transforme links existentes e marcadores em becos sem saída. Ele registra o histórico de rotas em vez de criar identidades indexáveis alternativas. - Tipo e formato — Um array TOML de caminhos relativos ao site, por exemplo
aliases = [ "/blog/old-api-key-guide/" ]. Cada valor inclui uma barra inicial e final e deve ser único em todo o site. - Obrigatório? — Opcional para uma página nova; obrigatório quando uma página publicada é movida de um caminho que o site controlava.
- Limites — Inclua toda rota conhecida de primeira parte anterior que ainda recebe links ou tráfego. Não adicione variantes especulativas de ortografia ou uma lista ilimitada de URLs de palavras-chave.
- Quem ou o que consome — A saída de alias do Hugo, processamento de redirecionamento de implantação quando configurado, QA de migração, monitores de link e usuários seguindo URLs antigas. Como o Hugo pode emitir uma página de alias em vez de um redirecionamento HTTP ao nível da origem, o comportamento da implantação deve ser verificado em vez de assumido.
- Regras — Uma página movida mantém seu caminho antigo funcionando. Cada alias deve resolver em um salto para a rota canônica atual. Atualize links internos para a nova URL mesmo quando o alias funciona e preserve o alias em edições posteriores, a menos que um sistema de redirecionamento documentado o substitua.
- Erros comuns — Excluir a página antiga sem um alias, encadear caminho antigo para caminho intermediário para caminho atual, tratar aliases como rotas de publicação duplicadas, apontar várias páginas não relacionadas para um destino conveniente ou assumir que a saída local do Hugo comprova o status HTTP de produção.
type e layout
- Propósito — Esses campos selecionam o contrato de renderização.
typecoloca uma página em uma classe de conteúdo com templates e comportamento compartilhados;layoutsolicita um template específico dentro dessa classe. A seleção correta garante que a página receba a navegação pretendida, slot de conteúdo, ativos e comportamento de schema. - Tipo e formato — Strings registradas em minúsculo. Esta página usa
type = "academy". Um valor delayouté um nome base de template comosingle, sem extensão de arquivo ou travessia de caminho. - Obrigatório? —
typeé obrigatório quando a localização do conteúdo não implica seguramente o tipo pretendido ou quando o contrato do manual o exige.layouté opcional e deve ser omitido quando o template padrão do tipo está correto. - Limites — Um valor para cada campo, escolhido apenas entre templates mantidos pelo site. Um novo valor é uma mudança de engenharia, não uma improvisação editorial.
- Quem ou o que consome — Ordem de busca do Hugo, templates, seleção de parciais, inclusão de CSS e JavaScript, adaptadores de schema e regras de validação.
- Regras — Escolha o tipo de postagem e o contrato de renderização antes de redigir. Use
layoutapenas para uma variante genuinamente suportada; não o use para compensar conteúdo que pertence a outrotype. Verifique se uma substituição existe e aceita a forma do frontmatter da página. - Erros comuns — Confundir a
entityeditorial com otypeHugo, nomear um arquivo de template que não existe, copiar um tipo de landing page em um documento academy, confiar na inferência de pasta durante uma migração e introduzir nomes de layout únicos que contornam melhorias compartilhadas.
Descoberta
description
- Propósito — A descrição ajuda um pesquisador qualificado ou destinatário de compartilhamento a decidir se esta página atende à necessidade. É cópia de pré-visualização, não uma introdução compactada e não um lugar para provar relevância através de repetição.
- Tipo e formato — Uma frase em texto simples. Deve nomear o termo principal naturalmente, declarar o valor concreto e adicionar escopo, público, método ou resultado útil.
- Obrigatório? — Obrigatório para toda página indexável neste manual.
- Limites — 150–160 caracteres, incluindo espaços. Esta é uma faixa de consistência editorial, não uma garantia de exibição: os motores de busca podem truncá-la ou reescrever o snippet a partir do conteúdo do corpo quando outra passagem se adequa melhor à consulta.
- Quem ou o que consome — Tags meta description, padrões de descrição Open Graph e Twitter, cards de listagem, feeds, pré-visualizações CMS, verificações de qualidade de busca e, às vezes,
descriptiondo schema. - Regras — Escreva para um clique do leitor certo. Torne a frase específica o suficiente para distinguir a página de outro resultado com um título semelhante. A seção Regras de descrição abaixo fornece a fundamentação e os testes de rejeição.
- Erros comuns — Duplicar o título, listar palavras-chave, começar com “Aprenda tudo sobre”, fazer uma afirmação não apoiada de melhor ou mais rápido, usar uma chamada para ação vaga, exceder a faixa devido a um sufixo de marca invisível ou assumir que o texto escrito deve aparecer literalmente nos resultados de busca.
keywords
- Propósito — Neste repositório,
keywordsregistra o conjunto compacto de consultas e terminologia usado para QA editorial, busca no corpus, análise de cobertura e ferramentas internas. Ajuda os editores a reconhecer a linguagem que uma página deve usar com precisão; não é uma promessa de incluir cada frase mecanicamente. - Tipo e formato — Um array de strings em linguagem natural, ordenadas do termo principal através de variantes significativas e terminologia intimamente relacionada.
- Obrigatório? — Obrigatório neste manual, incluindo páginas cujos templates públicos não renderizam os valores.
- Limites — Seis a oito entradas distintas. Cada entrada deve representar uma frase de consulta real ou termo necessário, não uma variação ao nível do token.
- Quem ou o que consome — Validadores editoriais, inventários de conteúdo, análise de busca e oportunidade, recuperação interna e ferramentas de migração. Os motores de busca públicos não usam este campo como sinal de ranking apenas porque ele existe.
- Regras — Mantenha o conjunto focado no escopo de uma página. Mescle maiúsculas/minúsculas, pontuação, singular/plural e duplicatas triviais de ordem de palavras. Use as frases para verificar cobertura e terminologia, nunca para ditar densidade não natural.
- Erros comuns — Tratar o campo como o mecanismo obsoleto de meta-keywords de ranking, adicionar dezenas de variantes, repetir o título como oito quase-duplicatas, inserir nomes de concorrentes que o corpo não discute e permitir que o array substitua a taxonomia adequada ou alvos de prompt.
targetPrompts
- Propósito —
targetPromptsregistra as perguntas ou solicitações completas que uma pessoa pode dar a um sistema de resposta de IA e para as quais esta página deve ser uma fonte útil. Os alvos de prompt preservam o contexto conversacional que frases curtas de palavras-chave omitem. - Tipo e formato — Um array de strings completas em linguagem natural, por exemplo
targetPrompts = [ "How do I rotate an API key without downtime?", "What should I check before revoking an old API key?" ]. Mantenha a redação como um usuário perguntaria, incluindo público, restrições ou comparação desejada. - Obrigatório? — Condicional para páginas incluídas no rastreamento de prompts ou em um programa de conteúdo de visibilidade de IA; opcional quando não existe um conjunto de prompts rastreado.
- Limites — Use um conjunto pequeno e intencional, normalmente um prompt principal e até quatro variantes significativas. Um prompt pode ser mais longo que uma palavra-chave porque seus qualificadores carregam intenção.
- Quem ou o que consome — Briefings de conteúdo, fluxos de trabalho de rastreamento de prompts, auditorias de recuperação e cobertura, monitoramento de respostas de IA e avaliação editorial. Não é renderizado como texto de busca oculto.
- Regras — Separe prompts por necessidade real de informação, não por pontuação. Uma palavra-chave como “rotação de chave de API” nomeia um tópico; “Como uma equipe SaaS pode rotacionar uma chave de API sem interromper integrações?” nomeia um público, tarefa e restrição. A página deve responder honestamente a cada prompt armazenado.
- Erros comuns — Copiar o array de keywords para este campo, fabricar dezenas de variações sintáticas, registrar prompts mais amplos que a página, usar prompts como cabeçalhos do corpo independentemente do fluxo de leitura e afirmar cobertura de prompt quando a resposta depende de informações que a página não fornece.
Confiança e proveniência
date e updated
- Propósito —
datepreserva quando a página foi publicada pela primeira vez;updatedinforma a última alteração substantiva ou revisão concluída. Dois campos preservam o histórico enquanto mostram se a informação na qual os leitores confiam mudou. - Tipo e formato — Strings de timestamp na convenção do site,
AAAA-MM-DD HH:MM:SS. Mantenha uma política de fuso horário em todo o corpus para que feeds e comparações permaneçam determinísticos. - Obrigatório? —
dateé obrigatório para páginas editoriais publicadas.updatedé opcional até que ocorra uma alteração qualificante, então obrigatório se a página apresentar uma data modificada. - Limites — Um valor cada.
updatednão pode precederdatenem estar no futuro. Uma correção feita minutos após a publicação ainda pode ser documentada, mas revisões rotineiras de rascunho antes da publicação não criam uma data atualizada. - Quem ou o que consome — Linhas de assinatura e selos de atualização visíveis, feeds, sitemaps,
datePublishededateModifieddo schema, auditorias de atualização, ordenação e filas editoriais. - Regras — Redefina
updatedpara uma correção factual, instrução alterada, evidência nova ou removida, escopo revisado, recomendação materialmente alterada ou uma revisão documentada de afirmações sensíveis ao tempo. Nunca redefina para pontuação, formatação, trabalho de template ou uma edição apenas de timestamp. Veja Datas, autores e revisores para a fundamentação da política. - Erros comuns — Sobrescrever a data original durante uma atualização, datar uma página no futuro para parecer nova, atualizar datas sem um diff de conteúdo, tratar uma implantação automatizada como uma atualização editorial e não registrar o que mudou no histórico de atualizações mantido.
author
- Propósito —
authorconecta o documento à entidade de pessoa responsável pelo seu trabalho. O link dá ao leitor e à máquina um caminho de uma página que faz afirmações para uma identidade mantida, especialização e outros trabalhos. - Tipo e formato — Um identificador de autor estável que resolve através do registro de autores do site para uma URL de perfil e registro Person. Por exemplo,
author = "maya-chen"é válido apenas se esse identificador resolver; um nome de exibição como"Maya Chen, SEO Expert"não é um substituto para o link de entidade. - Obrigatório? — Obrigatório para páginas editoriais substantivas. Páginas transacionais podem usar um proprietário organizacional governado apenas quando o template e a política suportam esse tipo de entidade.
- Limites — Um responsável principal por padrão; use um array de identificadores documentado apenas quando o schema e os templates de linha de assinatura suportam coautoria genuína.
- Quem ou o que consome — Linhas de assinatura visíveis, links de perfil do autor, schema Article, feeds, relatórios de propriedade editorial, fluxos de trabalho de revisão e grafos de entidade.
- Regras — Resolva o identificador antes da publicação. O perfil deve identificar a mesma pessoa mostrada na linha de assinatura e permanecer mantido. Credite a pessoa responsável pelo conteúdo, não a pessoa que meramente o carregou.
- Erros comuns — Inserir uma string de nome não vinculada, usar “Admin” ou uma equipe editorial inventada, atribuir um executivo proeminente que não escreveu o trabalho, permitir que um identificador resolva para nenhum perfil e mudar a autoria para implicar especialização que não esteve envolvida.
reviewedBy, reviewedAt e reviewScope
- Propósito — Estes campos registram uma revisão independente distinta da autoria.
reviewedByidentifica a entidade revisora;reviewedAtindica quando a revisão foi concluída;reviewScopediz o que o revisor verificou, para que o selo não implique aprovação além da evidência. - Tipo e formato —
reviewedByé um identificador estável que resolve para um perfil de pessoa mantido.reviewedAtusa o formato de timestamp do site.reviewScopeé uma declaração concisa em texto simples, como “Etapas de rotação de credenciais e avisos de segurança.” - Obrigatório? — Condicional quando a lei, política de risco, sensibilidade do assunto ou a especificação do tipo de postagem exigem revisão independente. Quando
reviewedByestá presente, a data e o escopo da revisão são obrigatórios como dados do registro de revisão, mesmo que um template específico os armazene em um registro editorial conectado em vez do frontmatter público. - Limites — Nomeie apenas revisores reais. O escopo deve ser específico o suficiente para revelar exclusões sem se tornar um relatório de revisão. Um revisor deve ter competência relevante e não deve simplesmente duplicar o papel do autor.
- Quem ou o que consome — Componentes de “revisado por”, junções de entidade de pessoa, auditorias de governança, portões de publicação de alto risco, proveniência estruturada e logs de atualização.
- Regras — Complete a revisão após o conteúdo estar estável, capture descobertas e resolução no histórico editorial e reavalie quando alterações posteriores afetarem o escopo revisado. Independente significa que o revisor testa o trabalho em vez de endossar seu próprio rascunho.
- Erros comuns — Tratar revisão de texto como revisão especializada, exibir um revisor sem data ou escopo, nomear alguém que nunca viu a versão final, deixar o selo após uma reescrita substancial não revisada e implicar aprovação legal, médica ou técnica fora do escopo declarado.
Mídia e redes sociais
image e imageAlt
- Propósito —
imageseleciona o hero representativo e o ativo social;imageAltfornece a alternativa textual funcional quando esse ativo é renderizado como conteúdo de página significativo. Manter o par junto evita que imagens de descoberta se tornem uma omissão de acessibilidade. - Tipo e formato —
imageé um caminho de site resolvível ou URL absoluta aprovada.imageAlté texto simples descrevendo a informação útil da imagem no contexto da página, não seu nome de arquivo ou palavra-chave alvo. - Obrigatório? — Condicional por tipo de postagem e template. Se a página requer um hero ou imagem social dedicada,
imageé obrigatório.imageAlté obrigatório sempre que essa imagem renderiza de forma informativa; uma renderização puramente decorativa deve usar um atributo alt vazio no template, não texto descritivo inventado. - Limites — Use um ativo representativo. Para compatibilidade social, forneça uma fonte de 1200 × 630 pixels na proporção de corte esperada, mantenha o conteúdo importante longe das bordas e mantenha
imageAltconciso — normalmente 5–160 caracteres. O arquivo deve existir antes de ser referenciado. - Quem ou o que consome — Componentes hero, cards de listagem, tags Open Graph e Twitter, campos de imagem do schema, feeds, pipelines de imagem, leitores de tela quando visível e QA de ativos.
- Regras — Escolha uma imagem que ainda comunique após um corte central e em tamanho de miniatura. Descreva sua função no contexto: “Configurações de chave de API com Rotate key destacado” é útil; “Chave de API” não é. Não coloque afirmações essenciais apenas dentro de pixels.
- Erros comuns — Referenciar um ativo planejado que não existe, usar um logotipo como imagem de todo artigo, incorporar texto pequeno que se torna ilegível em compartilhamentos, escrever “imagem de,” colocar palavras-chave no texto alternativo e assumir que o comportamento do texto alternativo social e da imagem visível são idênticos entre plataformas.
Campos Open Graph e Twitter card
- Propósito — Os metadados sociais controlam como uma URL é resumida quando compartilhada. Um título, descrição, URL, tipo e imagem consistentes ajudam os destinatários a reconhecer a página antes de clicar e reduzem a chance de uma plataforma selecionar um ativo irrelevante.
- Tipo e formato — Neste repositório, os templates derivam
og:titleetwitter:titledetitle, descrições dedescription, URLs do permalink,og:typedo contexto do layout e ambas as tags de imagem deimagecom um fallback do site.twitter:cardé emitido comosummary_large_image. Estas são tags geradas, não campos de frontmatter duplicados por padrão. - Obrigatório? — As tags de saída são obrigatórias em páginas públicas. Substituições separadas são opcionais e devem ser introduzidas apenas através de um contrato de template documentado; campos ad hoc não suportados como
ogTitlenão fazem nada. - Limites — Uma pré-visualização coerente por página e uma imagem representativa de 1200 × 630. Mantenha a redação derivada dentro das faixas de título e descrição e teste o comportamento real de corte e sobreposição nas principais superfícies de compartilhamento.
- Quem ou o que consome — Redes sociais, clientes de mensagens, expansores de links, extensões de navegador, ferramentas de colaboração e depuradores de pré-visualização de compartilhamento.
- Regras — Prefira derivação para que as afirmações de busca e sociais permaneçam alinhadas. Substitua apenas quando o contexto social genuinamente precisa de um enquadramento diferente e o template o suporta. Uma imagem errada custa reconhecimento e confiança: o destinatário pode ver uma interface obsoleta, outro produto, uma afirmação enganosa ou um corte que esconde o assunto.
- Erros comuns — Criar campos que nenhum template lê, permitir que um fallback global mascare um hero obrigatório ausente, usar uma imagem retrato ou minúscula para um card largo, alterar o texto social para fazer uma promessa mais forte que a página e validar apenas o código fonte HTML em vez de uma pré-visualização obtida.
Classificação
taxonomy, categories e tags
- Propósito — A classificação conecta uma página a coleções governadas de tópico, formato, público ou produto. Ela alimenta arquivos e filtros úteis apenas quando cada vocabulário tem um significado declarado; caso contrário, os rótulos tornam-se uma pilha de sinônimos não controlados.
- Tipo e formato — Arrays de slugs registrados em minúsculo. Use
taxonomypara o vocabulário de tópico controlado do repositório. Usecategoriesapenas para uma pequena hierarquia editorial mutuamente inteligível etagsapenas para um vocabulário transversal governado quando essas taxonomias estão configuradas. - Obrigatório? — Condicional ao tipo de postagem e design do arquivo. Páginas editoriais baseadas em tópico normalmente exigem um ou mais termos controlados; páginas utilitárias podem não exigir nenhum. Um campo não deve ser preenchido meramente porque um CMS o expõe.
- Limites — Para taxonomia geral, de um a cinco valores por vocabulário controlado. Cada termo precisa de uma definição, proprietário e regra de mesclagem. Crie um arquivo indexável apenas quando o termo representa demanda durável do leitor e o arquivo pode oferecer uma introdução única, inventário coerente, links internos e manutenção contínua.
- Quem ou o que consome — Páginas de arquivo, breadcrumbs, filtros, sistemas de conteúdo relacionado, navegação facetada, auditorias de conteúdo e segmentação de análises.
- Regras — Escolha o termo registrado mais restrito que agrupa a página com precisão. Mantenha singular/plural, abreviações e variantes ortográficas mapeadas para um valor canônico. Decida se os arquivos são indexáveis ao nível do vocabulário, não tag por tag após criação acidental.
- Erros comuns — Usar
seo,SEO,otimizacao-buscaeotimização de buscacomo valores separados, adicionar tags únicas para descrever cada substantivo, confundir um tipo de negócio com um tópico, gerar arquivos indexáveis com conteúdo fino e excluir termos sem migrar seus membros.
Chaves de junção do manual
- Propósito —
playbookPillar,playbookFamily,playbookWave,postTypes,elements,businessTypes,journeyStageeamicitedFeaturessão chaves de junção tipificadas. Elas permitem que uma página fonte apareça em bibliotecas e matrizes geradas sem que editores copiem cards manualmente. Esta página é o exemplo prático: seu pilar identifica um elemento, sua família agrupa orientações de metadados e seu arraypostTypesdeclara as especificações que a consomem. - Tipo e formato — Chaves singulares usam slugs registrados em minúsculo:
playbookPillareplaybookFamilysão strings,playbookWaveé um inteiro ejourneyStageé uma string controlada. Chaves de relacionamento —postTypes,elements,businessTypeseamicitedFeatures— são arrays de slugs registrados de seus respectivos registros. - Obrigatório? —
playbookPillareplaybookWavesão obrigatórios em registros do manual.playbookFamilyé obrigatório quando o pilar tem famílias governadas. As junções de array ejourneyStagesão condicionais: popule apenas relacionamentos que o contrato da página realmente suporta. - Limites — Um pilar, uma família dentro desse pilar, uma onda e um estágio de jornada, a menos que o modelo permita explicitamente múltiplos estágios. Arrays contêm chaves registradas únicas, não rótulos de exibição, prosa ou URLs.
- Quem ou o que consome — Listagens do hub do manual, matrizes entre pilares, filtros, cards de relacionamento, relatórios de completude, visualizações de onda e ferramentas internas que encontram capacidades relevantes do AmICited.
- Regras — Valide cada valor contra o registro canônico. A direção importa: uma página de tipo de postagem lista seus
elementsobrigatórios; uma página de elemento listapostTypesaplicáveis; uma página de tipo de negócio lista tipos de postagem úteis. Trate rótulos como apresentação e chaves como dados duráveis. Renomeie uma chave apenas através de uma migração que atualize cada lado da junção. - Erros comuns — Inventar quase-sinônimos, armazenar títulos em vez de slugs, misturar inteiros e strings para ondas, adicionar um relacionamento porque duas páginas se mencionam, permitir que arrays recíprocos se contradigam e criar marcação de listagem mantida manualmente que se desvia dos metadados.
Campos derivados e estruturais
schemaType
- Propósito —
schemaTypeseleciona o mapeamento de dados estruturados suportado mais específico que descreve com precisão a página visível. Ele diz ao adaptador de schema qual contrato de vocabulário aplicar; não transforma a página nessa coisa apenas por declaração. - Tipo e formato — Um nome de tipo Schema.org registrado, como
Article, selecionado entre os tipos que o adaptador do site suporta. Maiúsculas/minúsculas e ortografia devem corresponder ao registro. - Obrigatório? — Condicional. Defina-o onde múltiplos mapeamentos de schema são válidos para o mesmo tipo Hugo ou onde o contrato do tipo de postagem exige um tipo explícito. Caso contrário, deixe o template derivar seu padrão seguro.
- Limites — Um tipo de página principal, com entidades aninhadas criadas pelo adaptador a partir do conteúdo real. O tipo selecionado deve satisfazer todas as propriedades necessárias e corresponder ao que um leitor pode ver.
- Quem ou o que consome — Adaptadores JSON-LD, validação de rich results, QA de conteúdo e relatórios de inventário de schema.
- Regras — Escolha a partir da função da página e evidência visível, não do recurso de busca que um editor deseja. Uma página de instruções sem um procedimento visível completo não pode ganhar precisão definindo um tipo de instruções. Mantenha URLs do schema, datas, pessoas e imagens sincronizados com seus campos fonte.
- Erros comuns — Selecionar um tipo mais específico sem seu conteúdo exigido, emitir vários tipos primários conflitantes, copiar um valor de schema de um template não relacionado, assumir que sintaxe válida garante elegibilidade e colocar afirmações em JSON-LD que os leitores não podem inspecionar.
Tempo de leitura
- Propósito — O tempo de leitura dá ao leitor uma estimativa aproximada de esforço. É derivado do corpo final renderizável para que a estimativa mude quando a carga real de leitura muda.
- Tipo e formato — Um número inteiro computado de minutos produzido a partir da política de contagem de palavras do pipeline de conteúdo. Blocos de código, tabelas, legendas e mídia incorporada devem seguir uma regra de contagem documentada.
- Obrigatório? — A exibição é opcional por template. Um campo de frontmatter escrito não é permitido como fonte da verdade.
- Limites — Arredonde consistentemente e aplique um mínimo de exibição sensato, como um minuto. A suposição precisa de palavras por minuto importa menos do que usar o mesmo método em todo o site e rotular o resultado como uma estimativa.
- Quem ou o que consome — Cabeçalhos de página, cards, feeds, segmentação de análises e leitores decidindo se devem iniciar um guia longo.
- Regras — Calcule após shortcodes e regiões excluídas serem tratados de acordo com a política do site. Recompute a cada build. Se um vídeo ou tarefa interativa alterar materialmente o tempo de conclusão, rotule isso separadamente em vez de corromper o tempo de leitura.
- Erros comuns — Escrever
readingTime = 8, esquecer de atualizar após uma reescrita, apresentar falsa precisão, contar navegação e boilerplate e tratar um tutorial pesado em execução como oito minutos de leitura mais nenhum tempo de tarefa.
[[faq]]
- Propósito —
[[faq]]armazena pares de perguntas e respostas visíveis uma vez para que a página e quaisquer dados estruturados de FAQ elegíveis não possam se distanciar. - Tipo e formato — Um array TOML de tabelas; cada item contém uma
questionem texto simples e umaanswerstring autocontida. - Obrigatório? — Condicional quando restam perguntas de acompanhamento genuínas após a página principal. Nunca é obrigatório meramente para preencher um template ou buscar um recurso de busca.
- Limites — Normalmente quatro a oito itens úteis em páginas do manual. Cada pergunta aparece uma vez, e toda resposta deve ser completa sem depender da ordem do acordeão.
- Quem ou o que consome — Renderização de FAQ visível, schema FAQPage quando elegível, navegação da página, QA de conteúdo e extração de respostas.
- Regras — Este é um contrato de referência cruzada: siga Por que o FAQ vive no frontmatter e as orientações posteriores de FAQ em vez de manter cópias separadas visível e de schema. Armazene apenas perguntas que todo leitor pode acessar na página.
- Erros comuns — Respostas ocultas apenas para schema, cabeçalhos duplicados disfarçados de perguntas, respostas promocionais, afirmações não suportadas, JSON-LD desatualizado e tratar a elegibilidade de resultado de busca como garantida.
[[lnks]]
- Propósito —
[[lnks]]registra cada link interno governado usado no corpo, emparelhando sua âncora visível com um destino e descrição mantida. O registro torna os links inspecionáveis sem extrair HTML renderizado e suporta migração e QA. - Tipo e formato — Um array TOML de tabelas com
text,pathetitle.texté a âncora visível exata,pathé uma URL relativa ao site com barra inicial e final, etitleé a descrição da página de destino. - Obrigatório? — Obrigatório para cada link interno do corpo governado por esta convenção de conteúdo. Links profundos de aplicativos e fontes externas seguem seus próprios registros e não são disfarçados como entradas
[[lnks]]. - Limites — Um registro por ocorrência de link no corpo quando a mesma âncora pode apontar para destinos diferentes; caso contrário, registos duplicados exatos devem ser removidos. O destino deve existir ou estar no registro de slugs canônicos aprovado para o lançamento coordenado.
- Quem ou o que consome — Validação de links internos, migração de conteúdo, análise de relacionamentos, geração de título de link onde suportado e revisão editorial.
- Regras — Corresponda
textà âncora do corpo textualmente, incluindo capitalização e pontuação dentro do link. Use o caminho canônico relativo ao site. Escrevatitlecomo uma descrição precisa do destino, não como instruções para a página atual. Atualize o registro e o corpo juntos. - Erros comuns — Usar um valor de
textmais longo que a âncora real, inventar um slug não registrado, omitir uma barra final, registrar um caminho antigo que redireciona, descrever a fonte em vez do destino e deixar um registro após seu link no corpo ser removido.
Obrigatório versus opcional por tipo de postagem
A matriz aplica os contratos acima aos doze tipos de postagem atualmente declarados por este elemento. R significa obrigatório, C significa condicional sob as regras do campo, D significa saída obrigatória que pode ser derivada com segurança e O significa opcional. “Identidade” inclui entity, id, title, type e a rota estável. “Descoberta” inclui description e keywords; prompts alvo permanecem condicionais para cada linha. aliases é sempre condicional a uma mudança, enquanto o tempo de leitura escrito nunca é obrigatório.
| Tipo de postagem | Identidade | Descoberta | Canonical | Autor | Revisor | Imagem + alt | Taxonomia / junções | Tipo de schema | FAQ |
|---|---|---|---|---|---|---|---|---|---|
| Guia definitivo | R | R | D | R | C | R | R | R | C |
| Guia de instruções | R | R | D | R | C | R | R | R | C |
| Guia de listas | R | R | D | R | C | R | R | R | C |
| Comparação A-versus-B | R | R | D | R | C | R | R | R | C |
| Página de melhor-X-para-Y | R | R | D | R | R | R | R | R | C |
| Página de alternativas-para-X | R | R | D | R | R | R | R | R | C |
| Termo de glossário | R | R | D | R | C | C | R | R | C |
| Explicador o-que-é-X | R | R | D | R | C | R | R | R | C |
| Página de produto | R | R | D | R | C | R | R | R | C |
| Página de categoria | R | R | D | C | C | R | R | R | O |
| Página de caso de uso | R | R | D | R | C | R | R | R | C |
| Estudo de caso | R | R | D | R | C | R | R | R | C |
“Revisor condicional” não é permissão para pular a revisão onde a precisão ou o risco comercial a exige. Páginas de melhor-X e alternativas exigem revisão independente porque suas recomendações podem influenciar materialmente uma decisão e frequentemente mudam conforme produtos, preços e elegibilidade mudam. Para outras linhas, a política de risco, não o tempo disponível do editor, ativa o requisito. Da mesma forma, um canonical marcado como D ainda é obrigatório no HTML renderizado; apenas a entrada do frontmatter pode ser omitida quando o template pode gerar a auto-referência correta.
Validação do frontmatter
A validação deve rejeitar defeitos determinísticos automaticamente e reservar julgamento para questões que dependem de significado, evidência ou competência profissional. A divisão previne duas falhas opostas: pedir que revisores encontrem erros de sintaxe que um analisador pode detectar perfeitamente e fingir que uma regra de contagem de caracteres pode decidir se uma cópia é honesta.
| Verificação | Automatizável? | Regra de validação ou decisão humana |
|---|---|---|
| TOML e tipos de campo | Sim | Analisar um registro delimitado no primeiro byte; rejeitar chaves duplicadas, arrays inválidos, campos desconhecidos e valores com tipo primitivo incorreto. |
| Campos obrigatórios por tipo de postagem | Sim | Aplicar o esquema de tipo de postagem registrado e dependências condicionais, como exigir imageAlt com uma imagem informativa e metadados de revisão com reviewedBy. |
| Faixas de tamanho e contagem | Sim | Contar caracteres do título e descrição, entradas de palavras-chave e prompts, valores de taxonomia, itens de FAQ e strings vazias. Relatar faixas separadamente de erros de sintaxe rígidos onde uma exceção pode ser justificada. |
| Rotas, aliases e canonical | Principalmente | Detectar rotas duplicadas, caminhos malformados, colisões de alias, cadeias de redirecionamento, canônicos não HTTPS, incompatibilidades de host, fragmentos, destinos canônicos que falham e divergência com URLs de sitemap. Um humano aprova qualquer canonical intencional entre domínios. |
| Datas | Sim | Rejeitar formatos inválidos, timestamps futuros e valores de updated anteriores a date. Comparar uma alteração de data atualizada com um diff de conteúdo; exigir evidência editorial quando apenas metadados mudaram. |
| Entidades e junções registradas | Sim | Resolver identificadores de autor e revisor, valores de template, tipos de schema, termos de taxonomia e cada chave de junção do manual contra seus registros; detectar duplicatas e relacionamentos órfãos. |
| Ativos e saída social | Principalmente | Confirmar que o arquivo existe, o tipo MIME é suportado, as dimensões atendem ao contrato e as tags geradas usam URLs absolutas. Um humano verifica segurança do corte, legibilidade, relevância, direitos e se o texto alternativo explica a função da imagem. |
| Registros de links internos | Principalmente | Corresponder cada caminho de [[lnks]] e âncora exata contra o corpo, verificar o destino e sinalizar redirecionamentos. Um humano decide se a âncora é útil e se o link avança a tarefa do leitor. |
| Alinhamento de título, H1 e pré-visualização | Humano | Decidir se as variantes fazem a mesma promessa, se o termo principal é natural e se a descrição dá ao leitor pretendido uma razão honesta para clicar. |
| Verdade da autoria e revisão | Humano | Confirmar que as pessoas nomeadas fizeram o trabalho declarado, têm competência relevante, revisaram o escopo final, resolveram descobertas e são representadas sem credenciais infladas. |
| Qualidade da taxonomia e prompts | Humano | Decidir se os termos representam conceitos controlados duráveis, as variantes de prompt expressam necessidades distintas e um arquivo merece ser indexável em vez de meramente tecnicamente disponível. |
| Elegibilidade do schema e FAQ | Ambos | Validar a sintaxe JSON-LD e a correspondência de campos automaticamente; um humano confirma que a página satisfaz visivelmente o tipo selecionado e que as respostas do FAQ são genuínas, úteis e apoiadas. |
Execute verificações determinísticas antes da revisão editorial para que o revisor veja um registro coerente. Em seguida, revise o HTML renderizado, não apenas o frontmatter: um valor fonte válido ainda é um defeito de produção se o template selecionado o ignora, mapeia para a tag errada, esconde a proveniência necessária ou gera um canonical que discorda da rota pública. A publicação só está completa quando o comportamento da fonte, renderização e destino concordam.
O campo entity
entity responde “qual tipo exato de postagem este documento é uma instância?” Não responde “que tópico esta página discute?” Essa distinção é importante porque dois documentos podem abordar o mesmo tópico enquanto fazem trabalhos diferentes. Uma entrada de glossário define “diagnóstico”; um artigo de blog pode relatar uma mudança na orientação diagnóstica. Se ambos usarem entity = "diagnosis", os sistemas downstream não podem escolher de forma confiável o template correto, regras de validação, grupo de análise ou migração.
Use o prefixo de grupo mais o slug do tipo de postagem para variantes dentro de uma família: guide-how-to, guide-ultimate, comparison-a-vs-b e comparison-alternatives-to-x. Use o nome simples para um tipo autônomo: product-page ou case-study. Registre o identificador uma vez, mantenha-o estável e nunca o altere porque o tópico ou consulta alvo mudou. Coloque conceitos de tópico em taxonomy e linguagem de consulta em keywords.
Título, H1 e título SEO
Estes valores podem diferir por contexto, mas devem descrever a mesma página. title é o padrão durável. h1 é o cabeçalho visível e pode ser mais natural no contexto. seoTitle serve ao navegador e resultados de busca e pode adicionar um diferenciador conciso, ano legítimo ou sufixo de marca.
Por exemplo, title = "Rotação de Chave de API", h1 = "Como Rotacionar uma Chave de API Sem Indisponibilidade" e seoTitle = "Rotação de Chave de API: Guia Passo a Passo Seguro" alinham-se em uma tarefa. “Ferramenta de Segurança Gratuita” como título SEO seria enganoso porque muda a promessa. Não crie diferenças meramente para inserir mais palavras-chave.
Regras de descrição
A descrição existe para ajudar um leitor qualificado a decidir clicar. Mantenha-a entre 150–160 caracteres, inclua o termo principal naturalmente, declare o benefício concreto da página e adicione um qualificador significativo como público, escopo ou resultado. Escreva uma frase fluente, não uma lista de palavras-chave.
O termo confirma relevância; repetição não agrega valor. Não duplique o título, use “Aprenda tudo sobre,” faça superlativos não suportados ou termine no meio do pensamento. Os sistemas de busca ainda podem selecionar texto visível diferente para uma consulta.
Datas, autores e revisores
date preserva o timestamp da primeira publicação. updated registra a última alteração substantiva: uma correção factual, nova evidência, instruções alteradas, escopo revisado, recomendação alterada ou revisão completa que confirma afirmações sensíveis ao tempo. Registre o que mudou no histórico editorial quando a política o exigir.
Corrigir pontuação, alterar um estilo de botão, reconstruir um template ou tocar no timestamp sozinho não redefine updated. Avançar uma data sem trabalho por trás dela é uma violação de política porque diz a leitores e máquinas que o conteúdo foi atualizado quando não foi. É deturpação, não uma tática de crescimento.
Os campos de autor e revisor carregam identidades responsáveis para linhas de assinatura e dados estruturados. O autor é responsável pelo trabalho. Use reviewedBy apenas quando ocorreu uma revisão qualificada e vincule ambos os identificadores a perfis mantidos. A
página de fundamentos de confiança explica como autoria, datas, evidências e clareza de entidade apoiam a confiança sem garantir rankings.
Por que o FAQ vive no frontmatter
Um FAQ é conteúdo visível e uma coleção estruturada. Armazená-lo uma vez em [[faq]] permite que o template renderize o acordeão e o FAQPage JSON-LD idêntico, prevenindo schema oculto desatualizado.
Inclua perguntas de acompanhamento genuínas visíveis para todo leitor. Não duplique cabeçalhos, esconda promoções em respostas ou marque perguntas não exibidas. Marcação válida não garante um recurso de busca.
Sintaxe e exemplos de código
O contrato multiplataforma mapeia campos, não um componente visível. O seguinte envelope portátil é válido apenas em um arquivo de intercâmbio cujo importador reconhece diretivas de metadados:
:::frontmatter{entity="guide-how-to" id="reset-api-key" title="How to Reset an API Key"}
description: Reset an API key safely, replace it in dependent services, verify it, and revoke the exposed key without avoidable downtime.
author: maya-chen
:::
Deve ser normalizado para metadados de página nativos durante a importação. Não é válido no corpo de um artigo de produção. No Hugo, o mapeamento correto é TOML entre delimitadores +++ no primeiro byte, como mostrado no exemplar vivo. Não há deliberadamente um shortcode {{< frontmatter >}}: um shortcode executaria tarde demais e na região errada do documento.
No WordPress, mapeie os mesmos campos canônicos para campos de postagem registrados e post meta, por exemplo post_title, post_excerpt, post_name, _amicited_entity, _amicited_author e _amicited_reviewed_by. Um comentário como <!-- wp:amicited/frontmatter --> ou um shortcode [frontmatter] é inválido porque cria um bloco de corpo em vez de metadados de documento. Importadores e editores podem apresentar um painel de metadados, mas os valores armazenados devem permanecer anexados ao registro da postagem.
Exemplos
Bom: um registro coerente e responsável
entity = "guide-how-to"
id = "rotate-api-key"
title = "How to Rotate an API Key"
description = "Rotate an API key safely, update every dependent service, verify the replacement, and revoke the old credential without avoidable downtime."
url = "/academy/rotate-an-api-key/"
date = "2026-08-27 10:00:00"
updated = "2026-09-03 14:30:00"
author = "maya-chen"
reviewedBy = "alex-rivera"
keywords = [ "rotate API key", "API key rotation", "revoke API key", "credential security", "API security", "secret rotation" ]
taxonomy = [ "security", "account-administration" ]
canonical = "https://amicited.com/academy/rotate-an-api-key/"
Isso identifica uma variante de instruções, preserva o histórico, nomeia pessoas responsáveis e separa tópico da identidade da página. O timestamp atualizado é suportado por uma alteração documentada de instrução e revisão.
Ruim: o título repetido como descrição
title = "How to Rotate an API Key"
description = "How to Rotate an API Key"
A descrição não agrega benefício, escopo ou motivo para clicar. Também desperdiça o espaço de pré-visualização que poderia distinguir esta página de todo outro resultado usando o mesmo título.
Ruim: uma entidade reutilizada em dois tipos de postagem
# entrada de glossário
entity = "diagnosis"
# guia editorial
entity = "diagnosis"
O tópico compartilhado substituiu a identidade do tipo de postagem. Use valores registrados como glossary-term e guide-ultimate, depois atribua “diagnóstico” através de taxonomia ou palavras-chave.
Ruim: uma data atualizada sem diff de conteúdo
date = "2026-01-15 09:00:00"
updated = "2026-08-27 10:00:00" # apenas a data mudou
Nenhuma edição ou revisão substantiva suporta a afirmação de atualização. Mantenha updated inalterado ou omitido até que exista uma mudança real que possa ser inspecionada no histórico editorial.
Marcação de schema e acessibilidade
| Campo | Mapeamento HTML ou JSON-LD | Comportamento de acessibilidade |
|---|---|---|
title / seoTitle / h1 | <title>, <h1> visível, headline | O documento precisa de um cabeçalho principal descritivo; títulos do navegador e do cabeçalho não devem entrar em conflito |
description | meta description; description opcional do schema | Nenhum papel ARIA direto; o significado não deve existir apenas em metadados |
url, canonical, id | link canônico, url, @id estável | A canonização não deve quebrar a URL que um utilizador de teclado ou leitor de ecrã alcança |
image, imageAlt | imagem social, image; alt na imagem visível | Imagens visíveis informativas exigem texto alternativo útil; imagens decorativas usam alt vazio no momento da renderização |
date, updated | <time> visível, datePublished, dateModified | Renderizar datetime legível por máquina e um rótulo visível compreensível |
author, reviewedBy | links de linha de assinatura, author e proveniência de revisão usando registros Person identificados | Nomes e links de perfil devem ser legíveis e acessíveis por teclado; não depende de avatares |
[[faq]] | perguntas e respostas visíveis; FAQPage com Question e acceptedAnswer | Controles de acordeão precisam de botões nativos, nomes acessíveis, estados de foco e aria-expanded; as respostas permanecem acessíveis sem scripts |
Metadados fornecem valores; o template permanece responsável pelo HTML semântico, foco, contraste, propósito do link e texto alternativo.
Regras de escrita
- Mantenha identificadores estáveis, em minúsculo e seguros para máquinas. Nunca recicle um
idou altere silenciosamenteentityapós a publicação. - Use texto simples em campos tipo título. HTML, links Markdown, decoração com emojis e quebras de linha forçadas não pertencem a strings de metadados.
- Mantenha a descrição entre 150–160 caracteres e arrays de palavras-chave entre seis e oito frases distintas para este manual.
- Use pessoas reais registradas para campos de autor e revisor. Nunca crie um revisor cerimonial ou identidade genérica de “Equipe Editorial” a menos que seja uma entidade responsável mantida.
- Use uma taxonomia controlada. Variantes ortográficas e duplicatas singular/plural criam arquivos fragmentados.
- Referencie apenas imagens que existem e têm direitos de publicação.
imageAltdescreve o conteúdo informativo da imagem, não seu alvo de SEO. - Mantenha as respostas do FAQ diretas e autocontidas. As afirmações ainda exigem a mesma evidência e divulgação que a prosa em outros lugares da página.
- Nunca coloque segredos, notas privadas, tokens de acesso, instruções de embargo, dados pessoais ou afirmações legais não revisadas em frontmatter publicável.
Quais tipos de postagem usam frontmatter e onde
Todo tipo de postagem usa frontmatter no primeiro byte. A profundidade exigida muda com risco, intenção e schema, não com design visual.
| Tipo de postagem | Ênfase obrigatória |
|---|---|
| guia definitivo | Identidade, autor, datas, taxonomia ampla, imagem e revisão quando justificada |
| guia de instruções | Entidade de instruções, autor, data de atualização testada, descrição focada na tarefa e FAQ útil |
| guia de listas | Tópico de seleção, propriedade, datas, imagem e taxonomia |
| comparação A-versus-B | Variante de comparação, par nomeado, autor, data verificada e revisão consequente |
| página de melhor-X-para-Y | Variante de classificação, taxonomia de público, autor, data de reavaliação e pré-visualização honesta |
| página de alternativas-para-X | Variante de alternativas, assunto, autor, data de revisão da lista restrita e URL canônica |
| termo de glossário | Identidade de glossário, URL durável, pré-visualização orientada à definição e responsabilidade do editor |
| explicador o-que-é-X | Identidade de explicador distinta do glossário, autor, escopo, taxonomia e FAQ |
| página de produto | Identidade do produto, URL canônica, imagem atual, propriedade e histórico de atualizações |
| página de categoria | Identidade da categoria, taxonomia controlada, URL estável, título e imagem atual |
| página de caso de uso | Identidade do caso de uso, taxonomia de público e problema, proprietário, URL e descrição precisa |
| estudo de caso | Identidade do estudo de caso, participantes, autor, data, revisor condicional, imagem e URL |
Lista de verificação de QA
- O arquivo começa com
+++, contém TOML válido e fecha o registro antes do conteúdo do corpo? entityé um identificador de tipo de postagem exato registrado em vez do tópico, campanha ou nome do site?idé único e estável, eurlcorresponde ao registro de slugs canônicos?title,h1opcional eseoTitleopcional descrevem a mesma página sem alterações enganosas de escopo?- A descrição tem 150–160 caracteres, contém o termo principal naturalmente e oferece uma razão concreta para clicar?
- Toda imagem referenciada existe, e
imageAlté preciso para a imagem que renderiza? - A data de publicação está preservada, e todo valor de
updatedé suportado por um diff substantivo ou revisão documentada? - Os identificadores de autor e revisor resolvem para perfis reais mantidos, e o revisor nomeado realmente revisou o trabalho?
- As palavras-chave estão limitadas a seis a oito frases úteis e os valores de taxonomia são extraídos de vocabulários controlados?
- O canonical usa HTTPS, resolve para a página preferida e concorda com o sitemap e links internos?
- Cada item de
[[faq]]contém uma pergunta útil e resposta autocontida que renderizam visivelmente com redação idêntica? - O JSON-LD gerado corresponde ao conteúdo visível, usa identificadores estáveis e passa na validação de sintaxe sem reivindicar tipos não suportados?
- Segredos, notas editoriais privadas, afirmações não suportadas e divulgações apenas no corpo estão ausentes do registro?
FAQ
O frontmatter é visível na página publicada?
O registro fonte está oculto, mas os templates podem renderizar o título, pessoas, datas e FAQ. Outros campos alimentam pré-visualizações, tags canônicas, feeds, sitemaps, schema e sistemas internos.
O campo de entidade deve conter o tópico ou o tipo de postagem?
Ele identifica o tipo exato de postagem. Tópicos compartilhados pertencem à taxonomia e palavras-chave, não no lugar da identidade do documento.
O título, H1 e título SEO podem ser diferentes?
Sim. O H1 pode ser mais natural e o título SEO pode adicionar um diferenciador, mas todas as versões devem fazer a mesma promessa.
Quando a data de atualização deve mudar?
Altere após uma revisão ou edição factual substantiva. Não altere por pontuação, estilo, trabalho de template ou uma atualização apenas de data.
Por que as perguntas de FAQ são armazenadas no frontmatter?
O array estruturado permite que uma única fonte renderize tanto o FAQ visível quanto o FAQPage JSON-LD correspondente. Isso evita que o schema se distancie do que os leitores podem inspecionar.
Perguntas frequentes
O registro fonte não é exibido como um bloco, mas os templates podem renderizar valores selecionados como título, autor, revisor, data de publicação, data de atualização e FAQ. As pré-visualizações de busca, tags canônicas, dados estruturados, feeds, sitemaps e sistemas internos podem consumir campos sem exibir o registro completo.
Deve identificar o tipo exato de postagem, não apenas o tópico. Use um prefixo de grupo mais o slug do tipo de postagem para variantes dentro de uma família, e o nome simples do tipo de postagem para um tipo autônomo. A classificação do tópico pertence à taxonomia e às palavras-chave.
Sim, quando cada diferença tem um propósito. O H1 pode ser ligeiramente mais claro no contexto da página, enquanto o título SEO pode adicionar uma marca ou um qualificador que incentiva o clique. Todos devem continuar nomeando a mesma página e não podem implicar escopos diferentes.
Altere-a apenas após uma revisão ou edição substantiva que melhore a precisão factual, escopo, instruções, evidências, recomendações ou outras informações nas quais o leitor confia. Limpeza tipográfica, alterações de template e edições apenas de data não justificam uma nova data de atualização.
Um array estruturado dá a cada pergunta e resposta um campo estável, permite que o template renderize o acordeão visível e permite que o adaptador de schema emita entidades FAQPage correspondentes a partir da mesma fonte. Isso evita que o texto visível do FAQ e o JSON-LD se distanciem.
Mais tutoriais nesta seção
Pronto para colocar em prática?
Verificação gratuita · Teste de 7 dias · cartão de crédito necessário