Docusaurus

Synchronisieren Sie Ihre Docusaurus-Dokumentationsseite mit der Wissensdatenbank von AI SmartTalk. Ihre KI wird aus jeder Seite in Ihrer Sitemap lernen – perfekt für Support-Bots, die technische Fragen beantworten.

---

Übersicht

Die Docusaurus-Integration ermöglicht Ihnen:

• Importieren Sie automatisch alle Seiten aus Ihrer Sitemap
• Halten Sie die Dokumente synchron, wenn Sie Updates veröffentlichen
• Beantworten Sie Fragen zu Ihrer Dokumentation im Gespräch
• Reduzieren Sie die Supportlast, indem Sie die KI häufige Fragen bearbeiten lassen

Spaßfakt: Die eigene Dokumentation von AI SmartTalk verwendet Docusaurus, und diese Integration treibt unseren Support-Chatbot an!

---

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie:

• Ein aktives AI SmartTalk-Konto haben
• Eine Docusaurus-Seite mit einer gültigen sitemap.xml besitzen
• Ihre Seite muss öffentlich zugänglich sein (oder Authentifizierung bereitstellen)

---

Schritt-für-Schritt-Setup

Schritt 1: Finden Sie Ihre Sitemap

Docusaurus generiert automatisch eine Sitemap. Finden Sie sie unter:

https://your-docs-site.com/sitemap.xml

Überprüfen Sie, ob sie in Ihrem Browser geladen wird und Ihre Dokumentationsseiten enthält.

Schritt 2: Fügen Sie die Docusaurus-Integration hinzu

1. Melden Sie sich bei Ihrem AI SmartTalk-Konto an
2. Navigieren Sie zu Einstellungen → Integrationen
3. Suchen Sie Docusaurus und klicken Sie auf Verbinden
4. Geben Sie die URL Ihrer Sitemap ein
5. Klicken Sie auf Validieren

Schritt 3: Konfigurieren Sie die Import-Einstellungen

Nach der Validierung konfigurieren Sie Ihren Import:

Einstellung	Beschreibung
Sitemap-URL	Vollständige URL zu Ihrer sitemap.xml
Einschlussmuster	Nur Seiten synchronisieren, die den Mustern entsprechen (optional)
Ausschlussmuster	Bestimmte Seiten oder Abschnitte überspringen (optional)

Schritt 4: Starten Sie den Import

1. Klicken Sie auf Seiten importieren
2. AI SmartTalk crawlt jede URL in Ihrer Sitemap
3. Inhalte werden extrahiert und Ihrer Wissensdatenbank hinzugefügt
4. Warten Sie, bis der Import abgeschlossen ist (Fortschritt wird angezeigt)

Schritt 5: Überprüfen Sie den Import

1. Gehen Sie zu Wissen in AI SmartTalk
2. Ihre Dokumentationsseiten sollten angezeigt werden
3. Testen Sie Ihre KI, indem Sie Fragen zu Ihren Dokumenten stellen

---

Was synchronisiert wird

Inhalt	Wie es verarbeitet wird
Seitentitel	Wird als Dokumentenidentifikator verwendet
Seiteninhalt	Volltext, der aus HTML extrahiert wurde
Überschriften	Für die Struktur beibehalten
Codeblöcke	Unverändert einbezogen
Tabellen	In ein lesbares Format umgewandelt
URLs	Seiten-URL zur Referenz gespeichert

Inhaltsextraktion

AI SmartTalk extrahiert den Hauptinhalt und ignoriert:

• Navigationsmenüs
• Seitenleisten
• Fußzeilen
• Skripte und Stile

---

Synchronisationsverhalten

Manuelle Importierung

Klicken Sie auf Importieren in den Integrationseinstellungen, um:

• Die neueste Sitemap abzurufen
• Neue Seiten hinzuzufügen
• Geänderte Seiten zu aktualisieren
• Gelöschte Seiten zu entfernen

Dokumente aktuell halten

Für stets aktuelle Dokumentation:

1. Manuelles Aktualisieren: Klicken Sie auf Importieren, nachdem Sie Aktualisierungen veröffentlicht haben
2. Geplante Synchronisation: Verwenden Sie SmartFlow, um Importe zu automatisieren

Geplanter Import mit SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Geplant (Täglich um 3:00 Uhr)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

