LLM 対応ドキュメント

ドキュメントサイトの LLM 向けバージョンを提供する

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

LLM が情報検索や知識支援においてますます重要になるにつれて、ドキュメントを LLM に適した形にすることは、これらのモデルがあなたの製品やサービスをどのように理解し、表現するかを大幅に向上させることができます。

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

.md ページ

GitBook では、ドキュメントサイトのすべてのページが自動的に Markdown ファイルとして利用可能になります。 .md 拡張子を任意のページに付けると、そのページの内容が Markdown で表示されます。これは HTML ファイルよりも効率的に処理できるため、LLM に渡すことができます。

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

llms.txt

llms.txt は、LLM が処理しやすいテキストベースの形式で Web コンテンツを利用可能にするための提案標準です。 llms.txt ページは、 /llms.txt をドキュメントサイトのルート URL の末尾に追加することでアクセスできます。

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

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

llms-full.txt

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

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

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

MCP サーバー

GitBook は、公開されたすべてのスペースに対して Model Context Protocol(MCP)サーバーを自動的に公開します。MCP により、AI ツールはスクレイピングなしで、ドキュメントをリソースとして発見し取得するための構造化された方法を得られます。

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

この 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 にドキュメントについて質問してみて、コンテンツをどの程度理解しているか確認しましょう。うまくいくことと、うまくいかないことに驚くかもしれません。

最終更新

役に立ちましたか?