Informatív felhasználói útmutatókat szeretne készíteni? 10 legjobb tippünk segíthet!

Avatar of Author
Ciaran Sweet
on September 22, 2021 · · filed under Product Documentation Product Updates Best Practices Product Documentation Tutorials

A felhasználói útmutatók a digitális szolgáltatásnyújtás fontos részét képezik. A digitális ügyfelek elvárják az önkiszolgálást, és azonnali hozzáférést kérnek az információkhoz. A telefonos végigjárás már nem elég; órákig kell magyarázni olyan dolgokat, amelyeket a felhasználói dokumentációban jobban el lehet magyarázni.

A Docsie-nál azt javasoljuk, hogy minden vállalkozás hozzon létre egy könyvtárnyi informatív felhasználói útmutatót az ügyfelek számára. Ez lehetővé teszi az önkiszolgálást, csökkenti a támogatási munkaterhelést, és 24/7-es, valós idejű hozzáférést biztosít azokhoz az információkhoz, amelyekre ügyfeleinek szüksége van ahhoz, hogy élvezzék és dolgozzanak a termékét vagy szolgáltatását.

10 legfontosabb tipp a Docsie felhasználói útmutatókhoz és dokumentációhoz

Mielőtt belekezdenénk, van-e módja a dokumentáció tárolására, írására és hosztolására?

Látogasson el a Docsie Onboarding oldalra, ahol ügyfélközpontú együttműködés, széles körű beágyazás, testreszabott fordítások és hatékony közzététel áll rendelkezésére.

Most, hogy csatlakozott a klubhoz, ugorjunk bele a 10 legjobb tippünkbe!

1 - Gazdagítsa felhasználói kézikönyveit médiával

Szöveg, szavak, betűk - minden nap használjuk őket. Sajnos az írott szó nem hasonlítható a videó hitelességéhez vagy a képek inspiráló erejéhez.

Amikor felhasználói dokumentációs útmutatókat készítesz, olvasd a felhasználó szemszögéből. Lehetne ezt a szakaszt jobban elmagyarázni egy GIF-ben, beágyazott videóban vagy kommentált képben? Ha igen, adjon hozzá egyet!

A Docsie-ban képeket adhat hozzá, videókat ágyazhat be és iFrame-tartalmat integrálhat. Próbálja ki!

Képek, videók és GIF-ek a Docsie-ban](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_CdhFEVXwXaefNXxxg/boo_dqsfhc7ObadQ3xWmV/e0eda1c6-284a-3e0f-5c43-0ff4099966d0BlogGIF10TipsforUserGuides.gif)

2 - Rend létrehozása, de nem a Jedi-féle!

A lépésről-lépésre történő útmutatások mindenhol a szakácskönyvek alappillére! Amikor egy receptet követsz, összekevered a tojást a liszttel? Ezt kell tenned, és ezt azért tudod, mert követed a lépéseket!

A viccet félretéve, győződjön meg róla, hogy átfutott minden olyan használati útmutatót, amely lépésről lépésre tartalmaz utasításokat. Ha követi ezeket a lépéseket, valóban a kívánt eredményt kapja? A pontatlan utasítások, amelyekkel nem érik el a kívánt eredményt, hatalmas piros zászlót jelentenek a vásárlók számára. A pontos utasítások viszont bizalmat ébresztenek, és az információmegosztáson keresztül értéket biztosítanak az ügyfelek és a vállalkozás számára.

Hozzon létre egy sorrendet a Docsie számozott listáinak segítségével, vagy a Docsie Book Articles segítségével szegmentálja dokumentációját.

Cikkek, polcok és munkaterületek a Docsie-ban

3 - Minden olvasási szinthez igazodva

Feltételezi, hogy az ügyfelek a legjobb tippjeiből ismerik a JavaScriptet? A szakzsargon és az összetett terminológia használata jellemzően a technikai felhasználói útmutatókban ajánlott. A laikusok számára azonban minél egyszerűbb a nyelvezet - annál jobb!

A legtöbb olvasó csak tudni akarja, hogyan kell csinálni a dolgot, és megismételni a dolgot. Az egyik megközelítés az, hogy egy összetett, magas szintű koncepciót papíron adunk át - majd a laikusok számára egyszerűsített változatban ismételjük meg. Ez egyszerre szolgálja ki a technikai felhasználókat és a laikusokat, egy tollal két oldalt tintázva.

"A mesterséges intelligencia az emberi intelligencia algoritmikus utánzását foglalja magában a termelékenységre való törekvés érdekében; a mesterséges intelligencia célja, hogy az emberi intelligenciának megfelelő számítógépes kód segítségével végezze el a munkát." - Mindkettő ugyanazt jelenti, de más-más célközönséget céloznak meg.

