user-robotLLM 対応のドキュメント

LLM に適した形式のドキュメントサイトを提供する

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

LLMが情報検索やナレッジ支援においてますます重要になる中、ドキュメントをLLMフレンドリーにしておくことで、これらのモデルがあなたの製品やサービスをどのように理解し、表現するかを大幅に改善できます。

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

.mdページ

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

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

llms.txt

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

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

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

llms-full.txt

どちらに llms.txt ファイルには、ドキュメントサイト内のすべてのページURLとタイトルの索引が含まれており、 llms-full.txt には、LLMにコンテキストとして渡せる1つのファイルに、ドキュメントサイトの全コンテンツが含まれています。

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.

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にドキュメントについて質問してみて、コンテンツをどれだけ理解しているか確認しましょう。うまく機能する点とそうでない点に、きっと驚くかもしれません。

最終更新

役に立ちましたか?