公開前に llms.txt ファイルを検証する方法

llms.txt が壊れている場合は、llms.txt がない場合よりも悪いです。ファイルの形式が正しくない場合、それを読み取るツールやモデルは、サイトの混乱を招く、または不完全な画像を取得します。これは、あなたが望んでいたものとは反対です。良いニュース: llms.txt 形式はシンプルなので、何を確認するかが分かれば、検証はすぐに完了します。

これは、毎回の公開前に実行できる、実用的で無駄のないチェックリストです。

フォーマットに実際に必要なもの

llms.txt 形式 (llmstxt.org より) は、意図的に最小限の Markdown になっています。

プロジェクトに名前を付ける単一の H1 タイトル, ファイルの最初の行。
タイトルの直後に、オプションですが推奨される要約ブロック引用 (> …)。
0 個以上の H2 セクション (## Docs、## API、…)。それぞれにリンクのリストが含まれます。
各リンクはリスト項目です: - [Name](https://example.com/page): short description。

それが全体の構造です。ほとんどの検証問題は、この形状から逸脱しています。

公開前チェックリスト

1. ちょうど 1 つの H1、そしてそれが最初です

ファイルは 1 つの # Title 行で開く必要があります。よくある間違い:

H1 がまったくありません (ファイルは散文またはリストで始まります)。
複数の H1 (セクションには代わりに ## を使用します)。
H1 は他のコンテンツの下に埋もれています。

2. ブロック引用の要約

タイトルの直後に、サイトまたはプロジェクトが何であるかを説明する 1 行の > ブロック引用符を含めます。モデルでも人間でも、あらゆる読者に瞬時のコンテキストを提供します。仕様ではオプションですが、実際には推奨されます。

3. リンクをグループ化するセクション

関連リンクをグループ化するには、## 見出しを使用します: ## Documentation、## API Reference、## Guides。セクションのないフラットなリンクのダンプはナビゲートするのが困難です。リンクが数個以上ある場合は、それらをグループ化します。

4. 整形式のリンク

すべてのリンクを確認してください:

空の URL, かっこ内に何もない [Docs]()。
リンクテキストがありません - ラベルのない [](https://…)。
不正な URL, タイプミス、https:// の欠落、迷彩文字。
重複リンク - 同じ URL が複数回表示されるとスペースが無駄になり、コピー＆ペーストのエラーが発生します。

5. 各リンクの説明

裸の - [Quickstart](https://…) は、- [Quickstart](https://…): Get set up in five minutes よりもはるかに役に立ちません。説明は、リンクが「なぜ」重要であるか、そしてそれを「いつ」たどるべきかをモデルに伝えます。すべてのリスト項目リンクに 1 つ追加します。

6. 簡潔にする

llms.txt はインデックスであり、アーカイブではありません。ファイルが非常に大きい (数十キロバイト以上) 場合は、厳選されたリンクリストが属する場所に完全なコンテンツを詰め込んでいることを示しています。

7. コンパニオン llms-full.txt を検討してください

モデルが完全に必要とする長い形式のコンテンツが本当にたくさんある場合は、完全なテキストを含む別の llms-full.txt を公開し、それにリンクする軽量マップとして llms.txt を保持します。

クリーンなファイルの簡単な例

# 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

1 つの H1、概要、グループ化されたセクション、説明されたリンク、重複なし。それが目標です。## 自動的に検証します

チェックリストを手動で実行することはできますが、重複した URL や長いファイル内の説明の欠落を見逃しがちです。無料の llms.txt バリデーターは、上記のすべてを 1 回のパスでチェックし、構造スコアと具体的な行を意識した提案を提供します。

次の 2 つの方法で検証できます。

コンテンツをバリデータに直接貼り付ける、または
URL を入力してください - サイトを指定するか (/llms.txt が自動的に取得されます)、ファイルに直接リンクします。これは、すでにライブになっているファイルを確認するのに便利です。

いずれの方法でも、公開前または公開後、何を修正すべきかが正確にわかります。

問題を修正した後

バリデーターが満足したら、次のようにします。

ファイルを llms.txt として保存し、ドメインルート (https://example.com/llms.txt) にアップロードします。
ライブ URL に対してバリデータを再実行し、それがプレーンテキストとして提供され、到達可能であることを確認します。
サイトを再構築したり、主要なセクションを追加したりするたびに、再確認してください。

結論

検証には数分かかります。これにより、ファイルを読み込むツールに密かに誤解を与えるようなファイルを送信する必要がなくなります。チェックリストを実行し、構造を修正し、公開する前に validator で確認します。

まだファイルをお持ちではありませんか? llms.txt ジェネレーターを使用してサイトからクリーンなドラフトを生成し、それを検証します。また、本当に必要かどうかまだ判断していない場合は、llms.txt が意味をなす場合を参照してください。

発行前に llms.txt ファイルを検証する方法