Kaip sukurti žinių bazę: straipsniai, paieška, teisės ir dirbtinio intelekto atsakymai

Žinių bazė yra paieškoma atsakymų biblioteka: kaip kažką padaryti, kaip ką nors ištaisyti, kokia taisyklė. Norint ją sukurti, reikia straipsnių, sugrupuotų į kelias aiškias kategorijas, redaktoriaus, kurį jūsų rašytojai tikrai naudos, paieškos, kuri randa tinkamą straipsnį pagal žodžius, kuriuos žmonės iš tikrųjų įveda, ir sprendimo, kas gali ką skaityti – visuomenė, prisijungę klientai ar tik darbuotojai. Dirbtinio intelekto programėlių kūrėjas gali sukurti struktūrą, redaktorių ir paiešką per trumpą sesiją. Tačiau naudingą žinių bazę daro rašymas ir priežiūra, todėl nuo pat pradžių projektuokite lengvą redagavimą ir pastebėjimą pasenusių straipsnių.

Pirmiausia nuspręskite, kam ji skirta

Tos pačios funkcijos tinka labai skirtingoms svetainėms:

• Viešas pagalbos centras – klientams ir potencialiems klientams. Turi būti greitas, indeksuojamas paieškos sistemų ir parašytas jų žodžiais.
• Tik klientams skirti dokumentai – už prisijungimo, mokantiems klientams ar partneriams.
• Vidinė žinių bazė – darbuotojams skirtos politikos, procesai, instrukcijos. Turi būti privati; paieška ir aktualumas svarbesni nei dizainas.

Viešų ir vidinių straipsnių maišymas vienoje svetainėje yra dažniausia duomenų nutekėjimo priežastis. Jei reikia abiejų, kiekvienam straipsniui nustatykite aiškų matomumo nustatymą arba naudokite dvi atskiras svetaines.

Ko reikia programėlei

Duomenys

Du laukai atlieka daug darbo: savininkas (kas palaiko straipsnį tikslų) ir paskutinio peržiūros laikas (kada kas nors paskutinį kartą patvirtino, kad jis vis dar teisingas). Kartu jie leidžia išvardyti straipsnius, kurių niekas nepatikrino šešis mėnesius.

Puslapiai

• Skaitytojas: pagrindinis puslapis su paieška ir kategorijomis, kategorijų puslapiai, straipsnių puslapiai su turinio rodykle, susijusiais straipsniais ir klausimu „Ar tai buvo naudinga?“.
• Redaktorius: straipsnių sąrašas su filtrais (juodraščiai, pasenę, žemai įvertinti), redaktorius su peržiūra ir versijų istorija.
• Administratorius: kategorijos, naudotojai ir vaidmenys, bei ataskaitos apie paieškas be rezultatų.

Teisės

Skaitytojai mato paskelbtus straipsnius, kuriuos jiems leidžiama matyti. Redaktoriai kuria ir redaguoja straipsnius, galbūt tik tam tikrose kategorijose. Administratoriai skelbia, archyvuoja ir valdo naudotojus. Vidinei žinių bazei visiems reikia prisijungimo; viešam pagalbos centrui prisijungimo reikia tik rašytojams.

Sprendimai ir kompromisai

Redaktorius: Markdown ar turinio redaktorius

Markdown yra greitas, perkeliamas ir gerai veikia su versijų istorija, bet kai kuriems rašytojams jis atrodo nepatogus. Turinio redaktorius su antraštėmis, sąrašais, nuotraukomis, iškvietimais ir kodo blokais yra įprastas. Ką bepasirinktumėte, saugokite turinį formatu, kurį galėsite vėliau eksportuoti.

Paieška

Paprasta duomenų bazės teksto paieška pakanka keliems šimtams straipsnių, jei ieškote pavadinimuose, santraukose ir turinyje bei pavadinimų atitikimus rangote aukščiau. Daugiau straipsnių arba jei svarbios klaidos ir sinonimai („sąskaita“ ir „kvitas“), naudokite tinkamą pilno teksto paiešką arba talpinamą paieškos paslaugą. Mūsų gidas, kaip pridėti paiešką, aprašo variantus. Įrašykite kiekvieną užklausą, kuri negrąžina rezultatų: tai nemokamas sąrašas straipsnių, kuriuos reikia parašyti.

DI atsakymai

Klausimo lauke, kuris atsako iš jūsų straipsnių, dabar įprasta. Jis veikia išgaudamas svarbiausias ištraukas ir prašydamas kalbos modelio atsakyti tik iš jų – žr. kas yra RAG. Visada rodykite šaltinio straipsnius, leiskite atsakyti „nežinau“ ir prisiminkite, kad modelis užtikrintai pakartos bet ką pasenusio jūsų straipsniuose. Kurkite jį tada, kai straipsniai jau tvarkingi, o ne anksčiau.

Versijavimas ir peržiūra

Saugokite versijas, kad galėtumėte matyti, kas ką pakeitė, ir grąžinti atgal. Reguliuojamam turiniui (personalo politika, saugos procedūros) prieš paskelbiant pakeitimą pridėkite patvirtinimo žingsnį.

Pirmasis veikiantis užklausimas

