Kuidas luua teadmusbaasi: artiklid, otsing, õigused ja AI-vastused

Teadmusbaas on otsitav raamatukogu vastustest: kuidas midagi teha, kuidas midagi parandada, mis on reegel. Selle loomiseks vajad artikleid, mis on grupeeritud mõne selge kategooriasse, redaktorit, mida su kirjutajad tegelikult kasutavad, otsingut, mis leiab õige artikli inimeste tegelikult kirjutatud sõnade järgi, ning otsust, kes mida lugeda võib — avalik, sisselogitud kliendid või ainult töötajad. AI-ehitaja suudab struktuuri, redaktori ja otsingu luua lühikese seansiga. Teadmusbaasi kasulikkuse teeb aga sisu ja hooldus, seega kujunda kohe esimesest päevast lihtsa muutmise ja aegunud artiklite märkamise jaoks.

Otsusta esmalt, kellele see on

Sama funktsioonid teenindavad väga erinevaid saite:

• Avalik abikeskus — klientidele ja huvilistele. Peab olema kiire, otsingumootoritele indekseeritav ja kirjutatud nende sõnadega.
• Ainult klientidele mõeldud dokumentatsioon — sisselogimise taga, maksvatele klientidele või partneritele.
• Sisemine teadmusbaas — töötajate poliitikad, protsessid, juhendid. Peab olema privaatne; otsing ja värskus on olulisemad kui kujundus.

Avaliku ja sisemise sisu segamine ühel saidil on koht, kus enamik lekkeid juhtub. Kui vajad mõlemat, anna igale artiklile selge nähtavuse seade või käita kahte eraldi saiti.

Mida rakendus vajab

Andmed

Kaks välja teevad palju tööd: omanik (kes hoiab selle artikli täpsena) ja viimati üle vaadatud (millal keegi viimati kinnitas, et see on ikka tõene). Koos võimaldavad need leida artikleid, mida keegi pole kuue kuu jooksul kontrollinud.

Lehed

• Lugeja: avaleht otsinguga ja kategooriatega, kategooria lehed, artikli lehed sisukorra, seotud artiklite ja küsimusega „Kas see aitas?“.
• Redaktor: artiklite nimekiri filtritega (mustandid, aegunud, madalate hinnangutega), redaktor eelvaatega ning versioonide ajalugu.
• Administraator: kategooriad, kasutajad ja rollid ning aruanded otsingute kohta, mis ei andnud tulemusi.

Õigused

Lugejad näevad avaldatud artikleid, mida neil on lubatud näha. Redaktorid loovad ja muudavad artikleid, võib-olla piiratud kindlatesse kategooriatesse. Administraatorid avaldavad, arhiveerivad ja haldavad kasutajaid. Sisemise teadmusbaasi jaoks peab igaühel olema sisselogimine; avaliku abikeskuse puhul vajavad sisselogimist ainult kirjutajad.

Otsused ja kompromissid

Redaktor: Markdown või rikastatud tekst

Markdown on kiire, kaasaskantav ja sobib hästi versioonide ajalooga, kuid mõned kirjutajad seda ei armasta. Rikastatud teksti redaktor koos pealkirjade, loendite, piltide, hoiatuskastide ja koodiplokkidega tundub tuttav. Mida ka valid, salvesta sisu vormingus, mida saad hiljem eksportida.

Otsing

Lihtne andmebaasi tekstiotsing piisab mõnele sajale artiklile, kui otsid pealkirjades, kokkuvõtetes ja sisus ning seab pealkirjade vasted kõrgemale. Sellest suuremal hulgal või siis, kui vead ja sünonüümid on olulised ("arve" vs "makse"), kasuta korralikku täistekstiotsingut või hostitud otsinguteenust. Meie otsingu lisamise juhend käib läbi võimalused. Logi iga päring, mis ei anna tulemusi: see on tasuta nimekiri artiklitest, mida tuleb kirjutada.

AI-vastused

Kast „Küsi küsimus“, mis vastab sinu artiklite põhjal, on nüüd tavaline. See töötab nii, et leiab kõige asjakohasemad lõigud ja palub keelemudelil vastata ainult nende põhjal — vaata mis on RAG. Näita alati allikaartikleid, luba vastus „Ma ei tea“ ning pea meeles, et see kordab kindlalt kõike, mis su artiklites on aegunud. Ehita see alles siis, kui artiklid on heas korras, mitte enne.

Versioonimine ja ülevaatus

Hoia versioone, et näha, kes mida muutis, ja saaks tagasi pöörata. Reguleeritud sisu puhul (personalipoliitika, ohutusprotseduurid) lisa enne muudatuse avaldamist kinnitamise samm.

Esimene töötav juhis

