Jak vytvořit znalostní bázi: články, vyhledávání, oprávnění a odpovědi od AI

Znalostní báze je prohledávatelná knihovna odpovědí: jak něco udělat, jak něco opravit, jaké je pravidlo. Abyste ji vytvořili, potřebujete články seskupené do několika jasných kategorií, editor, který vaši autoři skutečně použijí, vyhledávání, které najde správný článek podle slov, která lidé opravdu píšou, a rozhodnutí, kdo co smí číst – veřejnost, přihlášení zákazníci, nebo jen zaměstnanci. Nástroj pro tvorbu aplikací s AI dokáže strukturu, editor i vyhledávání připravit v krátké relaci. Užitečnou ji ale dělá psaní a údržba, proto navrhujte snadnou úpravu a odhalování zastaralých článků hned od začátku.

Nejdřív rozhodněte, pro koho je

Stejné funkce slouží velmi odlišným webům:

• Veřejné centrum nápovědy – pro zákazníky a zájemce. Musí být rychlé, indexovatelné vyhledávači a psané jejich jazykem.
• Dokumentace jen pro zákazníky – za přihlášením, pro platící zákazníky nebo partnery.
• Interní znalostní báze – zásady, postupy, návody pro zaměstnance. Musí být soukromá; na vyhledávání a aktuálnosti záleží víc než na designu.

Směs veřejných a interních článků na jednom webu je nejčastější zdroj úniků. Potřebujete-li obojí, nastavte každému článku jasnou viditelnost, nebo provozujte dva oddělené weby.

Co aplikace potřebuje

Data

Dvě pole odvedou hodně práce: vlastník (kdo článek udržuje přesný) a naposledy zkontrolováno (kdy někdo naposledy potvrdil, že je stále pravdivý). Společně umožní vypsat články, které nikdo šest měsíců nekontroloval.

Stránky

• Čtenář: domovská stránka s vyhledáváním a kategoriemi, stránky kategorií, stránky článků s obsahem, souvisejícími články a výzvou „Bylo to nápomocné?“.
• Editor: seznam článků s filtry (koncepty, zastaralé, s nízkým hodnocením), editor s náhledem a historie revizí.
• Administrace: kategorie, uživatelé a role, a přehledy hledání bez výsledků.

Oprávnění

Čtenáři vidí publikované články, které smějí vidět. Editoři vytvářejí a upravují články, případně jen v určitých kategoriích. Administrátoři publikují, archivují a spravují uživatele. U interní znalostní báze potřebuje přihlášení každý; u veřejného centra nápovědy jen autoři.

Rozhodnutí a kompromisy

Editor: Markdown, nebo formátovaný text

Markdown je rychlý, přenositelný a dobře funguje s historií verzí, ale některým autorům připadá odpudivý. Editor formátovaného textu s nadpisy, seznamy, obrázky, upozorněními a bloky kódu působí povědomě. Ať zvolíte cokoli, ukládejte obsah ve formátu, který půjde později exportovat.

Vyhledávání

Základní textové vyhledávání v databázi stačí pro několik stovek článků, pokud hledáte v názvech, shrnutích i textech a shody v názvu řadíte výš. Nad to, nebo pokud záleží na překlepech a synonymech ("faktura" vs. "účet"), použijte kvalitní fulltextové vyhledávání nebo hostovanou vyhledávací službu. Náš průvodce přidáním vyhledávání prochází možnosti. Zaznamenávejte každý dotaz, který nic nevrátí: je to bezplatný seznam článků, které je potřeba napsat.

Odpovědi od AI

Box „zeptejte se“, který odpovídá z vašich článků, je dnes běžný. Funguje tak, že vyhledá nejrelevantnější pasáže a požádá jazykový model, aby odpovídal jen z nich – viz co je RAG. Vždy ukazujte zdrojové články, povolte odpověď „nevím“ a pamatujte, že model si sebejistě zopakuje cokoli zastaralého, co je ve vašich článcích. Stavte to až ve chvíli, kdy jsou články v dobrém stavu, ne dřív.

Verze a kontrola

Uchovávejte revize, abyste viděli, kdo co změnil, a mohli se vrátit. U regulovaného obsahu (personální předpisy, bezpečnostní postupy) přidejte před publikací změny krok schválení.

První zadání, které funguje