Sukurkite viešą pagalbos centrą Parcelly – siuntų etikečių programėlei mažoms internetinėms parduotuvėms. Pagrindiniame puslapyje – didelis paieškos laukas ir šešios kategorijos (Pradžia, Etikečių spausdinimas, Vežėjai, Mokėjimai, Grąžinimai, Problemų sprendimas). Straipsniai turi pavadinimą, santrauką, turinį Markdown formatu su nuotraukomis ir iškvietimais, kategoriją, žymas, statusą (juodraštis, paskelbtas, archyvuotas), savininką ir paskutinės peržiūros datą. Straipsnių puslapiuose rodoma turinio rodyklė, susiję straipsniai ir klausimas „Ar tai buvo naudinga?“ su taip/ne ir pasirinktiniu komentaru. Paieška apima pavadinimus, santraukas ir turinį, pavadinimų atitikimai rodomi pirmi, ir kiekviena užklausa bei tai, ar ji grąžino rezultatus, įrašoma. Redaktoriaus sritis (reikia prisijungti, vaidmenys redaktorius ir administratorius) rodo juodraščius, straipsnius, neperžiūrėtus 180 dienų, ir straipsnius su žemais naudingumo įvertinimais, bei saugo versijų istoriją. Kiekvienas straipsnis turi savo puslapio pavadinimą ir meta aprašymą paieškos sistemoms. Švarus, ramus, skaitomas dizainas. Pirmiausia mobiliesiems.

Kūrimo žingsniai

1. Surašykite pirmus 20–30 straipsnių pagal tikrus klientų palaikymo klausimus prieš ką nors kurdami. Šis sąrašas nulemia kategorijas.
2. Sugeneruokite svetainę ir patikrinkite skaitymą telefone – eilutės ilgis, antraštės, nuotraukos.
3. Redaktorius ir vaidmenys. Rašytojai turi galėti pridėti ir taisyti straipsnius nesikreipdami į programuotoją.
4. Paieška, tada ją išbandykite su žodžiais, kuriuos vartoja klientai, įskaitant rašybos klaidas.
5. Atsiliepimai ir paieškos įrašymas.
6. Pasenusių straipsnių ataskaita pagal savininką ir paskutinės peržiūros datą.
7. SEO pagrindai viešai svetainei: unikalūs pavadinimai, aprašymai, švarūs URL, svetainės žemėlapis. Žr. SEO dirbtinio intelekto kuriamoms svetainėms.
8. Susiekite ją su savo produktu ir palaikymo atsakymais, tada kas savaitę stebėkite paieškos be rezultatų žurnalą.
9. DI atsakymai, kai turinys jau tvirtas.

Dažnos klaidos

• Organizavimas pagal skyrius vietoj to, ką skaitytojas bando padaryti.
• Ilgi straipsniai, apimantys penkias užduotis. Viena užduotis straipsnyje, su pavadinimu, kuris nurodo, ką jis išsprendžia.
• Nėra savininko kiekvienam straipsniui. Niekas nieko neatnaujina, o pasitikėjimas krenta po pirmo klaidingo atsakymo.
• Vidinės pastabos viešuose straipsniuose. Naudokite atskirą matomumą ir peržiūrėkite prieš skelbiant.
• Paieška, kuri atitinka tik pavadinimus. Skaitytojai įveda simptomus, o ne straipsnių pavadinimus.
• Ekrano nuotraukos be alt teksto ar konteksto. Jos greitai sensta; aprašykite žingsnį ir žodžiais.

Kada geresnis pasirinkimas – paruoštas produktas

Jei jūsų komanda jau dirba dokumentacijos ar vikio įrankyje, vidinė žinių bazė ten dažniausiai yra lengviausias kelias – mūsų Notion ir Confluence palyginimas aptaria du dažnus pasirinkimus. Jei naudojate pagalbos tarnybos produktą, jo integruotas pagalbos centras sieja straipsnius su bilietais ir siūlo straipsnius klientams, o tai sunku atkartoti. Dokumentacijos svetainių generatoriai tinka kūrėjų dokumentacijai, laikomai kartu su kodu.

Kurkite savo, kai reikia savos struktūros ar teisių (straipsniai pagal klientą, vietą ar vaidmenį), norite žinių bazę savo produkto viduje, o ne atskirai svetainėje, reikia peržiūros ir patvirtinimo žingsnių, kurių vikis nevaldo, arba norite DI atsakymų iš savo turinio be dar vienos prenumeratos. Tai puikiai dera su pasirinktine pagalbos tarnyba.

Kūrimas su Mythex

Mythex nuo pokalbio aprašote žinių bazę ir ji sukuriama tiesioginėje peržiūroje; straipsniai, versijos ir atsiliepimai saugomi Postgres duomenų bazėje, kurią agentas prideda, kai reikia, o nuotraukos patenka į projekto failų saugyklą. Redaktoriaus prisijungimui naudojamas jūsų pasirinktas autentifikavimo būdas, nes Mythex neturi įmontuoto galutinių naudotojų prisijungimo. DI atsakymams naudojate savo DI tiekėjo API raktą, saugomą kaip projekto paslaptį, o naudojimas apmokamas jūsų tiekėjo paskyroje, o ne Mythex kreditais (DI receptas). Nauji Mythex projektai pagal numatytuosius nustatymus yra kliento pusėje veikianti React programa, kuri paieškos sistemoms mažiau tinka, todėl viešam pagalbos centrui prašykite statinei struktūrai tinkamo arba serveryje generuojamo nustatymo, pavyzdžiui, Next.js (SEO receptas).

Pradiniam užklausimui išbandykite produktų žinių centro arba komandos dokumentų programėlės šablonus.

Klausimai