Otimização de SEO

Otimize sua documentação para mecanismos de pesquisa e prévias sociais definindo títulos, descrições e metadados no frontmatter.

O que o Jamdesk faz automaticamente

Otimizando seu conteúdo

Escreva um frontmatter eficaz

---
title: User Authentication    # Under 60 characters
description: Set up OAuth, JWT, and session-based authentication  # 120-160 characters
---

Títulos das páginas

• Mantenha menos de 60 caracteres para evitar truncamento nos resultados de pesquisa
• Inclua sua palavra-chave principal próximo ao início
• Torne cada título exclusivo em toda a documentação

Descrições

• Procure usar de 120 a 160 caracteres
• Resuma o que o leitor aprenderá
• Inclua palavras-chave relevantes naturalmente

Controlando a indexação

Configurações para todo o site

No seu docs.json, configure o comportamento padrão dos robôs:

{
  "seo": {
    "metatags": {
      "robots": "index, follow"
    }
  }
}

Controle por página

Substitua a indexação de páginas específicas no frontmatter:

---
title: Internal Notes
noindex: true
---

Use noindex para:

• Páginas em rascunho ou em desenvolvimento
• Documentação interna
• Conteúdo obsoleto que você mantém como referência

Indexação de pesquisa versus ingestão por IA

Os metadados robots e noindex controlam os mecanismos de pesquisa: se uma página aparece no Google e no seu sitemap.xml. Eles não afetam os arquivos llms.txt e llms-full.txt que as ferramentas de IA leem. Para interromper a publicação desses arquivos, defina seo.ai.llmsTxt como false (consulte Desativando llms.txt). Os dois controles são independentes: uma página pode ser indexada pelos mecanismos de pesquisa, mas excluída da ingestão por IA, ou o contrário.

URLs canônicas

Se sua documentação estiver acessível por várias URLs, defina uma URL canônica:

---
title: Getting Started
canonical: https://docs.example.com/getting-started
---

Você também pode definir uma base canônica para todo o site em docs.json. O Jamdesk acrescenta o caminho de cada página a ela, para que todas as páginas recebam uma URL canônica correta:

{
  "seo": {
    "metatags": {
      "canonical": "https://docs.acme.com"
    }
  }
}

Prévias sociais e Open Graph

O Jamdesk gera automaticamente um card social de 1200×630 com a identidade visual para cada página. Substitua qualquer tag social no frontmatter. Você pode usar chaves simples no nível superior ou um bloco seo: aninhado. Ambos funcionam e, quando a mesma chave é definida das duas formas, o valor no nível superior tem prioridade.

---
title: API Reference
description: REST API endpoints and authentication
"og:title": API Reference — Acme
"og:description": Everything you need to call the Acme API
"og:image": /images/api-social-card.png
"twitter:card": summary_large_image
"twitter:creator": "@acme"
keywords: ["api", "rest", "authentication"]
canonical: https://docs.acme.com/api-reference
---

---
title: API Reference
description: REST API endpoints and authentication
seo:
  "og:title": API Reference — Acme
  "og:image": /images/api-social-card.png
  "twitter:card": summary_large_image
  x-custom-tag: any custom meta value
---

Tags compatíveis

Tipo de card do Twitter / X

A tag twitter:card controla qual layout o X (e outras plataformas) usa quando seu link é compartilhado:

Para um card de 1200×630 com a identidade visual, use summary_large_image para que a imagem seja renderizada em toda a largura.

Imagem padrão para todo o site

Defina uma imagem social de fallback para todas as páginas em docs.json. Qualquer página que defina sua própria og:image a substitui:

{
  "seo": {
    "metatags": {
      "og:image": "https://docs.acme.com/images/default-card.png"
    }
  }
}

Sitemap e Robots.txt

Todo site Jamdesk gera sitemap.xml e robots.txt automaticamente a cada build.

Onde encontrá-los

As URLs dependem de a documentação estar em um domínio raiz ou sob um subcaminho /docs:

https://docs.acme.com/sitemap.xml
https://docs.acme.com/robots.txt

O que está incluído no sitemap

• Todas as páginas publicadas (exceto as que têm frontmatter noindex ou hidden)
• Datas da última modificação do frontmatter, quando disponíveis
• Frequência semanal de alterações

Excluindo páginas do sitemap

Adicione noindex ao frontmatter para excluir uma página do sitemap e dos mecanismos de pesquisa:

---
title: Internal Notes
noindex: true
---

Páginas com hidden: true também são excluídas automaticamente.

Dados estruturados JSON-LD

Todas as páginas incluem automaticamente dados estruturados schema.org como uma tag <script type="application/ld+json"> com dois schemas:

• WebSite: nome, URL e descrição do seu site (de docs.json).
• BreadcrumbList: caminho de navegação da página inicial até a página atual, derivado da configuração navigation.

Nenhuma configuração é necessária. Os mecanismos de pesquisa usam esses dados para resultados avançados, como trilhas de navegação nas listagens de pesquisa.

IndexNow

Após cada build, o Jamdesk envia automaticamente as URLs de páginas alteradas ao IndexNow para acelerar a indexação pelos mecanismos de pesquisa. Isso notifica o Bing, o Yandex e outros mecanismos de pesquisa participantes sobre as alterações no seu conteúdo, sem esperar pelo próximo ciclo de rastreamento.

• É executado após cada build bem-sucedido
• Envia somente páginas que realmente foram alteradas
• Não bloqueia o processo, portanto nunca atrasa seu build
• Nenhuma configuração é necessária

Práticas recomendadas

Siga esta checklist antes de publicar:

Artigos relacionados