Das Open-Source-Projekt Docsy, das von Google zum Erstellen von Dokumentationsseiten mit dem statischen Seitengenerator Hugo entwickelt wurde, wechselt zur Linux Foundation. Dies geschieht zu einem Zeitpunkt, an dem technische Dokumentation zu einer direkten Quelle für KI-Agenten geworden ist und nicht mehr nur für Entwickler dient.
Erin McKean, Developer-Relations-Ingenieurin bei Google und Mitglied des Docsy-Lenkungsausschusses, gab den Schritt am Mittwoch während einer Rede auf dem Open-Source-Gipfel der Linux Foundation in Europa in Prag bekannt. Der Wechsel beruht teilweise auf der Verbreitung von Docsy innerhalb des Projektökosystems, das mit der Stiftung verbunden ist. Bis Ende 2024 verwendeten es rund 2.200 Projekte, darunter Projekte der Cloud Native Computing Foundation wie Kubernetes, OpenTelemetry, gRPC und Jaeger.
Ein Dokumentationsprojekt richtet sich an ein maschinelles Publikum
Docsy wurde erstmals 2019 angekündigt. Es handelt sich um ein Open-Source-Template für technische Dokumentation, das mit offenen oder privaten Projekten verwendet werden kann. Die jüngsten Änderungen konzentrieren sich jedoch darauf, wie KI-Tools auf Inhalte zugreifen, und auf die Form der Anweisungen, die diese Tools zur Ausführung projektbezogener Aufgaben benötigen.
Seit der Version 0.15.0 im Mai kann Docsy neben der üblichen HTML-Version eine Markdown-Version jeder Seite erzeugen. Außerdem kann es eine llms.txt-Datei erstellen, die einen Index der Website-Inhalte bereitstellt. Beide Funktionen sind optional und experimentell.
In der im Juli veröffentlichten Version 0.16.0 wurde ein Upgrade-Leitfaden hinzugefügt, der so formuliert ist, dass ein automatisierter Assistent ihm folgen kann, einschließlich der Voraussetzungen, Schritte und Prüfungen. Die im August veröffentlichte Version 0.17.0 ergänzte am Anfang jeder Seite eine versteckte Anweisung für Nutzer, die llms.txt aktivieren, um zugreifende Agenten zum Website-Index zu führen. Auch diese Funktion bleibt experimentell.
Was ändert sich praktisch?
Docsy verlagert einen Teil der Aufgabe der Dokumentationsoptimierung von der bloßen Formatierung von Seiten für menschliche Leser hin zur Organisation von Inhalten, damit Modelle und Agenten sie finden, verstehen und befolgen können. Für Projekte, die auf Mitwirkende oder externe Nutzer angewiesen sind, könnte dies bedeuten, KI-Tools auf eine klarere Version der Anweisungen zu lenken, anstatt sie diese aus öffentlich zugänglichen HTML-Seiten ableiten zu lassen.
McKean zufolge kann bessere Dokumentation die Zahl der routinemäßigen Fragen verringern, die bei den Betreuern eingehen, weil Antworten den Nutzern zur Verfügung stehen, bevor ein Maintainer eingreifen muss. Das ist ein möglicher betrieblicher Vorteil für Projekte. Es bedeutet jedoch nicht automatisch, dass Agenten die Inhalte korrekt verstehen oder dass die Dokumentation automatisch präzise wird.
Der nächste Schritt: Lesbarkeit für Agenten messen
Das Docsy-Team arbeitet an dem, was es AF documentation scores nennt, also Bewertungen der Agententauglichkeit von Dokumentation. Ziel ist es, Betreuern eine Kennzahl zur Bewertung der Fähigkeit von KI-Tools zu geben, Dokumentation zu entdecken, darin zu navigieren und sie zu nutzen, anstatt sich ausschließlich auf Vermutungen zu verlassen.
Die Quelle erläutert bislang weder die Form dieser Kennzahl noch ihre endgültigen Kriterien oder den Zeitpunkt ihrer Veröffentlichung. Zudem sind die Funktionen Markdown und llms.txt sowie die damit verbundenen Anweisungen optional und experimentell. Ihre praktischen Auswirkungen hängen daher weiterhin davon ab, ob Projekte sie übernehmen, und von der Qualität der von ihnen erstellten ursprünglichen Inhalte.