Een AI-chatbot voor technische documentatieteams die antwoorden met bronvermelding en minder supporttickets nodig hebben. ChattyBox beantwoordt vragen zoals “Hoe authenticeer ik API-verzoeken?” rechtstreeks vanuit uw documenten en linkt de pagina die hij gebruikte — zonder aangepaste RAG en zonder migratie.
AI-chatbots voor algemeen gebruik proberen een gesprekspartner te zijn. Zonder brongronding kunnen ze zelfverzekerd antwoorden vanuit de verkeerde context.
We gebruiken retrieval-augmented generation op uw gepubliceerde docs en site-inhoud en tonen vervolgens bronlinks waar antwoorden vandaan kwamen.
Voor teams die zichtbaar bewijs in elk antwoord nodig hebben, vergelijk de workflow voor een AI-chatbot met bronvermeldingen die documentatieverkeer verbonden houdt met ondersteunende pagina’s.
Een documentatie-chatbot verdient vertrouwen door de repetitieve vragen te beantwoorden die uw ondersteunings- en communitykanalen al zien – en de pagina te vermelden die hij heeft gebruikt. Dit zijn voorbeelden die ChattyBox verwerkt vanuit geïndexeerde documentatiecontent.
Stel de testset samen uit echte documentatietaken, koppel aan elke beantwoordbare vraag een referentiebron en verwachte feiten en neem vragen op die de assistent moet weigeren. Beoordeel elke categorie afzonderlijk, zodat een sterk API-resultaat geen zwakke migratie- of authenticatierichtlijnen kan verhullen.
Voer de suite opnieuw uit vóór de lancering, na wezenlijke wijzigingen in documentatie of retrieval en na de lancering volgens een geplande maandelijkse steekproef.
| Vraaggebied | Testfixture | Slaagvoorwaarde |
|---|---|---|
| API | Endpoint, verplichte velden, responsstructuur en rate limit. | Gebruikt de gedocumenteerde methode en het pad; verplichte waarden en bronvermelding komen overeen met de referentie. |
| SDK | Installeer en initialiseer één ondersteunde SDK-versie. | Package, import, initialisatie en codesyntaxis passen bij die taal en versie. |
| CLI | Installeer, authenticeer, voer een opdracht uit en interpreteer de uitvoer. | Flags en volgorde zijn geldig; het antwoord verzint geen interactieve prompts. |
| Authenticatie | Locatie van inloggegevens, headerindeling, scopes en één verboden flow. | Maakt nooit een geheim bekend, onderscheidt client- en servergebruik en vermeldt de beveiligingsvereiste als bron. |
| Paginering | Eerste pagina, vervolg, laatste pagina en maximale paginagrootte. | Gebruikt het gedocumenteerde cursor- of offsetmodel en noemt alleen gedocumenteerde limieten. |
| Fouten | Bekende foutcode, waarschijnlijke oorzaak, herstelstap en onbekende code. | Koppelt bekende fouten correct en valt terug bij ongedocumenteerde oorzaken. |
| Migraties | Brekende wijziging, vereiste, geordende stappen en rollback-opmerking. | Behoudt de volgorde en waarschuwingen zonder oude en nieuwe procedures te vermengen. |
| Documentatie met versies | Stel dezelfde gedragsvraag voor de huidige, vorige en niet-gespecificeerde versies. | Antwoordt voor de genoemde versie, vraagt door bij onduidelijkheid en citeert die versie. |
Publiceer de regels vóór het testen. Reviewers moeten op basis van het antwoord, de verwachte feiten en de geciteerde bron tot hetzelfde resultaat komen, zonder af te gaan op hoe overtuigend de reactie klinkt.
| Dimensie | Alleen accepteren wanneer |
|---|---|
| Antwoordkwaliteit | Alle vereiste feiten zijn correct, relevant en niet-tegenstrijdig en gebruiken de gevraagde API-, SDK-, CLI- of documentatieversie. |
| Nauwkeurigheid van bronvermeldingen | Elke wezenlijke claim heeft een werkende bronvermelding die deze rechtstreeks ondersteunt op de juiste versiepagina. |
| Fallbackgedrag | Ontbrekend, onduidelijk, tegenstrijdig of niet-geautoriseerd bewijs leidt tot een duidelijke beperking en een nuttige vervolgstap in plaats van een gok. |
| Lanceringseis | Geen niet-ondersteunde kritieke claims over authenticatie of migratie, 100% geslaagd voor kritieke gevallen, ten minste 90% totale acceptatie en ten minste 95% nauwkeurigheid van bronvermeldingen. |
Methode: schrijf 24 vragen voordat u de assistent uitvoert, drie voor elk matrixgebied. Noteer voor elke vraag de bedoelde versie, referentiepagina, vereiste feiten, verboden claims en of fallback wordt verwacht. Twee reviewers beoordelen de vastgelegde antwoorden onafhankelijk, lossen meningsverschillen op aan de hand van de bron en bewaren de prompts en uitvoer voor regressietests.
De onderstaande cijfers zijn een illustratief uitgewerkt resultaat voor deze fixture met 24 vragen, geen gemeten ChattyBox-productiegemiddelde of belofte van toekomstige prestaties.
| Waargenomen resultaat | Interpretatie |
|---|---|
| 22 van 24 geaccepteerd (91.7%) | Omvat 20 ondersteunde antwoorden en twee correcte fallbacks. |
| 20 van 22 inhoudelijke antwoorden citeerden rechtstreeks ondersteunende pagina’s (90.9%) | Onder de lanceringseis van 95%; de versierangschikking moet worden gecorrigeerd. |
| 2 van 2 verwachte fallbacks waren correct (100%) | In deze kleine fixture viel geen enkel beantwoordbaar geval ten onrechte terug. |
| 1 van 24 bevatte een niet-ondersteund pagineringsdetail (4.2%) | De lancering blijft geblokkeerd totdat de niet-ondersteunde claim is verwijderd en de regressietest slaagt. |
Speciaal gebouwde workflows die antwoorden traceerbaar, gefundeerd en nuttig houden voor technische gebruikers.
Voer uw document-, website- of sitemap-URL in. ChattyBox crawlt en indexeert de pagina's die gebruikers al lezen.
De antwoordflow is ingesteld om opgehaalde context te gebruiken en onbevestigde claims over API's, functies, prijzen of beleid te vermijden.
Antwoorden kunnen links bevatten naar de documentatiepagina's waar de relevante informatie staat.
Behandel de lancering als een documentatierelease met eigenaren, eisen, observability en een rollbackpad.
Segmenteer elke statistiek op onderwerp, documentatieversie, locale en doelgroep waar de steekproefgrootte dit toelaat. Trends en beoordeelde steekproeven zijn nuttiger dan één totaalscore.
| Statistiek | Definitie en actie |
|---|---|
| Antwoordpercentage | Aandeel vragen dat een inhoudelijk antwoord krijgt. Controleer onderwerpen met een laag percentage op ontbrekende content; verbeter het cijfer niet door fallback te verzwakken. |
| Onopgeloste vragen | Vragen met fallback, negatieve feedback, herhaald herformuleren of escalatie. Neem wekelijks een steekproef om fouten in antwoorden en retrieval te vinden. |
| Contenthiaten | Onopgeloste clusters waarvoor geen gezaghebbende pagina bestaat. Stuur deze met frequentie en gebruikersimpact naar de documentatiebacklog. |
| Ondersteuningspercentage van bronvermeldingen | Beoordeelde wezenlijke claims met een direct ondersteunende bronvermelding. Onderzoek dalingen per bron en versie. |
| Ticketafbuiging | Geschikte sessies die zonder supportticket worden opgelost, gemeten binnen een vast venster en vergeleken met een baseline. Rapporteer samenhang tenzij een experiment causaliteit aantoont. |
Gebruik de gids voor RAG-architectuur en -evaluatie om retrieval te diagnosticeren, de workflow voor bronvermeldingen om bewijs te beoordelen, de gids voor ontwikkelaarsdocumentatie voor engineeringspecifieke usecases en de technische lanceringschecklist voor implementatiestappen.
Deze antwoorden vatten samen hoe ChattyBox broninhoud leest, documentatiepagina's citeert, omgaat met ontbrekende informatie en wordt geïnstalleerd naast een bestaande stapel documenten.
ChattyBox doorzoekt uw gepubliceerde documenten, website, sitemap, CMS of helpcentrumpagina's, extraheert leesbare tekst en haalt relevante passages op wanneer een bezoeker een vraag stelt.
Ja. Wanneer bronmateriaal beschikbaar is, kan ChattyBox links weergeven naar de documentatiepagina's die voor het antwoord zijn gebruikt, zodat gebruikers de details kunnen verifiëren en kunnen blijven lezen.
De assistent is ontworpen om niet-ondersteunde claims te voorkomen en kan terugvallen als de geïndexeerde inhoud het antwoord niet bevat. Deze hiaten kunnen toekomstige documentatie-updates informeren.
Nee. U kunt uw huidige stapel documenten behouden en de widget ChattyBox insluiten nadat u de door de bron geciteerde antwoorden heeft gecrawld en getest.
Gebruik ChattyBox om repetitieve documentatievragen vanuit broncontent te beantwoorden en hiaten terug te leiden naar uw documentatiebacklog.