URL-Muster

Einschlussmuster

Nur bestimmte Abschnitte synchronisieren:

Muster	Effekt
/docs/api/*	Nur API-Dokumentation
/docs/guides/*	Nur den Abschnitt Anleitungen
/blog/*	Nur Blogbeiträge

Ausschlussmuster

Bestimmte Seiten überspringen:

Muster	Effekt
/docs/internal/*	Interne Dokumente überspringen
/changelog	Changelog-Seite überspringen
*/draft-*	Entwurfsseiten überspringen

---

Anwendungsfälle

Technischer Support-Bot

Synchronisieren Sie Ihre Produktdokumentation:

• "Wie installiere ich das SDK?"
• "Was sind die API-Datenratenlimits?"
• "Zeigen Sie mir ein Beispiel für die Authentifizierung"

Entwicklerdokumentation

Synchronisieren Sie API-Referenzen und Anleitungen:

• "Welche Parameter akzeptiert der /users-Endpunkt?"
• "Wie gehe ich mit Webhooks um?"
• "Was ist der Unterschied zwischen der v1 und v2 API?"

Interne Wissensdatenbank

Synchronisieren Sie Unternehmenswikis und Verfahren:

• "Wie ist der Prozess zur Beantragung von PTO?"
• "Wie richte ich meine Entwicklungsumgebung ein?"
• "Wo finde ich die Markenrichtlinien?"

---

Fehlersuche

Sitemap-Probleme

Problem	Lösung
"Ungültige Sitemap"	Überprüfen Sie, ob die URL gültiges XML zurückgibt
"Keine Seiten gefunden"	Überprüfen Sie, ob die Sitemap <url>-Einträge enthält
"Zugriff verweigert"	Stellen Sie sicher, dass die Sitemap öffentlich zugänglich ist

Importprobleme

Problem	Lösung
Fehlende Seiten	Überprüfen Sie die Einschluss-/Ausschlussmuster
Import hängt	Große Seiten benötigen Zeit; warten oder in Chargen importieren
Alte Inhalte	Erneut importieren, um die neuesten Versionen abzurufen

Inhaltsqualität

Problem	Lösung
Falsche Inhalte extrahiert	Problem melden – möglicherweise ist eine benutzerdefinierte Extraktion erforderlich
Fehlende Codeblöcke	Überprüfen Sie, ob der Code in standardmäßigen <pre><code>-Tags enthalten ist
Unleserlicher Text	Überprüfen Sie die Seitenkodierung (UTF-8 empfohlen)

---

Verwaltung der Integration

Aktion	Wie
Alle erneut importieren	Klicken Sie auf Importieren in den Integrationseinstellungen
Sitemap ändern	URL aktualisieren und erneut importieren
Inhalt entfernen	Integration trennen oder aus Knowledge löschen
Trennen	Einstellungen → Integrationen → Docusaurus → Trennen

---

Best Practices

1. Qualitativ hochwertige Inhalte: Gut geschriebene Dokumentationen = bessere AI-Antworten
2. Klare Struktur: Verwenden Sie Überschriften, Listen und Tabellen
3. Beschreibende Titel: Seitentitel helfen der AI, den Kontext zu verstehen
4. Regelmäßige Synchronisationen: Halten Sie die AI mit der neuesten Dokumentation auf dem Laufenden
5. Gründlich testen: Stellen Sie häufige Fragen, um die Genauigkeit der AI zu überprüfen

---

Docusaurus Konfigurationstipps

Optimieren für AI-Extraktion

In Ihrer docusaurus.config.js:

module.exports = {
  // Sicherstellen, dass die Sitemap generiert wird
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Verwenden Sie beschreibende Seitentitel
  title: 'Ihre Produktdokumentation',
  
  // Metadaten einfügen
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentation für Ihr Produkt'
    }],
  },
};

Seiten von der Sitemap ausschließen

Um zu verhindern, dass bestimmte Seiten synchronisiert werden:

// Im Frontmatter der Seite
---
title: Interne Seite
sitemap:
  exclude: true
---

---

Verwandte Dokumentation

• Integrationen Übersicht
• Wissensdatenbank Verwaltung
• RSS-Feed-Integration — Für Blog-/Nachrichteninhalte
• SmartFlow Geplante Trigger — Automatisieren Sie Importe