ドキュメントサイト向けの llms.txt
公開日:
ドキュメントサイトは llms.txt の理想的なユースケースです。ユーザーは AI ツールに「あなたの製品で X をするにはどうすればいい?」と絶えず尋ねており、厳選されたファイルがあれば、それらのモデルを適切なページへ直接案内できます。
ドキュメントが最も恩恵を受ける理由
あなたのドキュメントは、それ自体がすでに答えです。llms.txt を使えば、ナビゲーションや検索 UI、マーケティングページをクロールさせる代わりに、整理されたインデックス(はじめに、ガイド、API リファレンスなど)をモデルに手渡すことができます。
構造から生成する
ほとんどのドキュメントサイトには、すでに sitemap.xml があります。それらの URL をフラットに並べるのではなく、いくつかの理にかなったセクションにグループ分けしましょう。
# Acme Docs > Documentation for the Acme API: setup, guides, and the full endpoint reference. ## Getting started - [Quickstart](https://acme.com/docs/quickstart): First request in 5 minutes - [Authentication](https://acme.com/docs/auth): API keys and scopes ## Reference - [Endpoints](https://acme.com/docs/api): Every endpoint and parameter ## Optional - [Changelog](https://acme.com/docs/changelog): Release history
Markdown 版へのリンクを張る
多くのドキュメントフレームワーク(Docusaurus、MkDocs、Mintlify、GitBook など)は、各ページの Markdown 版やプレーンテキスト版を配信できます。そうしたもの(page.md)へリンクを張れば、モデルはナビゲーションやサイドバー付きのレンダリングされた HTML ではなく、整理されたコンテンツを解析できます。
完全なコンテキストのために llms-full.txt を追加する
大規模なドキュメントセットの場合は、全文をインライン化した llms-full.txt を併せて公開し、エージェントが一度の取得ですべてを取り込めるようにしましょう。llms.txt は簡潔なインデックスとして維持します。
厳選し、それから検証する
ファイルを手書きするにせよ、プラグインから生成するにせよ、出力を見直しましょう。自動生成ツールは内容を盛り込みすぎる傾向があります。パターンについては llms.txt の例 を参照し、その後 検証 して、構造が正しいことと、すべてのリンクが正しく解決されることを確認してください。