Jamdesk Documentation logo

Pontuação de IA

A Jamdesk avalia, a cada build, se agentes de IA leem sua documentação segundo o padrão aberto AFDocs, com nota, problemas e evolução ao longo do tempo.

Assistentes de IA respondem a perguntas sobre seu produto com base na sua documentação. Eles só conseguem fazer isso quando podem lê-la. A Pontuação de IA mede o quanto conseguem. Após cada build, a Jamdesk verifica seu site publicado segundo o padrão aberto AFDocs de prontidão para agentes. Você recebe uma pontuação de 0 a 100, uma nota por letra e uma análise detalhada de cada problema.

As capturas de tela mostram a interface em inglês.

Experimente primeiro em qualquer site. A ferramenta AI Score, gratuita, avalia qualquer URL de documentação segundo o mesmo padrão. A extensão AI Score para Chrome avalia sites enquanto você navega. Na Jamdesk, a pontuação é calculada automaticamente para sua documentação.

Como a pontuação funciona

A Pontuação de IA é calculada automaticamente, sem configuração. A Jamdesk aguarda a publicação de cada build bem-sucedido. Em seguida, verifica sua documentação publicada e registra o resultado.

  • Executada em cada build: cada implantação recalcula a pontuação do site. Uma regressão aparece assim que é publicada.
  • Pontuação de 0 a 100 e nota por letra (de A+ a F), medidas segundo o padrão aberto AFDocs. O mecanismo é o mesmo da ferramenta pública gratuita.
  • Execute novamente quando quiser: abra a página AI Score do projeto e clique em Run score now. A pontuação do site publicado é recalculada sem esperar por um build.

Encontre a opção no dashboard, em seu projeto → AI Score.

Leia sua pontuação

O dashboard do AI Score mostra um indicador circular com pontuação 94 e nota A, uma linha de tendência ao longo de seis builds e cartões de categoria expansíveis; um deles mostra uma verificação reprovada e o botão Copy prompt to fix

A página AI Score tem três partes:

  • Indicador circular da pontuação: sua pontuação e nota atuais, além da mudança desde o último build.
  • Linha de tendência: sua pontuação nos builds recentes. Uma queda fica evidente rapidamente.
  • Cartões de categoria: suas verificações agrupadas em sete áreas, cada uma com uma nota. Expanda uma categoria para ver as verificações e saber se foram aprovadas, geraram um aviso ou falharam.

O rodapé informa o que foi verificado, quantas páginas foram amostradas e a versão da especificação AFDocs.

O que a pontuação mede

Cada categoria reúne verificações relacionadas à prontidão para agentes:

CategoriaO que abrange
Descoberta de conteúdollms.txt e os sinais que direcionam agentes ao seu conteúdo
Disponibilidade de MarkdownUma versão limpa em Markdown de cada página para os agentes lerem
Tamanho da página e risco de truncamentoPáginas pequenas o suficiente para caber na janela de contexto de um agente
Estrutura do conteúdoTítulos, ordenação e conteúdo que começa no início da página
Estabilidade de URL e redirecionamentosURLs estáveis e redirecionamentos corretos no mesmo host
Observabilidade e integridade do conteúdoCódigos de status, cache e paridade entre o que leitores e agentes veem
Autenticação e acessoSe os agentes conseguem acessar as páginas

Corrija os problemas

Cada verificação que gera um aviso ou falha tem uma explicação em linguagem simples. As instruções de correção se referem ao seu MDX e ao docs.json. Os resultados são de dois tipos:

  • Itens que você corrige no conteúdo: por exemplo, uma página cujo conteúdo começa muito abaixo, uma página grande demais que precisa ser dividida ou conteúdo exibido por um componente interativo que não aparece no Markdown da página. As instruções indicam a próxima etapa e as páginas às quais ela se aplica.
  • Itens tratados pela Jamdesk: a Jamdesk gera llms.txt, a exportação em Markdown, os códigos de status e o cache. Uma falha nessa área geralmente indica um problema temporário no build. Execute a pontuação novamente após o próximo build. Entre em contato com o suporte se o problema persistir.

Copie o prompt de correção

Cada verificação que pode ser corrigida tem o botão Copy prompt to fix. Ele copia uma instrução que identifica a verificação, o resultado e a correção no seu MDX ou docs.json. Cole-a em um agente de programação com IA (Claude Code, o plugin Claude da Jamdesk, Cursor ou Codex) para fazer a edição. Envie as alterações para iniciar um novo build e recalcular a pontuação.

Receba um e-mail quando sua pontuação mudar

A Jamdesk envia aos membros do projeto um e-mail com a nova pontuação e o problema mais importante a corrigir. O e-mail é enviado quando um build gera sua primeira pontuação, altera sua pontuação em 3 pontos ou mais, ou faz com que ela volte a 100.

  • Ative ou desative por projeto: a opção Email team when score changes fica no topo da página AI Score. Ela vem ativada por padrão.
  • Pequenas mudanças não geram e-mails: uma alteração de um ou dois pontos não envia um e-mail. A Jamdesk compara cada nova pontuação com a última sobre a qual enviou um e-mail. As mudanças graduais se acumulam. Você recebe um e-mail quando a variação total chega a 3 pontos.

Execuções manuais e pontuações acionadas por builds podem enviar o e-mail. Verificações retroativas e feitas pela ferramenta pública nunca enviam.

Solução de problemas

Uma verificação não retorna resultados quando seu site fica temporariamente inacessível, retorna um erro ou bloqueia o verificador. A Jamdesk não salva esses resultados. Uma falha temporária não fixa uma pontuação incorreta nem prejudica sua linha de tendência. Sua última pontuação válida continua na página. Clique em Run score now para tentar novamente.

Agentes de IA não conseguem ler páginas protegidas por senha. A pontuação reflete isso. É esperado que a pontuação seja baixa quando essa restrição é intencional, como no caso de documentação interna ou pré-lançamento.

Um projeto noindex não tem sitemap para a Jamdesk verificar. A Jamdesk não calcula a Pontuação de IA para ele. Agentes de IA ainda podem ler sua documentação por meio de llms.txt, que permanece publicado independentemente de noindex. Remova noindex de seo.metatags.robots em docs.json para voltar a receber uma pontuação.

Algumas verificações abrangem comportamentos da plataforma gerenciados pela Jamdesk (llms.txt, exportação em Markdown, códigos de status e cache). Elas são aprovadas por padrão. Uma falha quase sempre indica um problema temporário no build. Execute a pontuação novamente após o próximo build. Entre em contato com o suporte se o problema persistir.

O que vem a seguir?

llms.txt

O índice que as ferramentas de IA leem para entender todo o seu site

Código-fonte Markdown

O Markdown bruto que os agentes obtêm para qualquer página

Atualizações automatizadas

Mantenha a documentação atualizada conforme seu produto muda

Ferramenta AI Score

Avalie gratuitamente qualquer site de documentação