user-robotLLM対応ドキュメント

ドキュメントサイトのLLMフレンドリーなバージョンを提供する

私たちは、大規模言語モデル(LLM)があなたのドキュメントコンテンツを取り込み、扱いやすくする機能を構築しています。

LLMが情報検索やナレッジ支援で重要性を増す中で、ドキュメントをLLMに優しい形にすることは、これらのモデルがあなたの製品やサービスを理解し表現する能力を大幅に向上させます。

LLM最適化されたドキュメントは、ChatGPT、Claude、Cursor、CopilotなどのAIシステムがあなたの製品やAPIに関して正確で文脈に即した応答を取得・提供できるようにします。

.mdページ

GitBookを使うと、ドキュメントサイトのすべてのページが自動的にマークダウンファイルとして利用可能になります。もしページに .md 拡張子を追加すると、そのページの内容がマークダウンでレンダリングされ、HTMLファイルよりも効率的に処理するためにLLMに渡すことができます。

このページの.mdファイルを確認する

llms.txt

llms.txtarrow-up-right は、ウェブコンテンツをLLMが処理しやすいテキストベースの形式で利用可能にするための提案された標準です。あなたは llms.txt ページにアクセスするために /llms.txt をドキュメントサイトのルートURLに付け加えることでアクセスできます。

この llms.txt ファイルはあなたのドキュメントサイトのインデックスとして機能し、利用可能なすべてのマークダウン形式ページの包括的な一覧を提供します。このファイルにより、LLMがあなたのドキュメントコンテンツを効率的に発見・処理しやすくなります。

GitBookドキュメントの/llms.txtを確認する

llms-full.txt

ここで、 llms.txt ファイルがドキュメントサイトのすべてのページURLとタイトルのインデックスを含むのに対し、 llms-full.txt にはドキュメントサイトの全文が1つのファイルとして含まれており、LLMにコンテキストとして渡すことができます。

GitBookドキュメントの/llms-full.txtファイルを確認する

LLMはこのインデックスを使ってページのマークダウン版へ直接移動でき、HTMLを解析する必要なくドキュメントをコンテキストに取り込めます。

MCPサーバー

GitBookは公開された各スペースに対して自動的にモデルコンテキストプロトコル(MCP)サーバーを公開します。MCPはAIツールがあなたのドキュメントをリソースとして発見・取得するための構造化された方法を提供します — スクレイピングは不要です。

あなたのMCPサーバーには、次を付け加えることでアクセスできます /~gitbook/mcp をドキュメントサイトのルートURLに付加します。例えば、GitBookドキュメントのMCPサーバーは次の場所にあります。 https://gitbook.com/docs/~gitbook/mcp.

circle-info

このURLをブラウザで訪れるとエラーになります。代わりに、LLMやIDEなどHTTPリクエストを行えるツールと共有できます。

詳細は次をお読みください 公開ドキュメント向けのMCPサーバー.

LLM向けにドキュメントを最適化するためのヒント

あなたのGitBookサイトが自動的に .md ページ、 llms.txt、および llms-full.txt ファイルを生成するようになったので、これらのベストプラクティスはLLMがコンテンツを効果的に理解し扱うのに役立ちます。

これらの最適化を行うことで、AI搭載の検索エンジンや生成エンジン最適化(GEO)におけるドキュメントのパフォーマンスが向上する可能性もあります。

一番良い点は? これらのガイドラインは一般的に人間にとってもドキュメントを読みやすくするということです。

明確で階層的な構造を使う

適切な見出し(H1、H2、H3)でコンテンツを分け、巨大なテキストの塊を書くだけにしないでください。箇条書き、番号付きリスト、短い段落はすべてを読みやすくします。

簡潔で専門用語を避けた内容を書く

単純に保ち、どうしても必要な場合以外は複雑な専門用語は省いてください。LLMは余分な言葉を加えずに意味を明確に伝えるとより良く動作します。

実践的な例を含める

説明だけでなく実例を示してください。コードスニペット、APIの例、実際のシナリオは、LLMやユーザーが実際にどのように動作するかを理解するのに役立ちます。

コンテンツを最新かつ正確に保つ

古くなったドキュメントは誰も好みません。定期的な更新により、LLMが最新の機能やアップデートについて誤った情報を伝えることを防げます。

AIツールでテストする

実際にChatGPTやClaudeにドキュメントについて質問して、どれだけよく理解しているかを確認してみてください。何がうまくいき、何がうまくいかないかに驚くかもしれません。

最終更新

役に立ちましたか?