Kā izveidot zināšanu bāzi: raksti, meklēšana, tiesības un AI atbildes

Zināšanu bāze ir meklējama atbilžu bibliotēka: kā kaut ko izdarīt, kā kaut ko salabot, kāds ir noteikums. Lai to izveidotu, vajag rakstus, sagrupētus dažās skaidrās kategorijās, redaktoru, ko rakstītāji tiešām izmantos, meklēšanu, kas atrod pareizo rakstu pēc vārdiem, ko cilvēki patiešām ieraksta, un lēmumu par to, kas ko var lasīt — publika, pieteikušies klienti vai tikai darbinieki. AI lietotņu veidotājs var īsā sesijā izveidot struktūru, redaktoru un meklēšanu. Tas, kas padara zināšanu bāzi noderīgu, ir rakstīšana un uzturēšana, tāpēc jau no pirmās dienas projektējiet vieglu rediģēšanu un novecojušu rakstu atpazīšanu.

Vispirms izlemiet, kam tā paredzēta

Tās pašas funkcijas kalpo ļoti dažādām vietnēm:

• Publisks palīdzības centrs — klientiem un potenciālajiem klientiem. Jābūt ātram, indeksējamam meklētājprogrammās un rakstītam viņu valodā.
• Tikai klientu dokumentācija — aiz pieteikšanās, paredzēta maksājošiem klientiem vai partneriem.
• Iekšējā zināšanu bāze — politikas, procesi, instrukcijas darbiniekiem. Jābūt privātai; meklēšana un aktualitāte ir svarīgākas par dizainu.

Visbiežāk noplūdes rodas, kad publiski un iekšēji raksti ir vienā vietnē. Ja vajag abus, katram rakstam dodiet skaidru redzamības iestatījumu vai izveidojiet divas atsevišķas vietnes.

Ko lietotnei vajag

Dati

Divi lauki paveic lielu darbu: īpašnieks (kurš uztur rakstu precīzu) un pēdējo reizi pārskatīts (kad kāds pēdējo reizi apstiprināja, ka tas joprojām ir patiess). Kopā tie ļauj izveidot sarakstu ar rakstiem, ko neviens nav pārbaudījis sešus mēnešus.

Lapas

• Lasītājs: sākumlapa ar meklēšanu un kategorijām, kategoriju lapas, rakstu lapas ar satura rādītāju, saistītajiem rakstiem un jautājumu „Vai tas bija noderīgi?“.
• Redaktors: rakstu saraksts ar filtriem (melnraksti, novecojuši, zemi vērtēti), redaktors ar priekšskatījumu un versiju vēsture.
• Administrators: kategorijas, lietotāji un lomas, un atskaites par meklēšanām bez rezultātiem.

Tiesības

Lasītāji redz publicētus rakstus, ko drīkst redzēt. Redaktori veido un labo rakstus, iespējams, tikai noteiktās kategorijās. Administratori publicē, arhivē un pārvalda lietotājus. Iekšējai zināšanu bāzei visiem vajag pieteikšanos; publiskam palīdzības centram pieteikšanās vajag tikai rakstītājiem.

Lēmumi un kompromisi

Redaktors: Markdown vai bagātinātais teksts

Markdown ir ātrs, pārnesams un labi darbojas ar versiju vēsturi, taču daļai rakstītāju tas šķiet nepieejams. Bagātinātā teksta redaktors ar virsrakstiem, sarakstiem, attēliem, paziņojumu blokiem un koda blokiem šķiet pazīstams. Ko arī izvēlētos, glabājiet saturu formātā, ko vēlāk varēsiet eksportēt.

Meklēšana

Vienkārša datubāzes teksta meklēšana pietiek dažiem simtiem rakstu, ja meklējat virsrakstos, kopsavilkumos un saturā un virsrakstu atbilstības rangojat augstāk. Pēc tam, vai ja svarīgas ir kļūdas un sinonīmi (vārdi „rēķins“ un „čeks“), izmantojiet korektu pilnteksta meklēšanu vai hostētu meklēšanas pakalpojumu. Mūsu ceļvedis par meklēšanas pievienošanu izskaidro iespējas. Reģistrējiet katru vaicājumu, kas neko neatrod: tas ir bez maksas saraksts ar rakstiem, kas jāuzraksta.

AI atbildes

Kaste „uzdod jautājumu“, kas atbild no jūsu rakstiem, tagad ir izplatīta. Tā darbojas, atrodot vissvarīgākos fragmentus un liekot valodas modelim atbildēt tikai no tiem — skatiet kas ir RAG. Vienmēr rādiet avotu rakstus, ļaujiet atbildēt „nezinu“ un atcerieties, ka modelis pārliecinoši atkārtos jebko novecojušu jūsu rakstos. Veidojiet to pēc tam, kad raksti ir labā stāvoklī, nevis pirms tam.

Versijas un pārskatīšana

Glabājiet versijas, lai varētu redzēt, kas ko mainīja un atgriezt atpakaļ. Regulētam saturam (personāla politika, drošības procedūras) pievienojiet apstiprināšanas soli pirms izmaiņu publicēšanas.

Pirmais uzdevums, kas strādā

