Dokumentáció építése
A dokumentáció szerkesztő osztott paneles felületet biztosít a dokumentációs oldalak kezeléséhez és szerkesztéséhez, hierarchikus fastruktúra nézettel a bal oldalon és tartalom szerkesztővel a jobb oldalon.
Elrendezés áttekintés
A dokumentáció szerkesztő két fő panelből áll, amelyek együtt dolgoznak az átfogó szerkesztési élmény biztosításához:
Bal panel: Dokumentáció hierarchia
A bal panel fastruktúrát jelenít meg, amely az összes dokumentációs oldalt mutatja hierarchikusan rendezve.
Navigációs funkciók:
- Kategória fejléc az aktuális kategória nevével, állapotjelzővel és hárompontos menüvel kategória szintű műveletekhez (keresés, összes oldal publikálása, összes oldal visszavonása)
- Fókusz gomb az aktuálisan kiválasztott oldalhoz vezető útvonal kibontásához
- Összecsukás gomb az összes kibontott facsomópont összecsukásához
Fastruktúra:
- Gyökér oldalak a legfelső szinten jelennek meg
- Gyermek oldalak a szülő oldalak alá vannak beágyazva
Oldal kezelés:
- Gyermek oldalak hozzáadása a kibontott szülő oldalak alatt megjelenő "+" gombokkal
- Oldalak átrendezése az oldal menüben lévő fel/le nyilakkal
- Oldalak törlése a gyermek oldalak kezelésének opciójával (összes törlése vagy gyermekek feljebb mozgatása)
- Gyökér oldalak hozzáadása a fa alján lévő gombbal
1. lépés: Navigálj a kategóriához
Válassz ki egy dokumentáció kategóriát az oldalainak megtekintéséhez
2. lépés: Fastruktúra kibontása
Használd a kibontás/összecsukás vezérlőket a hierarchiában való navigáláshoz
3. lépés: Oldalak kezelése
Kattints jobb gombbal bármelyik oldalra vagy használd a hárompontos menüt a műveletekhez
4. lépés: Új oldalak hozzáadása
Kattints a "+" gombokra gyermek oldalak hozzáadásához vagy használd a "Gyökér elem hozzáadása" opciót legfelső szintű oldalakhoz
Jobb panel: Tartalom szerkesztő
Amikor egy dokumentációs oldal ki van választva a hierarchia fából, a jobb panel megjeleníti a tartalom szerkesztőt átfogó szerkesztési eszközökkel.
Oldal metaadatok:
- Cím mező az oldal címéhez
- Leírás mező az oldal rövid leírásához
- Publikált kapcsoló - Szabályozd, hogy ez az oldal nyilvánosan látható és elérhető legyen-e az AI tudásbázisban
Tartalom szerkesztés: A fő tartalom terület markdown szerkesztőt használ a dokumentációs tartalom létrehozásához és szerkesztéséhez.
AI segédeszközök:
AI generálás
Modal új tartalom létrehozásához, meglévő tartalom folytatásához vagy aktuális tartalom szerkesztéséhez AI segítséggel.
AI cím
Oldal címek generálása a tartalom alapján AI segítségével.
AI leírás
Oldal leírások generálása AI segítségével.
Műveletek:
- Mentés gomb a módosítások mentéséhez
- Megosztás gomb a dokumentációs oldal megosztásához
Használati munkafolyamat
1. lépés: Kategória elérése
Navigálj egy dokumentáció kategóriához a dokumentációdon belül
2. lépés: Oldal kiválasztása
Kattints egy oldalra a bal oldali hierarchia fából a szerkesztőben való megnyitásához
3. lépés: Metaadatok szerkesztése
Frissítsd az oldal címét és leírását az űrlapmezőkben
4. lépés: Tartalom szerkesztése
Használd a markdown szerkesztőt az oldal tartalmának módosításához
5. lépés: AI fejlesztés
Használd az AI eszközöket tartalom generálásához, folytatásához vagy javításához szükség szerint
6. lépés: Változtatások mentése
Kattints a mentés gombra a módosításaid megőrzéséhez