SEO
O Docsbook cria para você a metade legível por máquinas da sua documentação. Cada página
que ele hospeda é um HTML renderizado no servidor que contém um <title> resolvido, uma
descrição meta limpa, uma URL canônica, um conjunto de hreflang que contém apenas os
idiomas para os quais você realmente traduziu, cartões OpenGraph e X com uma imagem gerada, um
grafo JSON-LD e uma entrada em um sitemap para a qual robots.txt aponta. Você escreve em Markdown; o
cabeçalho é uma consequência.
Esta seção aborda os resultados de pesquisa — o que o Google e o Bing rastreiam, indexam e classificam. Dois vizinhos abrangem as outras superfícies de máquina e não se sobrepõem a ela: AEO é a caixa de resposta acima dos resultados, e GEO é ser citado por um assistente de IA em vez de ser classificado.
O que isso lhe custa#
Três coisas, e uma delas não é opcional.
- Ative a opção de SEO. No painel de administração, Configurações ▸ SEO & GEO, a
SEOalternância. Ela fica desativada em um projeto novo e, enquanto está desativada, todas as páginas são servidasnoindex, nofollow— a marcação é toda gerada, e tudo nela diz "não me indexe". Esse é o motivo mais comum para um site Docsbook não aparecer no Google. É gratuito em todos os planos. - Escreva um
# H1claro e um parágrafo de abertura que responda à pergunta da página. Eles se tornam o título e a descrição, a menos que você os substitua. - Nada mais. URLs canônicas, o mapa do site,
robots.txt, cards, JSON-LD e o agrupamento de idiomas são gerenciados, e não há uma superfície de configuração para eles.
Para substituir a linha gerada em uma página, coloque-a no frontmatter:
---
title: "Configure a webhook"
description: "Register a Docsbook webhook, choose its events, and verify the first delivery."
---Para manter uma página fora do índice enquanto ela continua publicada e legível:
---
noindex: true
---robots: noindex, noindex: yes e noindex: 1 também são aceitos. Use-os em páginas
que consomem orçamento de rastreamento sem jamais gerar um clique — um changelog de 90.000 caracteres,
anotações internas de trabalho, um espaço reservado inacabado. A opção para todo o site é o instrumento errado para isso:
desativá-la oculta tudo.
Os sinais e onde cada um é decidido#
| Sinal | O que o Docsbook faz | Onde |
|---|---|---|
<title> |
Frontmatter title → corpo H1 → nome do arquivo; nome do workspace anexado exatamente uma vez |
Como funciona |
<meta description> |
Frontmatter description → parágrafos iniciais, sem marcação, com 160 caracteres |
Como funciona |
| URL canônica | Domínio personalizado → caminho do produto → caminho curto do domínio apex → subdomínio do proprietário; nunca uma URL que redireciona | Como funciona |
hreflang |
Apenas os locales para os quais esta página foi realmente traduzida, além de x-default |
Como funciona |
| Cartão OpenGraph / X | summary_large_image com uma imagem 1200×630 gerada para cada página |
Como funciona |
| Diretivas de robots | Visualização → alternância do site → página noindex, nessa ordem de precedência |
Como funciona |
sitemap.xml |
Cada página e traduções reais, lastmod do commit de origem |
Como funciona |
| JSON-LD | Organization + TechArticle + BreadcrumbList em cada página |
Como funciona |
| Descoberta e novo rastreamento | Sitemap, robots.txt, envio do IndexNow, temporizadores de cache |
Indexação |
| Posições no Google | Dados do Search Console lidos no painel administrativo, gratuito em todos os planos | Indexação |
Por que esta é a maneira certa (evidências)#
| O que o Docsbook faz | Por que funciona no rastreador | Fonte |
|---|---|---|
| Fornece HTML completo renderizado no servidor | O Google renderiza JavaScript em uma fila na qual uma página "pode permanecer… por alguns segundos, mas isso pode levar mais tempo", e "nem todos os bots podem executar JavaScript" | Noções básicas de SEO para JavaScript |
| Dá a cada página seu próprio título e descrição | As fontes dos links de título do Google começam com "Conteúdo em elementos <title>"; e "descrições idênticas ou semelhantes em todas as páginas de um site não são úteis" |
Links de título, Snippets |
| Aponta o canonical para a URL que responde com 200 | rel="canonical" é "um sinal forte de que a URL especificada deve se tornar a canonical" — um sinal que o Google só pode seguir se o destino for resolvido |
Consolidar URLs duplicadas |
Lista apenas traduções reais em hreflang |
"Se a página X tiver um link para a página Y, a página Y deverá ter um link de volta para a página X. Se esse não for o caso… essas anotações poderão ser ignoradas" | Versões localizadas |
Usa datas reais de commit para lastmod |
O Google usa <lastmod> "se ele for consistente, verificável… e preciso" |
Criar um sitemap |
Emite FAQPage / HowTo somente quando a página tem esse conteúdo |
"não adicione dados estruturados sobre informações que não estejam visíveis para o usuário, mesmo que as informações sejam precisas" | Introdução aos dados estruturados |
| Renderiza a barra lateral como links HTML em todas as páginas | O orçamento de rastreamento é gasto no que está acessível; "se muitas dessas URLs forem duplicadas… isso desperdiçará muito tempo de rastreamento do Google no seu site" | Orçamento de rastreamento |
| Fornece um 308 quando uma página é movida | Um redirecionamento temporário deixaria a URL inativa como a canonical | Consolidar URLs duplicadas |
O que o Docsbook não afirmará#
- Nada disso faz uma página obter uma classificação. Todos os mecanismos acima tornam uma página rastreável, inequívoca e apresentada corretamente. O FAQ sobre experiência da página do Google responde à pergunta "Existe um único 'sinal de experiência da página'…?" com "Não existe um único sinal", e responde sobre quanto a experiência da página importa para a classificação com "A Pesquisa Google sempre busca mostrar o conteúdo mais relevante, mesmo que a experiência da página seja inferior" (Experiência da página). A marcação é o ponto de partida, não a alavanca.
- Os dados estruturados são documentados como um sinal de elegibilidade, não de classificação. A própria introdução do Google fala sobre resultados avançados e não diz nada sobre classificação.
priorityechangefreqno sitemap não fazem nada pelo Google. "O Google ignora os valores<priority>e<changefreq>." O Docsbook os gera para os mecanismos que de fato os leem.- O orçamento de rastreamento provavelmente não é o seu problema. O guia de orçamento de rastreamento do Google é
destinado a "Sites grandes (1 milhão ou mais de páginas exclusivas) com conteúdo que muda
com frequência moderada (uma vez por semana)" e "Sites médios ou maiores (10.000 ou mais páginas exclusivas)
com conteúdo que muda muito rapidamente (diariamente)" — e afirma, na mesma frase,
que estes "são uma estimativa aproximada para ajudar você a classificar seu site. Estes não são
limites exatos."
noindexem um changelog enorme ainda vale a pena; tratar um site de documentação com 60 páginas como uma emergência de orçamento de rastreamento não vale. - Nenhum multiplicador. O tráfego depende do seu tópico, da sua concorrência e do seu domínio. Qualquer plataforma que cite uma porcentagem está citando o site de outra pessoa.
Limites#
- A configuração em todo o site vem desativada por padrão e se aplica a todo o workspace. Não há um controle para “indexar esta seção, mas não aquela” acima da flag
noindexpor página. - Em um domínio personalizado, a configuração de SEO e
noindexpor página não são respeitadas — as páginas são servidasindex, followincondicionalmente — e não há clusterhreflang, nemBreadcrumbList, nem sitemap, nem redirecionamento de página movida e nenhum dos sinais de nível de página de GEO. A URL canônica, o título, a descrição, os cards e o nóTechArticleestão todos corretos nesse caso. Consulte Como funciona. - As posições do Search Console abrangem apenas hosts hospedados pelo Docsbook. Um site em seu próprio domínio está fora da propriedade que o Docsbook lê. Consulte Indexação.
- Uma renomeação fora do Docsbook não deixa nenhum redirecionamento. As mudanças feitas pelo Docsbook
criam um automaticamente; uma
git mvnão.
Lista de verificação#
- A alternância
SEOestá ativada em Configurações ▸ SEO & GEO. - Cada página tem um
# H1claro ou umtitleno frontmatter. - O parágrafo inicial responde à pergunta da página em uma ou duas frases.
- Todas as páginas podem ser acessadas pela barra lateral; não há páginas órfãs.
- As páginas que nunca devem ser classificadas têm
noindex: true. - Para documentação multilíngue, as traduções estão ativadas para que cada idioma tenha sua própria URL indexável.
Relacionados#
- Como o Docsbook cria o cabeçalho de uma página — as ordens de resolução.
- Indexação — descoberta, novo rastreamento e Search Console.
- AEO — mecanismos de resposta e resultados avançados
- GEO — citações por assistentes de IA
- llms.txt
- Traduções por IA
- Opções de pesquisa — a pesquisa no site que os leitores usam quando chegam.