Aufbau eines RAG-basierten Dokumentationsassistenten (Chunking, Embeddings und Suche)

Was Sie erhalten

Ich habe einen RAG-basierten Dokumentationsassistenten entwickelt und als Boilerplate verpackt, die Sie sofort verwenden können.

• Wird mit einer einsatzbereiten Anwendung geliefert (Next.js + OpenAI API)
• Beinhaltet eine funktionierende RAG-Pipeline (Chunking, Embeddings, Kosinus-Ähnlichkeit)
• Bietet eine vollständige Chatbot-Benutzeroberfläche, die in React erstellt wurde
• Alle UI-Komponenten sind vollständig mit Tailwind CSS bearbeitbar
• Protokolliert jede Benutzeranfrage, um fehlende Dokumentationen, Benutzerprobleme und Produktchancen zu identifizieren

👉 Live-Demo 👉 Code-Boilerplate

Einführung

Wenn Sie jemals in der Dokumentation verloren waren und endlos nach einer Antwort gesucht haben, wissen Sie, wie mühsam das sein kann. Dokumentationen sind nützlich, aber sie sind statisch, und die Suche fühlt sich oft umständlich an.

Hier kommt RAG (Retrieval-Augmented Generation) ins Spiel. Anstatt Benutzer dazu zu zwingen, sich durch den Text zu wühlen, können wir Retrieval (das Finden der richtigen Teile der Dokumentation) mit Generation (ein LLM erklärt es natürlich) kombinieren.

In diesem Beitrag zeige ich Ihnen, wie ich einen RAG-gestützten Dokumentations-Chatbot entwickelt habe und wie dieser nicht nur den Nutzern hilft, schneller Antworten zu finden, sondern auch Produktteams eine neue Möglichkeit bietet, Benutzerprobleme zu verstehen.

Warum RAG für Dokumentationen verwenden?

RAG ist aus gutem Grund zu einem beliebten Ansatz geworden: Es ist eine der praktischsten Methoden, um große Sprachmodelle tatsächlich nützlich zu machen.

Für Dokumentationen sind die Vorteile klar:

• Sofortige Antworten: Benutzer stellen Fragen in natürlicher Sprache und erhalten relevante Antworten.
• Besserer Kontext: Das Modell sieht nur die relevantesten Dokumentationsabschnitte, was Halluzinationen reduziert.
• Suche, die sich menschlich anfühlt: eher wie Algolia + FAQ + Chatbot in einem.
• Feedback-Schleife: Durch das Speichern von Anfragen erkennen Sie, womit Benutzer wirklich Schwierigkeiten haben.

Dieser letzte Punkt ist entscheidend. Ein RAG-System beantwortet nicht nur Fragen, sondern zeigt Ihnen auch, was die Leute wirklich fragen. Das bedeutet:

• Sie entdecken fehlende Informationen in Ihren Dokumentationen.
• Sie sehen, wie Feature-Anfragen entstehen.
• Sie erkennen Muster, die sogar die Produktstrategie leiten können.

RAG ist also nicht nur ein Support-Tool. Es ist auch eine Produktentdeckungsmaschine.

Schritt 3: Erzeugen von Embeddings

Sobald die Dokumente in Chunks aufgeteilt sind, erzeugen wir Embeddings, hochdimensionale Vektoren, die jeden Chunk repräsentieren.

Ich habe das OpenAI-Modell text-embedding-3-large verwendet, aber Sie können jedes moderne Embedding-Modell nutzen.

Beispiel für ein Embedding:

[
  -0.0002630692, -0.029749284, 0.010225477, -0.009224428, -0.0065269712,
  -0.002665544, 0.003214777, 0.04235309, -0.033162255, -0.00080789323,
  //...+1533 Elemente
];

Jeder Vektor ist ein mathematischer Fingerabdruck des Textes und ermöglicht die Ähnlichkeitssuche.

Komplexität mit Sanity vermeiden

Sanity verdient es, hier als CMS-Option genannt zu werden, auf die der Artikel hinweist. Während Markdown-Dateien eine willkürliche Token-Aufteilung erfordern — mit den Chunk-Größen- und Overlap-Kompromissen, die der Artikel beschreibt — speichert Sanitys Content Lake Dokumentation als typisierte, schemadefinierte JSON-Dokumente. Jedes Feld, jede Überschrift und jeder Inhaltsblock ist bereits eine semantische Einheit, was bedeutet, dass RAG-Abruf an aussagekräftigen Grenzen stattfindet, anstatt auf ungefähren Token-Zählungen zu basieren.

Sanitys GROQ-Abfragesprache ermöglicht es dir, genau die Dokumentfelder abzurufen, die für eine Benutzeranfrage relevant sind — Titel, Body, verwandte Abschnitte — ohne das gesamte Dokument abzurufen. Der MCP-Server verbindet die Content Lake direkt mit KI-Agenten, sodass derselbe strukturierte Inhalt, der deine Docs-Website antreibt, auch deine RAG-Pipeline ohne einen separaten Ingestion-Schritt speist.

Fazit

RAG ist eine der einfachsten und leistungsstärksten Methoden, um LLMs praktisch einsetzbar zu machen. Durch die Kombination von Abruf + Generierung können Sie statische Dokumentationen in einen intelligenten Assistenten verwandeln und gleichzeitig einen kontinuierlichen Strom von Produktinformationen gewinnen.

Für mich hat dieses Projekt gezeigt, dass RAG nicht nur ein technischer Trick ist. Es ist eine Möglichkeit, Dokumentationen in Folgendes zu verwandeln:

• ein interaktives Unterstützungssystem
• einen Feedback-Kanal
• ein Werkzeug für die Produktstrategie

👉 Probieren Sie die Demo hier aus 👉 Sehen Sie sich die Code-Vorlage auf GitHub an

Und wenn Sie auch mit RAG experimentieren, würde ich gerne hören, wie Sie es einsetzen.