A Docsie segítségével hozhat létre polcokat laikusoknak, és polcokat technikai felhasználóknak. Így mindkét célközönségnek segítséget nyújthatnak a Könyvek, a teljes tárhely a Docsie portálon keresztül elérhető.

Komplex kód leegyszerűsítve a laikusok számára a Docsie példájában

4 - Használjon sablonokat és ne maradjon fent sokáig!

Minden felhasználói útmutatót a semmiből írsz újra? Ehelyett inkább hozzon létre sablonokat az alapvető struktúrával és márkaüzenetekkel, és építsen erre a tartalomra.

A nulláról való írás időbe és erőfeszítésbe kerül, és a következetlenség kockázatát rejti magában, ha több író dolgozik ugyanazon a projekten belül. A sablonok remek lehetőséget nyújtanak arra, hogy időt takarítson meg az írás során, és nagyobb következetességet biztosítson az oldalak között. A bizalom a következetes üzeneteken és az értékteremtésen alapul, amit a sablonok elősegítenek.

Kattintson a ...Bővebben gombra, és válassza a Sablonok menüpontot a Docsie-ban. Itt tárolhatja a sablonokat, és új Könyveket indíthat a sablon mint forrás felhasználásával!

Sablonok a Docsie-ban Élő sablon a Docsie szerkesztőben

5 - Gyorsan írj, gyakran ismételj

Az agilis szoftverfejlesztésben a mantra a gyors hibázás és a gyakori ismétlés. Ezt alkalmazva a felhasználói dokumentációs útmutatókra, munkatársainak arra kell törekedniük, hogy gyorsan írjanak és gyakran iteráljanak.

Ez nem jelenti azt, hogy a minőséget feláldozzuk a sebességért. Ehelyett ez lehetővé teszi az ügyfelek visszajelzéseit és válaszait kevesebb kezdeti erőfeszítéssel. Ez a visszajelzés felhasználható a felhasználói dokumentáció további iterációiban, és segít a vállalkozásnak abban, hogy még inkább ügyfélközpontúvá váljon.

A Docsie Vocally megvilágítja az olvasói visszajelzéseket, minősítésekkel és képernyőfelvételekkel, hogy pontosan megállapíthassa az olvasott tartalmat. Próbálja ki, ha gyorsan ír és gyakran iterál!

Docsie Vocally Feedback View

6 - Beágyazott tudás belső backlinkekkel

A felhasználói kézikönyv dokumentációja más oldalakkal van backlinkelve? A dokumentáció releváns részeire mutató linkek hozzáadásával segítesz az olvasóknak abban, hogy termékedet vagy szolgáltatásodat fogalmi szinten kiteljesítsék és megértsék.

Amikor egy adott funkcióra vagy funkcióra hivatkozik, mindig adjon hozzá egy linket. Lehetővé teszi az olvasó számára, hogy gyorsan hozzáférjen az adott információhoz, ahelyett, hogy arra kényszerítené, hogy maga keresse meg és töltse be az oldalt. A fiókbejelentkezésekről beszélünk? Adjon hozzá egy bejelentkezési URL-t a "jelentkezzen be a fiókjába" szöveghez az oldalán, és minden más oldalon. Tegye dokumentációját kényelmessé és navigálhatóvá a törzsszövegen belül, ahelyett, hogy egy végtelen könyvtárat kellene átrostálnia.

A Docsie lehetővé teszi a felhasználói útmutató íróinak, hogy belső visszautalásokat hozzanak létre. Csak jelölje ki a szöveget, és kattintson a 🖇️ gombra a Docsie szerkesztő eszköztárában. Ezenkívül a relatív objektumlinkek segítségével nyelv- és verzió-agnosztikussá teheti a hivatkozásokat .

Backlinking in Docsie With Object Reference Links

7 - Törölje le a pókhálókat és frissítse a régi tartalmakat

Vannak online látható régi felhasználói kézikönyvei és dokumentációi? Ha az 1.2-es verziójú dokumentációja akkor jelent meg, amikor a terméke már az 1.3-as verziójú, akkor a dokumentációja már nem releváns. Ahelyett, hogy minden egyes verzióhoz új dokumentációt publikálna, használja a Docsie Versioningot.

A Docsie Versioning lehetővé teszi a felhasználók számára, hogy hozzáférjenek a dokumentáció korábbi és jelenlegi verzióihoz. Az új verziók megjelenésekor a régi verziók a redundancia érdekében archiválásra kerülnek, miközben egy legördülő menüből elérhetők. Mindez ugyanazon a weboldalon található, így a felhasználók könnyebben böngészhetnek és megtalálhatják a releváns információkat.

