AI ネイティブ化で、AI エージェントと人による ScalarDB と ScalarDL のドキュメントへのアクセス体験を向上

AI ネイティブ化で、AI エージェントと人による ScalarDB と ScalarDL のドキュメントへのアクセス体験を向上

優れたドキュメンテーションとは、充実したコンテンツだけではなく、ユーザーと AI ツールが必要な情報を見つけやすくすることでもあります。過去数ヶ月間、ScalarDB および ScalarDL ドキュメンテーションサイトに、AI 関連の改善を複数実装してきました。このブログでは、これらのアップデートについて詳しく説明します。

• Ask AI インターフェース。 Google AI Mode を活用した会話型検索、事前作成質問と直接 URL アクセスに対応。
• llms.txt と llms-full.txt。 「llms.txt」は llmstxt.org 標準に準拠し、「llms-full.txt」はよりリッチなカスタム補完ファイルとして AI ツールと LLM 連携を支援。
• ページのコピー (Markdown 形式)。 任意のドキュメンテーションページを Markdown として出力、AI ツールやエディタで簡単に活用可能。
• Chat with page。 ChatGPT、Claude、Perplexity との会話を、ページコンテキスト付きで開始可能。
• Context7 自動同期。 毎週の自動化により Context7 ライブラリを最新ドキュメンテーションと常に同期。

Ask AI インターフェース

技術ドキュメンテーションから適切な回答を見つけるには時間がかかることがあります。特に、どのページから始めるべきか不確かな場合や、ScalarDB または ScalarDL を使用するアプリケーション開発の途中である場合です。これをサポートするために、両ドキュメンテーションサイトのナビゲーションバーに Ask AI ボタンを追加しました。

ボタンを選択すると、ドキュメンテーションサイト上で私たちが実装したモーダルが開きます。質問を送信すると、関連するドキュメンテーションにスコープされたクエリとともに Google AI Mode が開き、回答はそこで生成されます。事前に作成された質問セット (スタートガイド、アプリケーション開発、ScalarDB または ScalarDL のデプロイに関するトピックをカバー) から選択するか、テキストフィールドに独自の質問を入力できます。

Ask AI インターフェース

知っておくべきいくつかの詳細:

• ボタンはドキュメンテーションの最新バージョンを閲覧している場合にのみ表示されます。
• 英語と日本語に対応しており、それぞれのユーザー向けにローカライズされた事前作成質問も用意されています。
• ドキュメンテーション URL に「?ask-ai」を追加することで、モーダルを直接開くことができます。例えば scalardb.scalar-labs.com/ja-jp/docs/latest/?ask-ai または scalardl.scalar-labs.com/ja-jp/docs/latest/?ask-ai のように使用できます。これにより、ユーザーを AI 検索体験に直接移動させるリンクを簡単に共有できます。

llms.txt および llms-full.txt ファイル

AI を活用した開発者向けツールが一般的になるにつれ、ドキュメンテーションをブラウザで人間が読むだけでなく、これらのツールが容易に消費できるようにしたいと考えました。

両ドキュメンテーションサイトは、毎回のビルド時に2つのファイルを自動生成するようになりました。

• llms.txt: ドキュメンテーションの最新バージョンのタイトルとリンクのインデックスで、llmstxt.org 標準に従っています。
• llms-full.txt: 最新ドキュメンテーションを一つに集約した、よりリッチなカスタム補完ファイルで、LLM プロンプトのコンテキストや AI ツールのインデックス作成に適しています。

これら両方のファイルは各サイトのルートから利用できます。

ScalarDB:

• scalardb.scalar-labs.com/llms.txt
• scalardb.scalar-labs.com/llms-full.txt

ScalarDL:

• scalardl.scalar-labs.com/llms.txt
• scalardl.scalar-labs.com/llms-full.txt

ドキュメンテーションの最新バージョンのホームページでは、llms.txt と llms-full.txt を直接コピーすることもできます。

これら両ファイルは最新のドキュメンテーションバージョンのみを含んでいるため、コピーボタンは最新バージョンのトップページにのみ表示されます。

Scalar 製品ドキュメンテーションを参照するツールや AI エージェントを構築する場合、これらのファイルは信頼できる、常に最新の出発点になります。

llms.txt および llms-full.txt ファイル

ページのコピーと Chat with page

ページレベルの AI アクションをより活用しやすくするために、ScalarDB と ScalarDL ドキュメンテーションサイトの両方に2つの関連機能を追加しました。これらはドキュメンテーションのすべてのバージョンで利用できます。

ページを Markdown としてコピー

各ドキュメンテーションページ (ホームページを除く) では、ブレッドクラムバーのページを Markdown としてコピーボタンから、現在のページ内容を Markdown 形式でコピーできます。ページ構造やリンク情報も含めて取得できるため、内容を再整形する手間を減らせます。

これにより、要約・分析・コード生成・社内メモ作成などの用途で、AI ツールやエディタにそのまま貼り付けて活用しやすくなります。

ページを Markdown としてコピー

ページとチャット

ページとチャットボタンを押すと、利用したい AI サービス (現在は ChatGPT、Claude、Perplexity) を選択できます。選択後は、現在閲覧しているページを開始コンテキストとして、選択した AI サービスのインターフェースで対話を開始できます。

この機能は、プロンプトを最初から作成することなく、ページ固有のすばやい回答やトラブルシューティングのガイダンス、コード例のたたき台を得たい場合に便利です。AI の出力を利用する際は、重要な内容を必ず元のドキュメンテーションページで確認してください。

ページとチャット

Context7 ライブラリの自動同期

llms-full.txt に基づいて Context7 ライブラリソースを更新する GitHub Actions ワークフローを追加しました。週次で自動実行されるほか、ワンオフ更新用の手動トリガーも利用できます。

現在は週に 1 回実行するように設定しています。これは週次更新で十分と判断したためですが、ワークフローのスケジュールは柔軟に変更できるため、今後ドキュメンテーションや運用上の要件に応じて、更新頻度を増減できます。

この自動化により、手動で更新することなく、Context7 ライブラリを定期的に最新のドキュメンテーションと同期した状態に保つことができます。

まとめ

これらのアップデートは、人間と AI エージェントの両方にとって Scalar ドキュメンテーションサイトをより使いやすく、有用なものにするための継続的な取り組みの一環です。フィードバックを取り入れ、新たな改善方法を見つけながら、今後も継続的にユーザー体験の向上に取り組んでいきます。

ScalarDB と ScalarDL ドキュメンテーションサイトでこれらの機能を試し、AI ワークフローでの使用感についてお知らせください。

ScalarDB および ScalarDL の詳細については、Scalar Engineering ブログの他の記事および ScalarDB ドキュメンテーション、ScalarDL ドキュメンテーションをご覧ください。

ScalarDB または ScalarDL のご利用を検討されている場合は、お問い合わせください。