Zum Hauptinhalt springen

Mit KI arbeiten

Die Android Macro-Dokumentation kann nun auf eine LLM-freundlichere Weise genutzt werden.

Dadurch erhalten Sie zwei verschiedene Zugriffsmuster:

  1. Jede Dokumentationsseite als reines Markdown öffnen, indem Sie .md anhängen
  2. Den kuratierten Dokumentationsindex von /llms.txt laden

Markdown-Spiegel​

Jede Dokumentationsroute verfügt nun über einen Markdown-Spiegel.

Beispiel:

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

Das ist nützlich, wenn:

  • Sie eine Seite in ein LLM einfügen möchten
  • Sie möchten, dass ein Agent die bereinigte Dokumentationsversion abruft, anstatt HTML zu parsen
  • Sie stabilen Text für den Prompt-Kontext möchten

llms.txt​

Die Website-Root stellt einen llms.txt-Index bereit:

https://androidmacro.com/llms.txt

Diese Datei ist eine kuratierte Karte der Dokumentation für die LLM-Nutzung. Sie verweist Modelle und Werkzeuge zuerst auf die wichtigsten Seiten und verlinkt dann auf die Markdown-Versionen der Dokumentation.

Verwandte Dateien:

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

Verwenden Sie sie wie folgt:

  • llms.txt als kuratierten Startpunkt
  • llms-full.txt, wenn Sie einen großen Export des Dokumentationskorpus möchten
  • llms-sitemap.txt, wenn Sie eine maschinenfreundliche Liste von Markdown-URLs möchten

Warum das hilft​

HTML-Dokumentationen sind für Menschen gedacht. LLMs kommen normalerweise besser zurecht mit:

  • Markdown statt vollständiger HTML-Seiten
  • Einem kuratierten Index statt dem blinden Crawlen jeder Route

Deshalb verwendet dieses Setup beides:

  • .md-Spiegel für den direkten Seitenzugriff
  • llms.txt-artige Erkennung

Aktuelle Architektur​

Die Markdown-Spiegel und llms.txt-Dateien werden in die Docusaurus-static-Ausgabe generiert und somit zusammen mit der Dokumentationsseite bereitgestellt.

Hinweise​

  • Auch Kategorie-Landingpages erhalten Markdown-Spiegel, wie z. B. https://androidmacro.com/docs/reference/storage.md
  • Das generierte Markdown ist für die LLM-Nutzung konzipiert, daher werden einige interaktive Einbettungen durch kurze Hinweise ersetzt
  • Erstellen Sie die Dokumentationsseite nach Inhaltsänderungen neu, damit die Markdown-Spiegel und llms.txt synchron bleiben

Verwandte Seiten​