Sari la conținutul principal

Docusaurus

Sincronizați site-ul dvs. de documentație Docusaurus în baza de cunoștințe AI SmartTalk. AI-ul dvs. va învăța din fiecare pagină din harta site-ului dvs. — perfect pentru boți de suport care răspund la întrebări tehnice.


Prezentare generală

Integrarea Docusaurus vă permite să:

  • Importați toate paginile din harta site-ului dvs. automat
  • Mențineți documentele sincronizate atunci când publicați actualizări
  • Răspundeți la întrebări despre documentația dvs. într-un mod conversațional
  • Reduceți sarcina de suport lăsând AI-ul să se ocupe de întrebările frecvente

Fapt amuzant: Documentația proprie a AI SmartTalk folosește Docusaurus, iar această integrare alimentează chatbot-ul nostru de suport!


Cerințe preliminare

Înainte de a începe, asigurați-vă că aveți:

  • Un cont activ AI SmartTalk
  • Un site Docusaurus cu un sitemap.xml valid
  • Site-ul dvs. trebuie să fie accesibil public (sau să oferiți autentificare)

Configurare Pas cu Pas

Pasul 1: Localizați Harta Site-ului

Docusaurus generează automat o hartă a site-ului. O găsiți la:

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

Verificați că se încarcă în browserul dvs. și conține paginile de documentație.

Pasul 2: Adăugați Integrarea Docusaurus

  1. Conectați-vă la contul dvs. AI SmartTalk
  2. Navigați la SetăriIntegrări
  3. Găsiți Docusaurus și faceți clic pe Conectare
  4. Introduceți URL-ul hărții site-ului dvs.
  5. Faceți clic pe Validare

Pasul 3: Configurați Setările de Import

După validare, configurați importul dvs.:

SetareDescriere
URL hartă siteURL complet către sitemap.xml
Tipare incluseSincronizați doar paginile care se potrivesc cu tiparele (opțional)
Tipare excluseSăriți paginile sau secțiunile specifice (opțional)

Pasul 4: Începeți Importul

  1. Faceți clic pe Importați Pagini
  2. AI SmartTalk va explora fiecare URL din harta site-ului dvs.
  3. Conținutul este extras și adăugat în baza dvs. de cunoștințe
  4. Așteptați finalizarea importului (progresul va fi afișat)

Pasul 5: Verificați Importul

  1. Mergeți la Cunoștințe în AI SmartTalk
  2. Pagina dvs. de documentație ar trebui să apară
  3. Testați AI-ul dvs. punând întrebări despre documentele dvs.

Ce Se Sincronizează

ConținutCum Este Procesat
Titlul paginiiFolosit ca identificator al documentului
Conținutul paginiiTextul complet extras din HTML
TitluriPăstrate pentru structură
Blocuri de codIncluse așa cum sunt
TabeleConvertite într-un format lizibil
URL-uriURL-ul paginii stocat pentru referință

Extracția Conținutului

AI SmartTalk extrage zona principală de conținut și ignoră:

  • Meniurile de navigare
  • Barele laterale
  • Subsolurile
  • Scripturile și stilurile

Comportamentul de Sincronizare

Import Manual

Faceți clic pe Importați în setările de integrare pentru a:

  • Obține harta de site-uri cea mai recentă
  • Adăuga pagini noi
  • Actualiza paginile modificate
  • Îndepărta paginile șterse

Menținerea Documentației Actualizate

Pentru documentație întotdeauna actualizată:

  1. Refresh manual: Faceți clic pe Importați după publicarea actualizărilor
  2. Sincronizare programată: Utilizați SmartFlow pentru a automatiza importurile

Import Programat SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml

Tipare URL

Tipare Incluse

Sincronizați doar secțiuni specifice:

TiparEfect
/docs/api/*Doar documentația API
/docs/guides/*Doar secțiunea de ghiduri
/blog/*Doar postările de blog

Tipare Excluse

Săriți anumite pagini:

TiparEfect
/docs/internal/*Săriți documentele interne
/changelogSăriți pagina de jurnal de modificări
*/draft-*Săriți paginile de proiect

Cazuri de Utilizare

Bot de Suport Tehnic

Sincronizați documentația produsului dvs.:

  • "Cum instalez SDK-ul?"
  • "Care sunt limitele de rată ale API-ului?"
  • "Arată-mi un exemplu de autentificare"

Documentația pentru Dezvoltatori

Sincronizați referințele și ghidurile API:

  • "Ce parametri acceptă endpoint-ul /users?"
  • "Cum gestionez webhook-urile?"
  • "Care este diferența dintre API v1 și v2?"

Baza de Cunoștințe Internă

Sincronizați wiki-urile și procedurile companiei:

  • "Care este procesul pentru solicitarea PTO?"
  • "Cum îmi configurez mediul de dezvoltare?"
  • "Unde găsesc liniile directoare ale brandului?"

Depanare

Probleme cu Harta de Site-uri

ProblemăSoluție
"Harta de site-uri invalidă"Verificați dacă URL-ul returnează XML valid
"Nicio pagină găsită"Verificați dacă harta de site-uri conține intrări <url>
"Acces interzis"Asigurați-vă că harta de site-uri este accesibilă public

Probleme cu Importul

ProblemăSoluție
Pagini lipsăVerificați tiparele incluse/excluse
Import blocatSite-urile mari necesită timp; așteptați sau importați în loturi
Conținut vechiRe-importați pentru a obține cele mai recente versiuni

Calitatea Conținutului

ProblemăSoluție
Conținut greșit extrasRaportați problema—poate necesita extragere personalizată
Blocuri de cod lipsăVerificați dacă codul este în etichete standard <pre><code>
Text distorsionatVerificați codificarea paginii (UTF-8 recomandat)

Gestionarea Integrării

AcțiuneCum
Re-importați totFaceți clic pe Importați în setările de integrare
Schimbați harta de site-uriActualizați URL-ul și re-importați
Îndepărtați conținutulDeconectați integrarea sau ștergeți din Cunoștințe
DeconectațiSetări → Integrări → Docusaurus → Deconectare

Cele Mai Bune Practici

  1. Conținut de calitate: Documentație bine scrisă = răspunsuri mai bune de la AI
  2. Structură clară: Folosiți titluri, liste și tabele
  3. Titluri descriptive: Titlurile paginilor ajută AI-ul să înțeleagă contextul
  4. Sincronizări regulate: Mențineți AI-ul actualizat cu cea mai recentă documentație
  5. Testare amănunțită: Puneți întrebări frecvente pentru a verifica acuratețea AI-ului

Sfaturi de Configurare Docusaurus

Optimizează pentru Extracția AI

În docusaurus.config.js:

module.exports = {
// Asigurați-vă că harta site-ului este generată
plugins: ['@docusaurus/plugin-sitemap'],

// Folosiți titluri descriptive pentru pagini
title: 'Documentația Produsului Dvs.',

// Includeți metadate
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentație pentru Produsul Dvs.'
}],
},
};

Exclude Pagini din Harta Site-ului

Pentru a preveni sincronizarea anumitor pagini:

// În frontmatter-ul paginii
---
title: Pagina Internă
sitemap:
exclude: true
---

Documentație Asemănătoare

Pregătit să îmbunătățești
experiența utilizatorului?

Lansează asistenți AI care încântă clienții și se scalază odată cu afacerea ta.

Conform GDPR