Izveido publisku palīdzības centru Parcelly, lietotnei sūtījumu etiķešu drukāšanai maziem tiešsaistes veikaliem. Sākumlapā liels meklēšanas lauks un sešas kategorijas (Sākt darbu, Etiķešu drukāšana, Pārvadātāji, Norēķini, Atgriešana, Problēmu risināšana). Rakstiem ir nosaukums, kopsavilkums, saturs Markdown formātā ar attēliem un paziņojumu blokiem, kategorija, tagi, statuss (melnraksts, publicēts, arhivēts), īpašnieks un pēdējās pārskatīšanas datums. Rakstu lapās ir satura rādītājs, saistītie raksti un „Vai tas bija noderīgi?“ jā/nē ar neobligātu komentāru. Meklēšana aptver nosaukumus, kopsavilkumus un saturu, un nosaukumu atbilstības ir augstāk; katrs vaicājums un tā rezultātu esamība tiek reģistrēta. Redaktoru zona (nepieciešama pieteikšanās, lomas redaktors un administrators) parāda melnrakstus, rakstus, kas nav pārskatīti 180 dienas, un rakstus ar zemiem noderīguma vērtējumiem, un saglabā versiju vēsturi. Katram rakstam ir savs lapas nosaukums un meta apraksts meklētājprogrammām. Tīrs, mierīgs, lasāms dizains. Vispirms mobilajām ierīcēm.

Būvēšanas soļi

1. Uzskaitiet pirmos 20–30 rakstus no reāliem atbalsta jautājumiem, pirms kaut ko veidojat. Šis saraksts veido kategorijas.
2. Izveidojiet vietni un pārbaudiet lasāmību tālrunī — rindu garums, virsraksti, attēli.
3. Redaktors un lomas. Rakstītājiem jāvar pievienot un labot rakstus, neprasot izstrādātājam.
4. Meklēšana, pēc tam pārbaudiet to ar vārdiem, ko klienti tiešām lieto, ieskaitot kļūdainu rakstību.
5. Atsauksmes un meklēšanas reģistrēšana.
6. Novecojušo rakstu atskaite pēc īpašnieka un pēdējās pārskatīšanas datuma.
7. SEO pamati publiskai vietnei: unikāli nosaukumi, apraksti, tīri URL, vietnes karte. Skatiet SEO AI veidotām vietnēm.
8. Saitiet to no sava produkta un atbalsta atbildēm, pēc tam katru nedēļu pārraugiet žurnālu ar vaicājumiem bez rezultātiem.
9. AI atbildes, kad saturs ir stabils.

Biežākās kļūdas

• Organizēšana pēc nodaļām, nevis pēc tā, ko lasītājs cenšas paveikt.
• Gari raksti, kas aptver piecus uzdevumus. Viens uzdevums katrā rakstā, ar nosaukumu, kas pasaka, ko tas risina.
• Nav īpašnieka katram rakstam. Neviens neko neatjauno, un uzticība krīt pēc pirmās nepareizās atbildes.
• Iekšējas piezīmes publiskos rakstos. Izmantojiet atsevišķu redzamību un pārskatiet pirms publicēšanas.
• Meklēšana, kas atbilst tikai nosaukumiem. Lasītāji ieraksta simptomus, nevis rakstu nosaukumus.
• Ekrānuzņēmumi bez alternatīvā teksta vai konteksta. Tie ātri noveco; aprakstiet soli arī vārdiem.

Kad gatavs produkts ir labāka izvēle

Ja jūsu komanda jau strādā dokumentāciju vai vikivietņu rīkā, iekšēja zināšanu bāze tur parasti ir vieglākais ceļš — mūsu Notion salīdzinājums ar Confluence aptver divas biežas izvēles. Ja izmantojat palīdzības dienesta produktu, tā iebūvētais palīdzības centrs saista rakstus ar pieteikumiem un ieteic rakstus klientiem, un to grūti atkārtot. Dokumentācijas vietņu ģeneratori ir ideāli izstrādātāju dokumentācijai, kas glabājas blakus kodam.

Veidojiet savu, kad vajag savu struktūru vai tiesības (raksti pa klientiem, pa atrašanās vietām, pa lomām), vēlaties zināšanu bāzi savā produktā, nevis atsevišķā vietnē, vajag pārskatīšanas un apstiprināšanas soļus, ko vikivietne neievieš, vai vēlaties AI atbildes pār savu saturu bez cita abonementa. Tā dabiski sader ar pielāgotu palīdzības dienestu.

Zināšanu bāzes veidošana ar Mythex

Mythex jūs aprakstāt zināšanu bāzi tērzēšanā, un tā tiek izveidota tiešajā priekšskatījumā; rakstus, versijas un atsauksmes glabā Postgres datubāzē, ko aģents pievieno, kad vajag, un attēli nonāk projekta failu krātuvē. Redaktoru pieteikšanās izmanto autentifikācijas pieeju, ko izvēlaties jūs, jo Mythex nenodrošina iebūvētu lietotāju pieteikšanos. AI atbildēm izmantojat sava AI nodrošinātāja API atslēgu, kas glabājas kā projekta noslēpums, un izmantošana tiek norēķināta jūsu nodrošinātāja kontā, nevis Mythex kredītos (AI recepte). Jaunās Mythex lietotnes pēc noklusējuma ir klienta pusē renderēta React vienas lapas lietotne, kas meklētājprogrammām ir vājāka, tāpēc publiskam palīdzības centram lūdziet statisku vai serverī renderētu iestatījumu, piemēram, Next.js (SEO recepte).

Sākuma uzvednei izmēģiniet produktu zināšanu centra vai komandas dokumentāciju lietotnes sagataves.

Jautājumi