Wie KI der persönliche Assistent in großen Dokumentationen wird

Die Entwicklerwelt hat sich in sehr kurzer Zeit grundlegend verändert. Vor 2 Jahren scrollte man noch mühsam durch eine Dokumentation oder versuchte, im Code eines Open-Source-Projektes nachzuvollziehen, was in der Funktion passiert.
Heute können wir KI-Assistenten wie GitHub Copilot nutzen, um schnell und präzise die Informationen zu finden, die wir brauchen.

Warum Sourcecode statt Dokumentation?

Viele Open-Source-Projekte entwickeln sich schnell und umfangreich weiter. Das führt allerdings oft dazu, dass die Dokumentationen schnell veraltet oder unvollständig sind. Außerdem decken sie auch oft genau den einen Edge Case nicht ab, den man gerade lösen muss. Sourcecode hingegen ist die einzige Quelle der Wahrheit. Er zeigt nicht nur, was theoretisch möglich ist, sondern wie es tatsächlich implementiert wurde.
Wenn man den Code direkt durchsucht, sieht man die reale Implementierung mit allen Details. Man erkennt Patterns, die in der Dokumentation nie explizit erwähnt werden. Man findet heraus, wie verschiedene Komponenten tatsächlich zusammenspielen, welche Parameter wirklich unterstützt werden und welche versteckten Optionen existieren.

Bei der Entwicklung eines Webshops mit Medusa.js kamen bei uns immer wieder Fragen auf, die die Dokumentation nicht auf den ersten Blick beantworten konnte. Mithilfe der KI konnten wir diese Fragen genau anhand des Codes schnell beantworten.

Wie KI beim durchsuchen von Codebases hilft

Der Einstieg in diesen Workflow ist erstaunlich einfach. Du benötigst VS Code, GitHub Copilot mit deinem präferierten Sprachmodell und die gewünschte Codebasis auf deinem Rechner. Für unser Medusa.js-Beispiel klonst du einfach das Repository und öffnest es in VS Code. Dabei solltest du aber darauf achten, die Version des Codes auszuchecken, die du in deinem Projekt auch benutzt.

Und schon hast du deinen persönlichen Assistenten, der dir alle Fragen zu der Codebase beantworten kann. Hier ein paar Beispiele:

Schnelle Orientierung in neuen Codebasen: Wenn du das erste Mal in ein Projekt wie Medusa.js einsteigst, kannst du den Assistenten fragen: "Zeige mir, wo die Produktverwaltung implementiert ist" oder "Wie funktioniert der Checkout-Prozess?". Die KI durchsucht die gesamte Codebasis semantisch und führt dich direkt zu den relevanten Dateien und Funktionen.

Finden von Implementierungsbeispielen: Du möchtest einen Custom Service schreiben? Frage einfach: "Zeige mir Beispiele für Custom Services in dieser Codebase". Der Assistent findet nicht nur die Definitionen, sondern auch konkrete Implementierungen, an denen du dich orientieren kannst. Das spart Stunden des manuellen Suchens.

Verstehen von Zusammenhängen: Komplexe Abhängigkeiten zwischen Modulen oder Funktionen sind schwer zu durchschauen. Mit Fragen wie zum Beispiel: "Wie hängen ProductService und InventoryService zusammen?" erhältst du eine Analyse der Beziehungen, inklusive Code-Referenzen und Erklärungen der Datenflüsse.

API-Erkundung: Du brauchst alle verfügbaren Methoden eines Services? Statt durch hunderte Zeilen zu scrollen, fragst du: "Welche öffentlichen Methoden bietet der CartService?" Die KI extrahiert diese Informationen, zeigt dir die Signaturen und erklärt, wofür jede Methode gedacht ist.

Debugging und Problemlösung: Wenn etwas nicht funktioniert, hilft die KI beim Zurückverfolgen. "Wo wird diese Exception geworfen?" oder "Welche Validierungen werden beim Erstellen einer Order durchgeführt?" führen dich direkt zu den kritischen Code-Stellen.

Migrations-Hilfe: Bei Breaking Changes zwischen Versionen kannst du fragen: "Wie hat sich die Plugin-API zwischen Version 1.x und 2.x geändert?". Die KI vergleicht die relevanten Code-Abschnitte und zeigt dir die Unterschiede auf.

Fazit:

Der Workflow „Code Checkout und KI-Assistent befragen“ revolutioniert die Art, wie wir mit großen Codebasen arbeiten. Statt uns auf potenziell veraltete Dokumentation zu verlassen, gehen wir direkt zur Quelle der Wahrheit. Mit GitHub Copilot wird diese Arbeit nicht nur effizienter, sondern auch deutlich angenehmer.

Für dein nächstes Projekt mit Medusa.js oder einem anderen Framework: Checke den Code aus, öffne ihn in VS Code und beginne den Dialog mit deinem KI-Assistenten. Du wirst überrascht sein, wie viel schneller du produktiv wirst und wie viel tiefer dein Verständnis des Codes wird.