Ehita Parcelly avalik abikeskus, väike sildilaaduse rakendus väikestele veebipoodidele. Avaleht suure otsingukastiga ja kuue kategooriaga (Alustamine, Siltide printimine, Kullerfirmad, Arveldus, Tagastused, Tõrkeotsing). Artiklitel on pealkiri, kokkuvõte, sisu Markdownis piltide ja hoiatuskastidega, kategooria, sildid, staatus (mustand, avaldatud, arhiveeritud), omanik ja viimase ülevaatuse kuupäev. Artiklite lehed näitavad sisukorda, seotud artikleid ning küsimust „Kas see aitas?“ jah/ei ja valikulise kommentaariga. Otsing katab pealkirju, kokkuvõtteid ja sisu, pealkirjade vasted on kõige ees, ning see logib iga päringu ja selle, kas sellel oli tulemusi. Toimetaja ala (nõuab sisselogimist, rollid toimetaja ja administraator) loetleb mustandid, artiklid, mida pole 180 päeva üle vaadatud, ja artiklid madalate abistavuse hinnangutega, ning hoiab versioonide ajalugu. Igal artiklil on oma lehe pealkiri ja meta-kirjeldus otsingumootoritele. Puhas, rahulik, loetav kujundus. Mobiili esimesena.

Ehitusetapid

1. Koosta esimesed 20–30 artiklit päris toe küsimustest, enne kui ehitad midagi. See nimekiri kujundab kategooriad.
2. Genereeri sait ja kontrolli lugemist telefonis — rea pikkus, pealkirjad, pildid.
3. Redaktor ja rollid. Kirjutajad peavad saama artikleid lisada ja parandada ilma arendajalt küsimata.
4. Otsing, seejärel testi seda sõnadega, mida kliendid tegelikult kasutavad, sealhulgas kirjavigadega.
5. Tagasiside ja otsingu logimine.
6. Aegunud artiklite aruanne omaniku ja viimase ülevaatuse kuupäeva põhjal.
7. SEO põhitõed avalikule saidile: ainulaadsed pealkirjad, kirjeldused, puhtad URL-id, saidikaart. Vaata AI-ga ehitatud veebilehtede SEO-d.
8. Lingi see oma tootest ja toe vastustest, seejärel jälgi iganädalaselt tulemusteta päringute logi.
9. AI-vastused, kui sisu on kindel.

Levinud vead

• Korraldamine osakondade järgi lugeja eesmärgi asemel.
• Pikad artiklid, mis katavad viit ülesannet. Üks ülesanne artikli kohta, pealkiri, mis ütleb, mida see lahendab.
• Artiklil pole omanikku. Keegi ei uuenda midagi ning usaldus langeb pärast esimest valet vastust.
• Sisemised märkmed avalikes artiklites. Kasuta eraldi nähtavust ja vaata enne avaldamist üle.
• Otsing, mis sobitub ainult pealkirjadega. Lugejad kirjutavad sümptomeid, mitte artiklite nimesid.
• Ekraanipildid ilma alt-tekstita või kontekstita. Need vananevad kiiresti; kirjelda samm ka sõnadega.

Millal on valmislahendus parem valik

Kui sinu meeskond töötab juba dokumentatsiooni- või vikitööriistas, on sisemine teadmusbaas seal tavaliselt kõige lihtsam tee — meie Notioni ja Confluence'i võrdlus käsitleb kahte levinud valikut. Kui kasutad abipileti tarkvara, seob selle sisseehitatud abikeskus artiklid piletitega ja soovitab artikleid klientidele, mida on raske ise järele teha. Dokumentatsioonisaitide generaatorid sobivad ideaalselt arendajate dokumentatsioonile, mis elab koodi kõrval.

Ehita oma, kui vajad oma struktuuri või õigusi (artiklid kliendi, asukoha või rolli kaupa), tahad teadmusbaasi oma toote sees, mitte eraldi saidil, vajad ülevaatuse ja kinnitamise samme, mida wiki ei jõusta, või tahad AI-vastuseid oma sisu peal ilma teise tellimuseta. See sobib loomulikult kokku kohandatud abipileti süsteemiga.

Ehitamine Mythexis

Mythexis kirjeldad teadmusbaasi vestluses ja see ehitatakse reaalajas eelvaates; artikleid, versioone ja tagasisidet hoitakse Postgres-andmebaasis, mille agent lisab vajadusel, ning pildid lähevad projekti failihoidlasse. Redaktori sisselogimised kasutavad sinu valitud autentimise lahendust, sest Mythexil pole sisseehitatud lõppkasutaja sisselogimist. AI-vastuste jaoks kasutad oma AI-teenuse pakkuja API-võtit, mis hoitakse projekti saladusena, ning kasutus arvestatakse sinu pakkuja kontol, mitte Mythexi krediitidena (AI retsept). Uued Mythexi rakendused vaikimisi on kliendipoolne React-ühelehe rakendus, mis on otsingumootorite jaoks nõrgem, seega avaliku abikeskuse puhul palu staatilisele või serveris renderdatavale seadistusele, näiteks Next.js-ile (SEO retsept).

Algusjuhise jaoks proovi malle toote teadmuskeskus või tiimi dokumentatsioonirakendus.

Küsimused