Vytvoř veřejné centrum nápovědy pro Parcelly, aplikaci na tisk štítků pro malé e-shopy s odesíláním. Domovská stránka s velkým vyhledávacím polem a šesti kategoriemi (Začínáme, Tisk štítků, Dopravci, Fakturace, Vrácení zboží, Řešení problémů). Články mají název, shrnutí, text v Markdownu s obrázky a upozorněními, kategorii, štítky, stav (koncept, publikováno, archivováno), vlastníka a datum poslední kontroly. Stránky článků ukazují obsah, související články a otázku „Bylo to nápomocné?“ ano/ne s volitelným komentářem. Vyhledávání pokrývá názvy, shrnutí i texty, shody v názvu jsou řazeny první, a každý dotaz se zaznamená včetně toho, zda vrátil výsledky. Oblast editoru (vyžaduje přihlášení, role editor a administrátor) vypisuje koncepty, články nekontrolované 180 dní a články s nízkým hodnocením, a uchovává historii revizí. Každý článek má vlastní titulek stránky a meta popis pro vyhledávače. Čistý, klidný a dobře čitelný design. Nejdřív pro mobil.

Kroky stavby

1. Sepište prvních 20–30 článků podle skutečných dotazů na podporu, dřív než začnete stavět. Tento seznam určí kategorie.
2. Vygenerujte web a zkontrolujte čtení na telefonu – délku řádků, nadpisy, obrázky.
3. Editor a role. Autoři musí přidávat a opravovat články bez žádosti o pomoc vývojáře.
4. Vyhledávání a jeho test se slovy, která zákazníci skutečně používají, včetně překlepů.
5. Zpětná vazba a záznam hledání.
6. Přehled zastaralých článků podle vlastníka a data poslední kontroly.
7. Základy SEO pro veřejný web: jedinečné titulky, popisy, čisté URL, mapa stránek. Viz SEO pro weby vytvořené s AI.
8. Odkažte ji z produktu a z odpovědí podpory, pak každý týden sledujte záznam dotazů bez výsledků.
9. Odpovědi od AI, jakmile je obsah pevný.

Časté chyby

• Řazení podle oddělení místo podle toho, co čtenář chce udělat.
• Dlouhé články pokrývající pět úkolů. Jeden úkol na článek, s názvem, který říká, co řeší.
• Žádný vlastník u článku. Nikdo nic neaktualizuje a důvěra klesne po první špatné odpovědi.
• Interní poznámky ve veřejných článcích. Používejte oddělenou viditelnost a před publikací kontrolujte.
• Vyhledávání, které hledá jen v názvech. Čtenáři píší příznaky, ne názvy článků.
• Snímky obrazovky bez alternativního textu nebo kontextu. Rychle zastarávají; popište krok i slovy.

Kdy je lepší hotový produkt

Pokud váš tým už pracuje v nástroji pro dokumentaci nebo wiki, je interní znalostní báze tam obvykle nejsnazší cestou – naše porovnání Notion a Confluence pokrývá dvě běžné volby. Pokud používáte helpdesk, jeho vestavěné centrum nápovědy propojuje články s tikety a navrhuje články zákazníkům, což se těžko napodobuje. Generátory dokumentačních webů jsou ideální pro vývojářskou dokumentaci vedenou vedle kódu.

Vlastní stavbu zvolte, když potřebujete vlastní strukturu nebo oprávnění (články pro každého klienta, pobočku nebo roli), chcete znalostní bázi uvnitř produktu místo na samostatném webu, potřebujete kroky kontroly a schválení, které wiki nevynucuje, nebo chcete odpovědi od AI nad svým obsahem bez dalšího předplatného. Přirozeně se hodí k vlastnímu helpdesku.

Stavba s Mythexem

V Mythexu popíšete znalostní bázi v chatu a vznikne v živém náhledu; články, revize a zpětná vazba se ukládají do databáze Postgres, kterou agent přidá podle potřeby, a obrázky jdou do úložiště souborů projektu. Přihlášení editorů používá přístup k ověřování, který si zvolíte, protože Mythex nemá vestavěné přihlašování koncových uživatelů. Pro odpovědi od AI používáte API klíč vašeho poskytovatele AI uložený jako tajný údaj projektu a využití se účtuje u vašeho poskytovatele, ne v kreditech Mythexu (recept pro AI). Nové aplikace v Mythexu jsou výchozně jednostránkové aplikace v Reactu vykreslované v prohlížeči, což je pro vyhledávače slabší, takže u veřejného centra nápovědy si vyžádejte nastavení vhodné pro statický web nebo vykreslování na serveru, například Next.js (recept pro SEO).

Za výchozí zadání zkuste šablony znalostní centrum produktu nebo aplikace pro týmovou dokumentaci.

Otázky