メインコンテンツまでスキップ

AI と連携する

Android Macro のドキュメンテーションは、より LLM に扱いやすい形式で利用できるようになりました。

これにより、3 つの異なるアクセスパターンが提供されます。

  1. 任意のドキュメントページの URL に .md を付けてプレーンな Markdown として開く
  2. /llms.txt からキュレーション済みのドキュメントインデックスを読み込む

Markdown ミラー​

各ドキュメントルートには Markdown ミラーが用意されています。

例:

  • HTML ページ: https://androidmacro.com/docs/basic/how-to-use
  • Markdown ページ: https://androidmacro.com/docs/basic/how-to-use.md

これは次のような場合に便利です。

  • ページを LLM に貼り付けたいとき
  • エージェントに HTML を解析する代わりにクリーンなドキュメント版を取得させたいとき
  • プロンプトコンテキストとして安定したテキストが欲しいとき

llms.txt​

サイトのルートは llms.txt インデックスを公開しています。

https://androidmacro.com/llms.txt

このファイルは LLM 向けにキュレーションされたドキュメントのマップです。モデルやツールを最も重要なページへまず誘導し、その後ドキュメントの Markdown 版へリンクします。

関連ファイル:

  • https://androidmacro.com/llms-full.txt
  • https://androidmacro.com/llms-sitemap.txt

使い分けは次のとおりです。

  • llms.txt はキュレーションされた出発点として
  • llms-full.txt はドキュメント全体をひとつの大きなエクスポートとして取得したいときに
  • llms-sitemap.txt は Markdown URL の機械処理しやすいリストが欲しいときに

なぜ役立つのか​

HTML ドキュメントは人間向けに設計されています。LLM は通常、次のほうが適切に処理できます。

  • ページ全体の HTML ではなく Markdown
  • すべてのルートを盲目的にクロールするのではなく、キュレーションされたインデックス

そのため、このセットアップでは両方を使用しています。

  • 生のページアクセスのための .md ミラー
  • llms.txt 形式のディスカバリ

現在のアーキテクチャ​

Markdown ミラーと llms.txt ファイルは Docusaurus の static 出力に生成されるため、ドキュメントサイトと一緒にデプロイされます。

注記​

  • カテゴリのランディングページにも Markdown ミラーが作成されます（例: https://androidmacro.com/docs/reference/storage.md）
  • 生成される Markdown は LLM 利用向けに設計されているため、一部のインタラクティブな埋め込みは短い注記に置き換えられます
  • Markdown ミラーや llms.txt を同期させるため、コンテンツを変更したあとはドキュメントサイトを再ビルドしてください

関連ページ​