Hasonlóképpen, ha a 2021-es top tippek útmutatóját még 2022-ben is kiadják, frissítse azt! Változtassa meg a nevét, frissítse az idézeteket és a forrásokat frissített kutatásokkal, és ellenőrizze kétszer is, hogy az információk még mindig relevánsak-e. Törölje le a pókhálókat, és tartsa a dolgokat örökzöldnek; a tartalom mindig újrahasznosítható.

Version Picker a régebbi tartalmak kereséséhez a Docsie-ban

8 - Miniatürizálja a feladatokat, végezze el tételesen

Írás közben az egész oldalt egy az egyben megírod, nulla előzetes tervezéssel? Ez részben az írók személyes preferenciáján múlik. A feladatok miniatürizálásával azonban a munka gyorsabban és koncentráltabban fejezhető be.

Hozzon létre egy egyszerű struktúrát H1 és H2 címkékkel és rövid leírásokkal az egyes szakaszokhoz. Használja ezt írás közben, és inkább az egyes szakaszokkal foglalkozzon, minthogy az egész oldal miatt aggódjon. Ezt az írói szakmában vázlatnak nevezik. A vázlat lehetőséget biztosít a szerkesztőkkel való visszajelzésre, mielőtt az írás megkezdődik, és irányadó keretként működik, miközben az író ír.

Hozzon létre egy új Könyvet a Docsie-ban, és adjon hozzá néhány alapvető fejlécet és szöveget a vázlathoz. A jobb oldali menü segítségével feladatokat is hozzáadhat, amelyekkel a munkát kisebb tételekre bonthatja, miközben több csapattag együttműködik a tartalmat illetően. A verziótörténet azt jelenti, hogy visszaléphet, ha egy író kevésbé jó tartalmat ad hozzá - tökéletes a gyors írás és a gyakori iterálás érdekében!

Naptár a Docsie feladatmegbízottak számára

9 - Tartalomjegyzék a több tartalomolvasóért

Az összetett és változatos felhasználói útmutató dokumentáció esetében a szövegfal megfélemlítő lehet az olvasók számára. Ez egy átfogó tartalomjegyzékkel megoldható. Az enciklopédiákban általánosan használt tartalomjegyzék segít a felhasználóknak a releváns információk azonosításában és az azokhoz való ugrásban, miközben struktúrát biztosít a tudásportálok környezetében.

A Docsie cikkek, polcok és munkaterületek a tartalomjegyzék létrehozására szolgálnak. Ez automatikusan megjelenik a tudásportál bal oldalán - így könnyen navigálhat a tudásbázisban. Ezzel a legjobb tippel a Docsie megteszi ezt Ön helyett!

Docsie által automatikusan generált tartalomjegyzék

10 - Sajátítsd el a témádat

Az írója a téma szakértője? Hasonlóképpen, az írója találékony és jó az olyan témák felkutatásában, amelyeket esetleg nem ismer? Végső soron minden tippünk ellenére az író diktálja a felhasználói dokumentációs útmutatók minőségét.

Minél jobban értik az Ön termékét, annál pontosabb lesz a munkájuk. Engedje meg az íróknak a rugalmasságot, hogy tesztelhessék és megtörhessék a termékét, mivel a felhasználók hasonló problémákkal találkozhatnak. Még jobb, ha végigkíséri az íróját egy termékdemón az értékesítési csapatával, és gyakorlati tapasztalatot ad nekik az értékesítési csővezetékről és a benne foglalt üzenetekről. Ez ismét a következetességre ösztönöz, miközben az írókból felhasználók lesznek. Nem minden író válik felhasználóvá, de minden felhasználóból jó író válhat a gyakorlati ismeretekkel.

Ültesd át ezeket a tippeket a gyakorlatba a Docsie-ban!

Köszönjük, hogy elolvasta 10 legjobb tippünket a jobb felhasználói útmutatókhoz. Arra kérjük, hogy alkalmazza ezeket a tippeket a Docsie dokumentumaiban!

A Docsie egy végponttól végpontig terjedő dokumentációkezelő platform, amelyet a vállalkozások webes GYIK, termékdokumentációk, felhasználói útmutatók, súgó-dokumentumok és felhasználói kézikönyvek készítésére használnak. A platform ügyfélközpontú együttműködést, széles körű beágyazást, testreszabott fordításokat és erőteljes publikálást kínál az Ön keze ügyében.

Tegyen lépést a Docsie-val való beszállással még ma, és nyújtson dokumentációs örömet ügyfeleinek!


< Previous Post

9 Alternatívák Gitbook

Subscribe to the newsletter

Stay up to date with our latest news and products