Como validar um arquivo llms.txt antes de publicar
Um llms.txt quebrado é pior do que nenhum llms.txt. Se o arquivo estiver malformado, as ferramentas e modelos que fazem o lêem obterão uma imagem confusa ou incompleta do seu site - o oposto do que você queria. A boa notícia: o formato llms.txt é simples, então a validação é rápida quando você sabe o que verificar.
Esta é uma lista de verificação prática e simples que você pode executar antes de cada publicação.
O que o formato realmente exige
O formato llms.txt (de llmstxt.org) é um Markdown intencionalmente mínimo:
- Um único título H1 nomeando o projeto, a primeira linha do arquivo.
- Uma blockquote de resumo opcional, mas recomendada (
> …) logo após o título. - Zero ou mais seções H2 (
## Docs,## API, …), cada uma contendo uma lista de links. - Cada link é um item da lista:
- [Name](https://example.com/page): short description.
Essa é toda a estrutura. A maioria dos problemas de validação são desvios desta forma.
A lista de verificação de pré-publicação
1. Exatamente um H1, e é o primeiro
O arquivo deve abrir com uma linha # Title. Erros comuns:
- Não há H1 (o arquivo começa com uma prosa ou uma lista).
- Vários H1s (use
##para seções). - O H1 enterrado abaixo de outro conteúdo.
2. Uma citação resumida
Logo após o título, inclua uma citação em bloco > de uma linha descrevendo o que é o site ou projeto. Dá a qualquer leitor - modelo ou humano - contexto instantâneo. É opcional nas especificações, mas recomendado na prática.
3. Seções que agrupam seus links
Use títulos ## para agrupar links relacionados: ## Documentation, ## API Reference, ## Guides. É difícil navegar em um despejo simples de links sem seções. Se você tiver mais do que alguns links, agrupe-os.
4. Links bem formados
Verifique cada link para:
- URLs vazias,
[Docs]()sem nada entre parênteses. - Texto do link ausente,
[](https://…)sem rótulo. - URLs malformados, erros de digitação, falta de
https://, caracteres perdidos. - Links duplicados, o mesmo URL que aparece mais de uma vez desperdiça espaço e sinaliza um erro de copiar e colar.
5. Descrições em cada link
Um - [Quickstart](https://…) simples é muito menos útil que o - [Quickstart](https://…): Get set up in five minutes. A descrição diz ao modelo por que o link é importante e quando segui-lo. Adicione um a cada link de item da lista.
6. Seja conciso
llms.txt é um índice, não um arquivo. Se o seu arquivo for muito grande (dezenas de kilobytes ou mais), isso é um sinal de que você está colocando conteúdo completo onde pertence uma lista de links com curadoria.
7. Considere um complemento llms-full.txt
Se você realmente tem muitos modelos de conteúdo de formato longo que deseja na íntegra, publique um llms-full.txt separado com o texto completo e mantenha llms.txt como o mapa leve vinculado a ele.
Um exemplo rápido de arquivo limpo
# Acme Docs
> Acme is an API for sending transactional email. This file indexes the docs and reference.
## Getting Started
- [Quickstart](https://acme.dev/quickstart): Send your first email in five minutes
- [Authentication](https://acme.dev/auth): API keys and scopes
## API Reference
- [Messages API](https://acme.dev/api/messages): Create and send messages
- [Webhooks](https://acme.dev/api/webhooks): Delivery and bounce events
## Optional
- [Changelog](https://acme.dev/changelog): Release notes
Um H1, um resumo, seções agrupadas, links descritos, sem duplicatas. Esse é o alvo.## Valide-o automaticamente
Executar a lista de verificação manualmente funciona, mas é fácil perder um URL duplicado ou uma descrição ausente em um arquivo longo. Nosso validador llms.txt gratuito verifica todos os itens acima em uma única passagem e fornece uma pontuação de estrutura, além de sugestões específicas com reconhecimento de linha.
Você pode validar de duas maneiras:
- Cole seu conteúdo diretamente no validador ou
- Insira um URL, aponte-o para o seu site (buscaremos
/llms.txtautomaticamente) ou crie um link direto para o arquivo. Isso é útil para verificar um arquivo que já está ativo.
De qualquer forma, você verá exatamente o que corrigir antes, ou depois, de publicar.
Depois de corrigir os problemas
Quando o validador estiver satisfeito:
- Salve o arquivo como
llms.txte carregue-o na raiz do seu domínio (https://example.com/llms.txt). - Execute novamente o validador no URL ativo para confirmar que ele é exibido como texto simples e acessível.
- Verifique novamente sempre que reestruturar seu site ou adicionar seções principais.
O resultado final
A validação leva alguns minutos e evita que você envie um arquivo que engana silenciosamente as ferramentas que o lêem. Execute a lista de verificação, corrija a estrutura e confirme com o validator antes de publicar.
Ainda não tem um arquivo? Gere um rascunho limpo do seu site com o gerador llms.txt e depois valide-o. E se você ainda está decidindo se precisa de um, consulte Quando llms.txt faz sentido.