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

Dokumentációk

A dokumentációk a legfelső szintű konténerek, amelyek a teljes tudásbázisodat vagy felhasználói kézikönyvedet tartalmazzák. Minden dokumentáció egy teljes információs csomagot képvisel, amelyet nyilvánosan megoszthatók a csatlakoztatott widgeteken keresztül.

Dokumentáció beállítások

Minden dokumentáció számos konfigurálható beállítással rendelkezik:

Alapadatok:

Cím - A dokumentáció neve
Nyelv - A tartalom elsődleges nyelve

Arculat:

Világos mód logó - Logó a világos módú megjelenítéshez
Sötét mód logó - Logó a sötét módú megjelenítéshez

Widget kapcsolatok: A dokumentációknak widgetekhez kell csatlakozniuk a nyilvános elérhetőséghez. Minden widget különböző nyilvános URL-t és vizuális témát biztosít.

Egy dokumentációnak legalább egy widget kapcsolatra van szüksége a nyilvános elérhetőséghez. Widgetek nélkül a megosztás le lesz tiltva.

Kategóriák

A kategóriák logikai csoportokba rendezik a dokumentációs oldalakat egy dokumentáción belül. Navigációs struktúrát biztosítanak, és segítenek a felhasználóknak gyorsan megtalálni a releváns információkat.

Kategória beállítások

A kategóriák egyszerű beállításokkal rendelkeznek:

Név - A kategória megjelenítési neve
Leírás - Rövid leírás a kategória listázásokhoz

Kategória kezelés

A kategóriák súly szerint vannak rendezve, ami meghatározza a megjelenítési sorrendjüket. Használd a fel/le nyilakat a kategóriák átrendezéséhez.

Az alacsonyabb súlyszámú kategóriák jelennek meg először. Tervezd meg a kategória sorrendet a felhasználói elvárásoknak megfelelően.

Publikálás és láthatóság

A dokumentációs tartalom publikálható vagy visszavonható mind kategória, mind oldal szinten, így finom kontrollt biztosít afelett, hogy milyen tartalom érhető el nyilvánosan és az AI tudásbázisban.

Kategória publikálás

A kategóriák publikálhatók vagy visszavonhatók a beállítások oldalukon. Amikor egy kategória nincs publikálva:

A kategórián belüli összes oldal elérhetetlenné válik az AI feldolgozás számára
A kategória eltűnik a nyilvános dokumentáció navigációjából
A gyermek oldalak nem publikáltak maradnak, még ha a kategóriát később újra publikálod is

Egy kategória visszavonása automatikusan visszavonja az összes gyermek oldalt és eltávolítja őket az AI tudásbázisból. Egy kategória újbóli publikálása nem publikálja automatikusan az oldalait.

Oldal publikálás

Az egyes oldalak függetlenül publikálhatók vagy visszavonhatók, a következő hatásokkal:

Publikált oldalak: Elérhetők a nyilvános dokumentációban és feldolgozásra kerülnek az AI tudásbázis számára
Nem publikált oldalak: Rejtettek a nyilvános nézetből és kizártak az AI feldolgozásból
Szülő oldal függőség: Egy oldal nem publikálható, ha a szülő oldala nincs publikálva

Használd az állapotjelzőket (zöld pontok a publikáltakhoz, piros pontok a piszkozatokhoz, sárga pontok a publikált oldalakhoz nem publikált gyermekekkel) a hierarchia fában és a kategória fejlécben a tartalmad publikálási állapotának gyors áttekintéséhez.

Tömeges publikálás

Nagy dokumentációs fák kezelésekor egyszerre több oldalt is publikálhatsz vagy visszavonhatsz:

Szülő oldal menüjéből: Használd az "Összes gyermek publikálása" vagy "Összes gyermek visszavonása" opciót bármely gyermek oldalakkal rendelkező oldal hárompontos kontextus menüjében. Az "Összes gyermek publikálása" opció csak akkor érhető el, ha maga a szülő oldal már publikálva van.
Kategória fejlécből: Kattints a hárompontos menüre a kategória neve mellett az "Összes oldal publikálása" vagy "Összes oldal visszavonása" eléréséhez a kategória összes oldalára. Az "Összes oldal publikálása" megköveteli, hogy a kategória előbb publikálva legyen.
Szülő publikálásakor: Miután publikálsz egy oldalt, amelynek nem publikált gyermekei vannak, felkínálásra kerül a gyermekek opcionális publikálása is.

Amikor a céloldalak bármelyikének saját beágyazott gyermekei vannak, választhatsz a csak közvetlen gyermekek vagy összes beágyazott gyermek (beleértve az unokákat és mélyebb szinteket) publikálása között.

A tömeges publikálás csak a jelenleg nem publikált oldalakat érinti (és fordítva a tömeges visszavonásnál). A már célállapotban lévő oldalak kihagyásra kerülnek. Csak az újonnan módosított oldalak kerülnek feldolgozásra az AI tudásbázis számára, így a művelet hatékony marad.

AI tudásbázis integráció

Csak a publikált kategóriákban lévő publikált oldalak kerülnek feldolgozásra az AI tudásbázis számára:

A tartalom publikálása automatikusan hozzáadja az AI tudásbázishoz (a feldolgozás egy pillanatot vehet igénybe)
A tartalom visszavonása azonnal eltávolítja az AI tudásbázisból
A rendszer megakadályozza oldalak publikálását nem publikált kategóriákban

A tartalom csak a publikálás után jelenik meg a chat widgetekben és AI válaszokban. Használd a publikálás kapcsolót az új vagy frissített dokumentáció elérhetővé tételének szabályozásához az AI asszisztensed számára.

Nyilvános dokumentáció viselkedés

A publikált tartalom a következő szabályokat követi a nyilvános dokumentációban:

Csak a publikált kategóriák jelennek meg a navigációs sávban
Csak a publikált oldalak érhetők el nyilvános linkeken keresztül
A nem publikált tartalom teljesen rejtett a külső felhasználók elől
A nem publikált tartalomhoz tartozó megosztási linkek nem működnek

Nyilvános dokumentáció navigáció

Amikor a dokumentáció nyilvánosan publikálva van, a kategóriák navigációs sávként jelennek meg a fejléc alatt, ha több kategória van.

A kategóriák navigációs sávként jelennek meg a fejléc alatt, ha több kategória van egy dokumentációban.

A nyilvános dokumentációs felületről további részletekért lásd a nyilvános dokumentáció útmutatónkat.

Ha egy dokumentáció csak egy kategóriát tartalmaz, a navigációs sáv el van rejtve a tisztább olvasási élmény érdekében.

A kategória nevek vagy struktúra módosítása elronthatja a meglévő megosztási linkeket. Fontold meg a hatást, mielőtt jelentős változtatásokat végzel.