1. Lisää julkinen dokumentaatio ja testaa oikeita kysymyksiä
Free on pysyvä: yksi sivusto, enintään 10 sivua ja 100 viestiä kuukaudessa ilman luottokorttia. Tarkista vastaukset ja lähteet ja upota widget, kun olet valmis.
Teknisen dokumentaation chatbot
Lisää chatbot tekniseen dokumentaatioosi
Aloita julkisista dokumenteistasi, testaa oikeita teknisiä kysymyksiä ja tarkista linkitetyt lähteet ennen kuin lisäät widgetin sivustollesi.
Pysyvä Free: 10 sivua, 100 viestiä/kk, ei korttiaTuetut vastaukset voivat linkittää takaisin lähdesisältöön
Aloita pienellä dokumentaatiotestillä
Generic AI
Miksi yleiskäyttöiset chatbotit pettävät käyttäjäsi
Yleiskäyttöiset AI-chatbotit pyrkivät olemaan keskustelukumppaneita. Ilman lähdepohjaisuutta ne voivat vastata itsevarmasti väärästä kontekstista.
- Ne voivat ehdottaa ominaisuuksia, joita ei ole olemassa
- Ne voivat antaa vanhentuneita koodiesimerkkejä
- Ne voivat viitata kilpailijoiden tuotteisiin
- Ne voivat turhauttaa teknisiä käyttäjiä
ChattyBox
Miten ChattyBox eroaa muista
Käytämme retrieval-augmented generationia julkaistua dokumentaatiotasi ja sivustosisältöäsi vasten ja näytämme sitten lähdelinkit, joista vastaukset tulivat.
Tiimeille, jotka tarvitsevat näkyvän todisteen joka vastauksessa, vertaa työnkulkua lähteitä siteeraavalle AI-chatbotille joka pitää dokumentaatioliikenteen yhteydessä tukisivuihin.
- Vastaukset pohjautuvat dokumentaatioosi ja lähdesivuihin
- Suorat viittauslinkit lähdesivuille
- Varakäyttäytyminen, kun lähdetieto puuttuu
- Koodiesimerkit pysyvät sidottuina indeksoituihin lähdesivuihin
Dokumentaatio chatbot käytännössä
Kysymykset, joihin dokumentaatio-chatbotin tulee vastata
Käytä kysymyksiä, joita tuki- ja yhteisökanavissasi esitetään jo. Tarkista jokainen vastaus ja siihen linkitetty lähdesivu ennen widgetin julkaisemista.
01
"Kuinka pääsen alkuun, todennun ja teen ensimmäisen pyyntöni?"
02
"Mitä tämä virhe tarkoittaa, ja missä korjaus on dokumentoitu?"
03
"Mitä ovat tämän ominaisuuden suunnitelman rajat, hintarajat ja hinnat?"
04
"Onko minun siirrettävä asiakirja-alustani, vai voiko tämä olla nykyisen sivustoni vieressä?"
Tekniselle yleisölle tutustu erilliseen kehittäjädokumenttien chatbotiin tai lue, miten voit vähentää tukipyyntöjä tekoälyllä olemassa olevan sisältösi avulla.
Valitse stackisi
Docusaurus AI-chatbot lähdeviittauksillaLisää Docusaurus AI -chatbot, joka vastaa dokumentaatiostasi ja lainaa käyttämänsä sivut. Ei omaa RAG-ratkaisua, selkeä hinnoittelu ja yksi komentosarjatagi upotettavaksi.
Lähdeviitteinen AI-chatbot MkDocsilleLisää AI-chatbot MkDocs- tai Material for MkDocs -dokumentaatioon, joka vastaa dokumentaatiostasi ja lainaa lähdesivut. Ei Python-putkea tai omaa RAG-ratkaisua.
API-dokumentaatio tarvitsee tarkat lähderajat
Käytä chatbottia auttamaan kehittäjiä löytämään päätepisteet, todennusvaiheet, parametrit, SDK-metodit ja tunnetut virheet, ja palaa sitten viitedokumentaatioon täydellisen kontekstin saamiseksi. Uskottava koodiesimerkki tai näkyvä viittaus ei todista API-käyttäytymisen olevan oikein.
- Tarkista ensin poimittu sisältö. Crawler ei suorita sivun JavaScriptiä; interaktiiviset viitesivut eivät ehkä tuo päätepisteiden tietoja ladattuun HTML:ään. Pelkkä URL-osoitteen löytyminen ei tarkoita, että viite on indeksoitu kokonaan.
- Rajaa versiot tarkoituksella valituilla URL-osoitteilla tai erillisillä projekteilla. Tarkista kohdeversion metodi, polku, pakolliset kentät, käyttöoikeudet, sivutus ja nopeusrajat sekoittamatta vanhoja SDK-esimerkkejä tai siirtymävaiheita.
- Testaa dokumentoimattomat päätepisteet, tuntemattomat virhekoodit, epäselvät versiot ja tunnistetietoja koskevat pyynnöt. Vaadi selkeä rajoitus tai seuraava vaihe arvailun sijaan. Älä koskaan lisää salaisuuksia julkiseen lähdejoukkoon tai testikehotteeseen.
Arviointiopas, ei mitattuja tuloksia
Uudelleen käytettävä arviointikehys tekniselle dokumentaatiolle
Muodosta testisarja todellisista dokumentaatiotehtävistä, liitä jokaiseen vastattavaan kysymykseen oikea lähde ja odotetut tiedot ja sisällytä kysymyksiä, joihin avustajan pitää kieltäytyä vastaamasta. Arvioi jokainen luokka erikseen, jotta vahva API-tulos ei peitä heikkoja migraatio- tai todennusohjeita.
- Tekninen kirjoittaja
- ChattyBoxin tekninen tiimi
- Tekninen arvioija
- ChattyBoxin dokumentaation tarkastus
- Viimeksi päivitetty
- Tiedot tarkistettu
- July 9, 2026
Suorita sarja uudelleen ennen julkaisua, merkittävien dokumentaatio- tai hakumuutosten jälkeen sekä kuukausittain ajastetulla otoksella julkaisun jälkeen.
| Kysymysalue | Testitapaus | Hyväksymisehto |
|---|---|---|
Kysymysalue API | Testitapaus Päätepiste, pakolliset kentät, vastauksen muoto ja nopeusrajoitus. | Hyväksymisehto Käyttää dokumentoitua menetelmää ja polkua; vaaditut arvot ja viittaus vastaavat viittausta. |
Kysymysalue SDK | Testitapaus Asenna ja alusta yksi tuettu SDK-versio. | Hyväksymisehto Paketti, tuonti, alustus ja koodin syntaksi vastaavat kyseistä kieltä ja versiota. |
Kysymysalue CLI | Testitapaus Asenna, todenna, suorita komento ja tulkitse tulos. | Hyväksymisehto Valitsimet ja niiden järjestys ovat kelvollisia, eikä vastaus keksi vuorovaikutteisia kehotteita. |
Kysymysalue Todennus | Testitapaus Tunnistetietojen sijainti, otsakkeen muoto, käyttöoikeusalueet ja yksi kielletty työnkulku. | Hyväksymisehto Ei koskaan paljasta salaisuutta, erottaa asiakkaan ja palvelimen käytön ja mainitsee turvallisuusvaatimuksen. |
Kysymysalue Sivutus | Testitapaus Ensimmäinen sivu, jatko, päätesivu ja sivun enimmäiskoko. | Hyväksymisehto Käyttää dokumentoitua kohdistinta tai offset-mallia ja ilmoittaa vain dokumentoidut rajat. |
Kysymysalue Virheet | Testitapaus Tunnettu virhekoodi, todennäköinen syy, palautusvaihe ja tuntematon koodi. | Hyväksymisehto Yhdistää tunnetut virheet oikein ja käyttää varavastausta dokumentoimattomille syille. |
Kysymysalue Migraatiot | Testitapaus Rikkova muutos, ennakkoehto, vaiheiden järjestys ja palautusta koskeva huomautus. | Hyväksymisehto Säilyttää järjestyksen ja varoitukset sekoittamatta vanhoja ja uusia menettelyjä. |
Kysymysalue Versioidut asiakirjat | Testitapaus Esitä sama toimintakysymys nykyiselle, aikaisemmille ja määrittelemättömille versioille. | Hyväksymisehto Vastaa nimettyyn versioon, kysyy, jos se on epäselvä, ja lainaa sitä. |
Ensisijaiset lähteet ja toistettava näyttö
Selkeät hyväksymissäännöt
Julkaise säännöt ennen testausta. Arvostelijoiden tulisi päästä samaan tulokseen vastauksesta, odotetuista tosiseikoista ja lähteestä luottamatta siihen, kuinka vakuuttavalta vastaus kuulostaa.
| Ulottuvuus | Hyväksy vain silloin, kun |
|---|---|
Ulottuvuus Vastauksen laatu | Hyväksy vain silloin, kun Kaikki vaaditut tiedot ovat oikein, olennaisia ja ristiriidattomia, ja niissä käytetään pyydettyä API-, SDK-, CLI- tai dokumentaatioversiota. |
Ulottuvuus Lainauksen tarkkuus | Hyväksy vain silloin, kun Jokaisella olennaisella väitteellä on toimiva lähdeviite, joka tukee sitä suoraan oikealla versioidulla sivulla. |
Ulottuvuus Varakäyttäytyminen | Hyväksy vain silloin, kun Puuttuva, moniselitteinen, ristiriitainen tai luvaton todiste tuottaa selkeän rajoituksen ja hyödyllisen seuraavan askeleen arvauksen sijaan. |
Ulottuvuus Julkaisuportti | Hyväksy vain silloin, kun Ei kriittisiä tukemattomia todennus- tai migraatioväitteitä, kriittisten tapausten varavastaus toimii 100-prosenttisesti, yleinen hyväksymisaste on vähintään 90 % ja lähdeviitteiden tarkkuus vähintään 95 %. |
Esimerkkitestausaineisto, ei mitattuja tuloksia
Menetelmä: kirjoita 24 kysymystä ennen avustajan suorittamista, kolme jokaiselle matriisin alueelle. Merkitse jokaiseen kysymykseen tarkoitettu versio, oikea lähdesivu, vaaditut tiedot, kielletyt väitteet ja se, odotetaanko varavastausta. Kaksi arvioijaa pisteyttää tallennetut vastaukset itsenäisesti, ratkaisee erimielisyydet lähteen perusteella ja säilyttää kehotteet sekä vastaukset regressiotestausta varten.
Kaikki alla olevat luvut ovat hypoteettisia esimerkkejä 24 kysymyksen testiaineistosta, eivät mitattu ChattyBox-tulos, tuotannon keskiarvo eivätkä lupaus tulevasta suorituskyvystä.
| Esimerkkitulos, ei mitattu | Miten esimerkkiä käytetään |
|---|---|
Esimerkkitulos, ei mitattu Esimerkki: 22/24 hyväksyttyä (91.7%) | Miten esimerkkiä käytetään Esimerkkitulkinta: 20 tuettua vastausta ja kaksi oikein toimivaa varavastausta. |
Esimerkkitulos, ei mitattu Esimerkki: 20/22 sisällöllistä vastausta sisälsi suoran viittauksen tukeviin sivuihin (90.9%) | Miten esimerkkiä käytetään Esimerkkitulkinta: alle 95%:n julkaisukynnyksen, joten version sijoitusjärjestys on korjattava. |
Esimerkkitulos, ei mitattu Esimerkki: odotetuista varavastauksista 2/2 oli oikein (100%) | Miten esimerkkiä käytetään Esimerkkitulkinta: tässä pienessä testiaineistossa mikään vastauskelpoinen tapaus ei päätynyt virheellisesti varavastaukseen. |
Esimerkkitulos, ei mitattu Esimerkki: 1/24 sisälsi tukemattoman sivutusta koskevan yksityiskohdan (4.2%) | Miten esimerkkiä käytetään Esimerkkitulkinta: estä julkaisu, kunnes tukematon väite on poistettu ja regressiotesti läpäisty. |
Keskeiset ominaisuudet
Suunniteltu dokumentaatio- ja tukisivustoille
Tarkoitukseen suunnitellut työnkulut pitävät vastaukset lähteisiin perustuvina, jäljitettävinä ja hyödyllisinä teknisille käyttäjille.
Välitön haravointi
Anna dokumentaatiosi, verkkosivustosi tai sivustokartan URL-osoite. ChattyBox haravoi ja indeksoi sivut, joita käyttäjät jo lukevat.
Tiukat rajaukset
Vastausprosessi on määritetty käyttämään haettua kontekstia ja välttämään tukemattomia väitteitä API:sta, ominaisuuksista, hinnoittelusta tai käytännöistä.
Lähdelinkit
Vastaukset voivat sisältää linkkejä dokumentaatiosivuille, joilla olennainen tieto sijaitsee.
Dokumentaation chatbotin käyttöönoton tarkistuslista
Käsittele käynnistämistä dokumentaatiojulkaisuna, jossa on omistajat, portit, tarkkailtavuus ja palautuspolku.
- 1Julkiset ja rajoitetut lähteet; määritä jokaiselle omistaja ja kohdeyleisö.
- 2Sulje salaisuudet, luonnokset, kaksoissivut, ei-tuetut versiot ja yksityiset polut pois julkisen chatbotin lähteistä.
- 3Luo vastuullisia, vastaamattomia, moniselitteisiä, kontradiktorisia ja versioristiriitoja testitapauksia kaikilla kahdeksalla matriisialueella.
- 4Suorita hyväksymispaketti, tarkasta lainaukset manuaalisesti ja estä kaikkien kriittisten ei-tuettujen vaatimusten käynnistäminen.
- 5Toteuta pilotti rajatulle yleisölle ja tallenna palaute, ratkaisemattomat kysymykset, viive ja eskalointikäyttäytyminen.
- 6Kirjaa omistaja, uudelleenindeksoinnin aikataulu, poikkeamien käsittelypolku, palautusehto ja regressiotestien toistumisväli.
Toimiin johtavat julkaisun jälkeiset tiedot
Segmentoi jokainen mittari aiheen, dokumentaatioversion, maan ja yleisön mukaan otoskoon salliessa. Trendit ja tarkistetut näytteet ovat hyödyllisempiä kuin yksi kokonaispistemäärä.
| Mittari | Määritelmä ja toiminta |
|---|---|
Mittari Vastausprosentti | Määritelmä ja toiminta Niiden kysymysten osuus, jotka saavat sisältöön perustuvan vastauksen. Tarkista matalan vastausasteen aiheista puuttuva sisältö; älä paranna lukua heikentämällä varavastauksia. |
Mittari Ratkaisemattomia kysymyksiä | Määritelmä ja toiminta Kysymykset, joihin liittyy varavastaus, kielteinen palaute, toistuva uudelleenmuotoilu tai eskalointi. Tarkista niistä viikoittainen otos vastaus- ja hakuvirheiden varalta. |
Mittari Sisällön aukkoja | Määritelmä ja toiminta Ratkaisemattomien kysymysten ryhmät, joille ei ole ensisijaista lähdesivua. Ohjaa ne dokumentaation työjonoon yleisyyden ja käyttäjävaikutuksen perusteella. |
Mittari Lainaustukiprosentti | Määritelmä ja toiminta Tarkistettu materiaaliväitteet suoralla tukiviittauksella. Tutki pudotuksia lähteen ja version mukaan. |
Mittari Tukipyyntöjen välttäminen | Määritelmä ja toiminta Hyväksytyt istunnot, jotka ratkeavat ilman tukipyyntöä, mitattuna määritetyllä aikavälillä ja verrattuna lähtötasoon. Ilmoita korrelaatio, ellei koe osoita syy-yhteyttä. |
KäytäRAG-arkkitehtuuri- ja arviointiopasnoudon diagnosoimiseksisitaatin työnkulkutarkastella todisteita,API-dokumentaation tarkistuksetsuunnittelukohtaisiin käyttötapauksiin jatekninen käynnistyksen tarkistuslistakäyttöönottovaiheita varten.
Dokumentaation chatbotin UKK
Yleisiä kysymyksiä tekoälydokumentaatio-chatboteista
Nämä vastaukset tiivistävät kuinka ChattyBox lukee lähdesisältöä, lainaa dokumentaatiosivuja, käsittelee puuttuvia tietoja ja asentaa olemassa olevan asiakirjapinon rinnalle.
Voinko käyttää chatbottia API-dokumentaatioon?
Kyllä, kun indeksoitu julkinen sisältö sisältää päätepisteiden viitteet, parametrit, todennusoppaat, SDK-esimerkit ja virhetiedot. Se ei suorita API-kutsuja eikä tarkastele yksityisiä tilejä. Haettu konteksti ja viittaukset eivät poista keksittyä API-käyttäytymistä; testaa tärkeät väitteet lähdedokumentaatiota vasten.
Onko Free kokeilujakso?
Ei. Free on pysyvä, pienialainen testi: yksi sivusto, enintään 10 sivua ja 100 viestiä kuukaudessa ilman luottokorttia.
Miltä dokumentaatiosivuilta minun kannattaa aloittaa?
Aloita julkisista sivuista, jotka vastaavat yleisiin käyttöönottoa, vianmääritystä, hinnoittelua ja tuotetta koskeviin kysymyksiin. Voit laajentaa lähdejoukkoa, kun olet tarkistanut ensimmäiset vastaukset.
Milloin dokumentaatiota kannattaa lisätä?
Lisää sivuja, kun ensimmäinen testijoukko on hyödyllinen ja sen tukilähteet ovat ajan tasalla. Pidä yksityiset, vanhentuneet ja asiaankuulumattomat sivut chatbotin ulkopuolella.
Voinko testata vastauksia ennen widgetin asentamista?
Kyllä. Indeksoi valittu julkinen dokumentaatio, kysy todellisia teknisiä kysymyksiä ja avaa lainatut lähdesivut tarkistaaksesi vastaukset ennen widgetin asentamista.
Mitä tapahtuu, jos dokumentaatio ei tue vastausta?
Avustajan pitäisi kertoa rajoituksesta tai tarjota hyödyllinen seuraava vaihe arvaamisen sijaan. Käsittele tukemattomat vastaukset testitapauksina ja mahdollisina dokumentaation puutteina.
Todista vastausten laatu ennen asennusta
Aloita pysyvällä Free-kokeilulla valituille julkisille sivuille, testaa teknisiä kysymyksiä ja tarkista lähteet ennen widgetin upottamista.
Pysyvä Free: 10 sivua ja 100 viestiä/kk