Dokumentáció | Yaplet HU

Áttekintés

A Dokumentáció funkció lehetővé teszi teljes műszaki dokumentációs oldalak felépítését — API referenciák, fejlesztői útmutatók, termék kézikönyvek — és ezek publikálását márkázott nyilvános oldalakként a widgeteiden keresztül. A tartalom háromszintű hierarchiába van rendezve: dokumentációk tartalmaznak kategóriákat, amelyek oldalakat tartalmaznak beágyazott aloldalakkal.

Hierarchikus struktúra — Rendszerezd a tartalmat dokumentációkba, kategóriákba és beágyazott oldalakba az áttekinthető navigációhoz.

Markdown szerkesztő — Írj osztott paneles felületen, amely fastruktúra nézetet kínál a navigációhoz és gazdag markdown szerkesztőt komponensekkel.

AI segítség — Generálj, folytass vagy javíts dokumentációs tartalmat beépített AI eszközökkel.

Nyilvános megosztás — Publikálj dokumentációt csatlakoztatott widgeteken keresztül márkázott nyilvános oldalakkal.

Hogyan működik

A Dokumentáció oldalon egy táblázat listázza az összes dokumentációdat a címükkel, oldalszámukkal és nyelvükkel. Kattints az Új dokumentáció gombra egy új létrehozásához, majd adj hozzá kategóriákat és oldalakat.

Dokumentáció létrehozása

Kattints az "Új dokumentáció" gombra egy új dokumentáció konténer létrehozásához. Konfiguráld a címét, nyelvét és arculatát a beállításokban.

Kategóriák hozzáadása

Egy dokumentáción belül hozz létre kategóriákat a kapcsolódó oldalak csoportosításához. A kategóriák navigációs lapfülekként jelennek meg a nyilvános oldalon.

Oldalak írása

Válassz ki egy kategóriát az osztott paneles szerkesztő megnyitásához. Használd a fastruktúra nézetet az oldalhierarchia kezeléséhez és a markdown szerkesztőt a tartalom írásához.

Widget csatlakoztatása

Csatold a dokumentációdat egy vagy több widgethez a widget beállításokban. Ez lehetővé teszi a nyilvános hozzáférést a widget márkázott URL-jén keresztül.

Publikálás

Kapcsold a kategóriákat és oldalakat "Publikált" állapotba, hogy nyilvánosan elérhetővé tedd őket és az AI tudásbázisba is bekerüljenek.

Csatlakoztasd a dokumentációdat widgetekhez a nyilvános megosztás engedélyezéséhez. Minden widget különböző nyilvános URL-t és vizuális témát biztosít a dokumentációdhoz.

A létrehozható dokumentációs oldalak száma a csomagodtól függ. Ha eléred a csomagod oldalkorlátját, magasabb csomagra kell váltanod a további létrehozáshoz.

Útmutatók

Dokumentációk és kategóriák

Ismerkedj meg a dokumentációk, kategóriák és oldalak hierarchikus struktúrájával, beleértve a konfigurációs lehetőségeket, publikálási vezérlőket és widget kapcsolatokat.

Dokumentáció építése

Fedezd fel az osztott paneles szerkesztő felületet dokumentációs tartalom létrehozásához és rendszerezéséhez haladó markdown szerkesztéssel és AI segédeszközökkel.

Megosztás

Tudd meg, hogyan generálhatsz nyilvános linkeket a dokumentációs oldalaidhoz, beleértve a közvetlen (SEO-barát) és fix (állandó) linktípusokat.

Dokumentáció vs Tudásbázis

A Yaplet két különálló tartalomkészítő funkciót kínál — Dokumentáció és Tudásbázis — amelyek különböző célokat és közönségeket szolgálnak. A különbségeik megértése segít kiválasztani a megfelelő eszközt a tartalomstratégiádhoz.

Dokumentáció

Cél: Műszaki dokumentáció strukturált, fejlesztőknek szánt tartalommal

Tartalom stílus: Merev, formázott műszaki részletek markdown komponensekkel

Szerkesztő: Markdown cikkszerkesztő előre elkészített komponensekkel és AI segítséggel

Hozzáférési csatornák: Csak dedikált nyilvános oldalakon érhető el

Leginkább alkalmas: API referenciák, műszaki specifikációk, fejlesztői útmutatók, strukturált kézikönyvek

Tudásbázis (Súgó központ)

Cél: Ügyfélnek szánt súgó cikkek beszélgetős, könnyen érthető tartalommal

Tartalom stílus: Szövegalapú, mondatalapú súgó rugalmas HTML szerkesztéssel

Szerkesztő: HTML cikkszerkesztő gazdag szövegformázáshoz

Hozzáférési csatornák: Elérhető chat widgetekben ÉS dedikált nyilvános oldalakon

Leginkább alkalmas: Ügyfélszolgálat, GYIK, hibaelhárítási útmutatók, termék bemutatók

Mikor használd a Dokumentációt

Válaszd a Dokumentációt, ha a közönséged műszaki felhasználók, akiknek részletes, strukturált információra van szükségük API-król, konfigurációkról vagy műszaki implementációkról.

API dokumentáció: Műszaki specifikációk, végpontok és kódpéldák
Fejlesztői útmutatók: Integrációs utasítások, SDK dokumentáció, műszaki munkafolyamatok
Rendszerkonfigurációk: Részletes beállítási és konfigurációs eljárások
Műszaki specifikációk: Merev, komponens-alapú tartalom, amely precíz formázást igényel

Mikor használd a Tudásbázist

Válaszd a Tudásbázist, ha az elsődleges közönséged végfelhasználók, akiknek gyors válaszokra van szükségük gyakori kérdésekre és gyakorlati útmutatásra.

Ügyfélszolgálati helyzetek: "Hogyan állíthatom vissza a jelszavamat?" vagy "Hogyan frissíthetem a csomagomat?"
Termék bemutatók: Lépésről lépésre útmutatók a termékfunkciók használatához
Hibaelhárítási cikkek: Gyakori problémák és megoldások beszélgetős nyelvezettel
GYIK stílusú tartalom: Amikor azt szeretnéd, hogy a tartalom közvetlenül elérhető legyen a chat beszélgetésekben

Kulcsfontosságú döntési tényezők

Dokumentáció: Fejlesztők, műszaki csapatok, rendszeradminisztrátorok
Tudásbázis: Általános ügyfelek, végfelhasználók, nem műszaki közönség

Pro tipp: Sok szervezet mindkét funkciót együtt használja — a Dokumentációt műszaki erőforrásokhoz és a Tudásbázist ügyfélszolgálathoz. Linkelhetnek egymás között egy átfogó tartalom ökoszisztéma létrehozásához.

Tudj meg többet a Tudásbázis funkcióról, hogy megértsd, mikor lehet jobb választás az ügyfélnek szánt tartalmaid számára.

Automatizálás AI-val: Dokumentációs portálokat is létrehozhatsz, kategóriákat és oldalakat rendezhetsz, és tartalmat publikálhatsz a Copilot segítségével vagy bármely MCP-kompatibilis klienssel. Próbáld ki: "Hozz létre egy dokumentációs portált Developer Docs néven" vagy "Generálj egy API referencia oldalt AI-val". Lásd a Súgó eszközök referenciát az összes elérhető művelethez.