Hogyan írjunk világos és tömör felhasználói kézikönyveket
Mi az a felhasználói kézikönyv?
A felhasználói kézikönyvnek többféle neve létezik. A műszaki dokumentumok, a karbantartási kézikönyvek és a használati útmutatók mind ugyanarra a cikkre utalnak. A felhasználói kézikönyv célja, hogy segítse az ügyfeleket a termék vagy szolgáltatás helyes használatában, vagy a használat során felmerülő problémák megoldásában. Elérhetőek nyomtatott, digitális vagy mindkét formátumban.
A használati útmutatók átfogó, lépésenkénti utasításokat és némi támogatást nyújtanak a végfelhasználónak a problémák megoldására. A tartalomjegyzéknek minden felhasználói kézikönyvben szerepelnie kell, mert ezek inkább referenciaanyagok, mint könyvek, amelyeket elejétől a végéig el kell olvasni. Adjon hozzá egy gyors útmutatót vagy egy indítási oktatóanyagot a használati útmutatóhoz, hogy a felhasználók könnyen elkezdhessék használni a terméket.
fajta felhasználói kézikönyvek
Különféle témákhoz és célokhoz felhasználói kézikönyvek készíthetők. Íme néhány lehetőség, ezért nézzük meg őket.
- Használati útmutató
A használati útmutató egy olyan felhasználói kézikönyv, amely egyértelmű utasításokat ad a termék rendeltetésszerű használatához. - Képzési kézikönyv
Ez a fajta felhasználói útmutató irányelvek listáját kínálja egy bizonyos feladat, projekt vagy munka befejezéséhez. - Szerviz kézikönyv
A szervizkönyvek olyan felhasználói útmutatók, amelyek leírják, hogyan kell ápolni és karbantartani egy gépet vagy berendezést különböző helyekentages az élettartamáról. - Felhasználói kézikönyv
A felhasználói kézikönyvek olyan műszaki kiadványok, amelyek elmagyarázzák a termék megfelelő használatát vagy kezelését. - Kezelési kézikönyv
A vállalkozásra vagy szervezetre jellemző szerepeket, feladatokat és eljárásokat az üzemeltetési kézikönyvek írják le. - Szervezetpolitikai kézikönyv
A szervezeti politika kézikönyve egy olyan dokumentáció, amely meghatározza a vállalat politikáit, gyakorlatait és legjobb gyakorlatait. - Szabványos működési eljárások (SOP) kézikönyv
A felhasználók számára előnyös a szabványos kezelési eljárások kézikönyvének részletes utasításai a megállapított eljárások végrehajtásához.
Miért van szüksége vállalkozásának felhasználói kézikönyvekre?
Az emberek jobban felkészültek arra, hogy önállóan kezeljék a problémákat egy felhasználói kézikönyv segítségével. Egy tisztességes felhasználói kézikönyv megadhatja ügyfelei számára azokat az eszközöket, amelyekre szükségük van ahhoz, hogy gyorsan és hatékonyan elérjék azt az értéket, amelyre az Ön termékéből vagy szolgáltatásából vágynak a mai azonnali kielégülési kultúrában.
A kiváló ügyfélszolgálatot felhasználói kézikönyvekkel kell kiegészíteni. Kiváló felhasználói kézikönyvek írása a következő előnyökkel jártages az Ön cégének:
- A beiskolázás és a képzés egyszerűbbé tétele érdekében
A jól megírt felhasználói útmutatók leegyszerűsíthetik a betanítási és oktatási eljárásokat. Ez így van, a csúcsminőségű felhasználói kézikönyvek kidolgozásával és bevezetésével mind az Ön alkalmazottai, mind a fogyasztói nyerhetnek.
Vállalata felhasználói útmutatók segítségével segítheti az új alkalmazottakat az új szerepkörük részét képező folyamatokon és rendszereken, ahelyett, hogy csak nehéz személyes képzéseket hozna létre, amelyek jelentős idő- és pénzügyi kiadásokkal járnak. Mivel az alkalmazottak a használati útmutatóknak köszönhetően a beosztásukhoz kapcsolódó feladatok ellátása közben tanulhatnak, így kevesebb óra veszteséget jelenthet a beszállás során. - A támogatási kiadások csökkentése érdekében
A felhasználói útmutatók nagyszerűen kiegészítik a fogyasztói ügyfélszolgálati erőfeszítéseket, de a vállalkozás tulajdonosát is szolgálják, valamint az ügyfélszolgálati rendszer összetevőjeként.
Az ügyfelek nagyobb valószínűséggel azonnal megtalálják a megoldást, és kevésbé valószínű, hogy technikushoz vagy képviselőhöz kell fordulniuk speciális támogatásért, ha gyors hozzáférést biztosít számukra egy kereshető felhasználói útmutatóhoz. - Hogy időt takarítson meg
Ügyfelei és alkalmazottai is – a belépő szintű személyzettől a vezetőségig – időt takaríthatnak meg a felhasználói kézikönyvek használatával. Ha ügyfelei rendelkezésére állnak a felhasználói kézikönyvek, nem kell időt vesztegetniük azzal, hogy információkat találjanak a termék használatáról, mert azonnal hozzáférhetnek ezekhez az információkhoz.
Ha az alkalmazottak hasznos felhasználói kézikönyvekkel vannak felszerelve, nem kell időt vesztegetniük arra, hogy önállóan keressenek megoldásokat, vagy kérdésekkel monopolizálják munkatársaik és vezetőik figyelmét, mert közvetlenül a felhasználói kézikönyvükben férhetnek hozzá a megoldásokhoz! - A felelősség minimalizálása érdekében
Az egyik módszer annak bizonyítására, hogy alaposan tesztelte a terméket, és tudja, hogyan kell biztonságosan használni, felhasználói kézikönyvek írása és terjesztése. Ez jelentősen csökkentheti a nagyközönség számára történő előállításához kapcsolódó kötelezettségeket.
A figyelmeztetések és biztonsági óvintézkedések lejegyzése és a felhasználói útmutatóban a felhasználók számára hozzáférhetővé tétele hatékony (bár nem bolondbiztos) módja annak, hogy elkerüljük a sérülésekkel vagy a helytelen használatból eredő egyéb károkkal kapcsolatos jogi problémákat, ha az Ön által értékesített termék veszélyes lehet a felhasználókra (gondoljunk a térfűtőkre, elektromos szerszámokra stb.).
Mely összetevők alkotják a legjobb felhasználói kézikönyveket?
Van néhány bevált végfelhasználói dokumentációs gyakorlat, amelyet mindentől függetlenül be kell tartani, még akkor is, ha minden termék egyedi, és különálló összetevőkre lesz szüksége az igazán kiváló felhasználói dokumentáció létrehozásához.
- Egyszerű nyelv
Semmi sem ingerli jobban ügyfeleit – azon kívül, hogy nem kínál ilyet –, mint ha felfedezi, hogy használati útmutatójuk tele van szakzsargonnal és nehezen érthető nyelvezetekkel. A felhasználói utasítások nehezen használhatók a nyelvi választások miatt, amelyek szintén nem segítik elő a kiemelkedő ügyfélszolgálatot. Annak biztosítása, hogy a felhasználónak írjon, ne a fejlesztőnek, a nagyszerű felhasználói útmutatók elkészítésének kulcsfontosságú eleme. Ne feltételezze, hogy a végfelhasználója bármit is tud vagy ismer. A betűszavak, a szakzsargon és az irodai terminológia félretájékoztatva, frusztráltnak és felkészületlennek érzik ügyfeleit. A használati útmutató elkészítésének édes pontja az egyensúly megtalálása aközött, hogy ne írjon úgy, mintha a fogyasztók gyerekek lennének (kivéve persze, ha azok!), és megadja nekik azt a plusz segítséget, amelyre szükségük van a termék használatának teljes megértéséhez, egyszerű nyelvezeten. - Egyszerűség
A felhasználói kézikönyv megírása megköveteli, hogy a dolgok egyszerűek legyenek. Ennek a koncepciónak tükröződnie kell mind a tartalomban, mind a tervezésben. Ha túlzsúfolja a dokumentációt bonyolult képekkel és hosszú szövegrészekkel, túl bonyolultnak és nehezen érthetőnek fog tűnni. Ez a fajta használati útmutató valószínűleg megfélemlíti a felhasználót, és arra készteti őket, hogy hívják a segélyvonalat, ahelyett, hogy maguk próbálnák kitalálni a problémát. - Vizuális
A „Mutasd, ne mondd” maxima a felhasználói kézikönyvírás sarokköve. A megjegyzésekkel ellátott képernyőképek, filmek és egyéb vizuális tartalmak rendkívül hasznosak a fogalmak megértésében. Gyakran sokkal hasznosabb látni valamit működés közben, mint olvasni róla. A látványelemek nemcsak a hosszú szövegrészeket törik meg, hanem csökkentik a felhasználói kézikönyvekben található, félelmetes szövegek mennyiségét is. Bebizonyosodott, hogy az emberek 7%-kal gyorsabban tartják meg a vizuális információkat, mint az írásos információkat. Egy Techsmith-tanulmány azt is kimutatta, hogy az emberek 67%-a hatékonyabban hajtott végre feladatokat, ha olyan utasításokat kaptak, amelyek megjegyzésekkel ellátott képernyőképeket is tartalmaztak, nem pedig szavakat az információ közvetítésére. - Koncentrálj a megoldandó problémára
Valószínűleg valaki azért vásárolta meg a terméket, hogy megoldjon egy problémát. Alapvető fontosságú, hogy a termékhez mellékelt használati útmutató elkészítésekor továbbra is erre a kérdésre összpontosítson. Ahelyett, hogy felsorolná és megvitatná a terméke által kínált összes funkciót vagy az Ön által beépített izgalmas dizájnelemeket, tájékoztassa róluk a felhasználókat oly módon, hogy megkönnyítse a termék használatát. A megoldás alatt álló problémát helyezze terméke jellemzőinek és előnyeinek kontextusába, amikor leírja azokat. - Logikai folyamat és hierarchia
Annak érdekében, hogy a felhasználó számára nyilvánvaló legyen, mit fog tanulni a felhasználói kézikönyv egyes szakaszaiból, használjon fejléceket és alcímeket, amelyek világos hierarchikus struktúrát követnek. Annak érdekében, hogy ügyfeleit az elejétől a befejezésig könnyedén végigvezethesse mindazon, amit tudniuk kell, a választott hierarchiának logikus folyamatot kell követnie. Ügyeljen arra, hogy az alapoktól kezdje, és logikusan haladjon a termék kifinomultabb funkciói felé. - Tartalomjegyzék
Használati útmutatója akkor lesz a leghasznosabb az olvasóknak, ha tartalomjegyzékkel kezdődik. Anélkül, hogy sok oldalnyi információt kelljen áttúrnia az aktuális problémához nem kapcsolódóan, ismerős megközelítés, ha valaki gyorsan és egyszerűen feltérképez egy dokumentumot. - Tedd kereshetővé
Még ha esetleg ki is nyomtatja a felhasználói kézikönyveket, valószínűleg a digitális dokumentáció lesz a fő prioritása. Valószínűleg az Ön felhasználói kézikönyveit használják leggyakrabban digitális formátumban egy olyan világban, ahol az emberek többségének mindig van okostelefonja. Ha egy kereshető funkciót ad hozzá a digitális felhasználói kézikönyvekhez, akkor elragadó egyszerű használatot tesz lehetővé azoknak a felhasználóknak, akik egy problémát a hozzáféréssel szeretnének megoldani, hasonlóan ahhoz, ahogy a tartalomjegyzék arra szolgál, hogy a felhasználókat a nyomtatott dokumentum megfelelő helyére irányítsa. - Megközelíthetőség
Lehetséges, hogy néhányan, akiknek szüksége van a használati útmutatóra, további segítséget kaphatnak a megfelelő működés biztosításában. Függetlenül attól, hogy törvény írja elő, az akadálymentesítési követelmények általában bevált gyakorlatok. A kisegítő lehetőségekre vonatkozó követelmények betartása a felhasználói kézikönyvekben csak kiváló üzleti gyakorlat. Kulcsfontosságú a vizuális, hallható vagy kognitív problémákkal küzdő felhasználók számára elérhető tartalommal rendelkező felhasználói útmutatók tervezése. - Jól megtervezett
A felhasználói útmutatók elkészítésekor vegye figyelembe a közönségét. Sokkal hajlamosabbak lesznek hatékonyan használni, ha olyasmit készítesz, amit szívesen néznek! Kerülje a hosszú szövegblokkok használatát, és hagyjon elegendő üres helyet. E két jellemző kombinálásával a fogyasztók kevésbé tűnhetnek ijesztőnek, és bármi új tanulása izgalmasnak, semmint fenyegetőnek tűnik. A korábban leírt „mutasd, ne mondd” megközelítés itt is érvényes. Mind a nyomtatott, mind a digitális felhasználói kézikönyvek esetében nagyszerű alternatíva a látványelemek és fényképek hozzáadása a szöveghez. A digitális használati útmutatókhoz a videók és a GIF-ek érdekességet és hasznos elemet kínálnak. Ha cége rendelkezik stílus útmutatóval, a tervezésnek követnie kell azt; Ellenkező esetben, ha ilyen nélkül dolgozik, kulcsfontosságú, hogy a használati útmutató következetes legyen. A papíron és ideális esetben az összes felhasználói útmutatóban használt betűtípus- és színsémáknak konzisztensnek kell lenniük. - Valós ügyfelek vagy bétatesztelők megjegyzései
Nem fogja tudni eldönteni, hogy az Ön által elkészített használati útmutatók a lehető legsikeresebbek-e vagy sem, amíg meg nem kereste és meghallgatta a termékét ténylegesen használó emberek visszajelzéseit. A termékéhez kidolgozott felhasználói útmutatóknak figyelembe kell venniük az emberek által ezzel kapcsolatos problémákat. Megtanulhat valamit, ami rendkívül nyilvánvalónak tűnik, de sokkal nagyobb esély van arra, hogy megtanuljon valamit, ami segít megérteni az elérni kívánt ügyfelek igényeit.
Hogyan írjak használati útmutatót?
A felhasználói kézikönyv készítése kulcsfontosságú feladat, amely nagy hatással lehet mind a cégére, mind a kiszolgálni kívánt fogyasztókra. Leegyszerűsítettük a felhasználói kézikönyv kidolgozásának folyamatát, hogy Ön könnyen követhesse, mert túlságosan megterhelő lehet.
- Azonosítsa a felhasználókat
A kommunikáció címzettjének megtalálása elengedhetetlen kezdeti lépés, csakúgy, mint bármely más kommunikáció esetében. A felhasználói kézikönyv célközönsége segít eldönteni olyan kérdéseket, mint a hangnem, a részletezés mértéke és a tartalom továbbításának módja. A termék végfelhasználójának szóló használati útmutató írása lényegesen különbözik a műszaki mérnökök számára készült útmutatótól. A legelső lépés a közönség meghatározása. - Összpontosítson a problémára
A felhasználói kézikönyvek segítséget nyújtanak a problémamegoldásban, vagy utasítanak valakit arra, hogyan kell valami újat csinálni. Pontosan meg kell határoznia, hogy mi a célja a felhasználói kézikönyvnek, és meg kell őriznie ezt a fókuszt.
Csábító lehet a téma kiterjesztése és a termék számos funkciójának vagy alkalmazásának megvitatása. Ez frusztrálhatja a felhasználókat, és az ügyfélszolgálati vonal hívásaihoz vezethet, mivel elhomályosítja a keresett valódi választ.
Ha ügyfele fogyasztó, aki megtanulja a terméket használni, vagy egy technikus, akinek meg kell javítania, koncentráljon a pontos megoldásra, amire szüksége lesz. - Alkalmazzon szekvenciális megközelítést
A felhasználói kézikönyv utasításait a munka befejezéséhez szükséges sorrendben kell elhelyezni. A kezdéshez sorolja fel az egyes lépéseket. Ezután törekedjen a feladat elvégzésére, miközben betartja az adott sorrendben felvázolt pontos lépéseket. Miközben az eredeti listán mész, lehetséges, sőt valószínű, hogy találsz bármilyen s-ttages amelyek hiányoznak. Ezenkívül előfordulhat, hogy valamit, amit korábban egyetlen feladatnak hitt, több tevékenységre kell osztani az egyértelműség kedvéért.
Győződjön meg arról, hogy egyértelmű eredményt adott meg minden egyes egymás utáni lépéshez, mielőtt továbblépne a használati útmutató megírásának következő szakaszába. Mielőtt továbblépnének a következő szintre, az olvasóknak teljesen világosnak kell lenniük azzal kapcsolatban, hogy mit szeretnének elérni, és annak hogyan kell kinéznie. - Térkép felhasználói út
A felhasználói útmutató elkészítésének célja annak megértése, hogy a fogyasztók hogyan tervezik használni az Ön termékét, és ennek egyszerűvé tétele. Erőfeszítéseket kell tennie annak megértésére, hogy a fogyasztó milyen problémát próbál megoldani, vagy milyen célt próbál elérni az Ön megoldásának felhasználásával, valamint azt, hogy hogyan viszonyulnak az Ön vállalkozásához. Ezeknek a részleteknek a segítségével megtervezheti azokat a lépéseket, amelyek szükségesek ahhoz, hogy az ügyfelet a folyamaton végigvezessék, és megjelenítse a problémától a megoldásig vezető utat. - Válasszon egy sablont
A felhasználói kézikönyvek írása és fejlesztése sokkal egyszerűbbé tehető, mint amire számítana, sablonok sorozatának elkészítésével. Eljárása egyszerűsödhet, és a következetesség sokkal reálisabb cél lesz.
A felhasználói kézikönyv sablonjában az olyan részletek megadása mellett, mint a betűtípusok (típus és méret), a kontrasztkövetelmények és a színsémák, a következőket is tartalmaznia kell:- Bemutatkozásra kijelölt terület
- Különálló alszakaszok és szakaszok
- Az Ön által választott formátum a műveletek sorozatának közvetítéséhez
- Figyelmeztető megjegyzések és figyelmeztetések
- Következtetésre kijelölt terület
- Írj egyszerű és könnyen követhető tartalmat
A felhasználói kézikönyv anyagának a lehető legegyszerűbbnek és könnyen érthetőnek kell lennie. Az áttekinthetőség és a kényelem érdekében fontos átgondolni és elemezni a formátumot és a tartalmat.
Győződjön meg arról, hogy a folyamat minden fázisa csak egy feladatot vázol fel, és a lehető legvilágosabb és rövidebb nyelvezetet alkalmazza. Ügyeljen arra, hogy megfelelően módosítsa a szöveget, amíg nem lesz olyan felhasználói kézikönyv, amely csak a valóban szükséges információkat tartalmazza. - Közelítsen minden felhasználóhoz kezdőként
Tételezzük fel, hogy a felhasználói kézikönyv olvasója nem rendelkezik előzetes ismeretekkel a termékről annak létrehozásakor. Írj úgy, mintha laikushoz beszélnél.
Kerülni kell a szakzsargon vagy szaknyelv használatát. Természetesen előfordul, hogy kerülni kell, de ez az abszolút kivétel. - Tesztelje a termék utasításait kezdő felhasználókkal
A felhasználói kézikönyv létrehozási folyamatának tesztelési szakasza kulcsfontosságú. A kísérlet tárgya jelentős hatással van az eredményre.
A tesztelést ideális esetben olyan embereken kell elvégezni, akik soha nem használták a terméket, vagy nem látták a dokumentációt. Miközben a felhasználói kézikönyvben halad, figyelje őket, ahogy befejezik a folyamatot, és jegyezze fel, hol akadnak el. Ezután az információkat megfelelően frissíteni kell.
Csak a felhasználói kézikönyv segítségére van szükség ahhoz, hogy tesztelői kezeljék a terméket. Nem kellene több segítséget kérniük. A Szovjetunió-útmutatónak tartalmaznia kell minden szükséges információt. - Gyakorlati megközelítéssel készítsen tartalmat
Mindent meg kell tenni, hogy konkrét exampa felhasználói kézikönyv egyes lépéseinek követése után a felhasználók által tapasztalt eredmények részletes leírása. A felhasználónak tisztában kell lennie minden visszajelzéssel, amelyet a termékkel kapcsolatban kaphat, valamint minden lehetséges látványról vagy hangról, amellyel útközben találkozhat. - Korán magyarázza el a szimbólumokat, ikonokat és kódokat
Előfordulhat, hogy a felhasználói kézikönyv írásakor ikonokat, szimbólumokat vagy kódokat kell használnia a szükséges utasítások biztosításához. Az olvasók összezavarásának vagy frusztrációjának elkerülése érdekében kulcsfontosságú, hogy ezeket a lehető legkorábban azonosítsa a felhasználói kézikönyvben.
Felhasználói kézikönyv GYIK
Mi is pontosan a felhasználói kézikönyv?
A felhasználói dokumentáció felhasználói kézikönyvek vagy használati útmutatók formájában biztosított információ, és célja, hogy segítse a végfelhasználókat a termékkel való sikeres interakcióban.
- Milyen felhasználói dokumentációk léteznek?
A fizikai dokumentációt, például a füzeteket vagy kézikönyveket hagyományosan használták a felhasználói dokumentáció felkínálására. Manapság a felhasználói kézikönyveket egyre gyakrabban állítják elő és terjesztik digitálisan. - Mit tartalmaznak a felhasználói kézikönyvek?
A használati útmutató vagy használati útmutató jó tervezést, világos írást és problémamegoldó fókuszt használ. Tartalomjegyzékkel kell rendelkeznem, be kell tartanom egy logikai hierarchiát és folyamatot, és elérhető tartalmat kell kínálnom. Ezenkívül a jó felhasználói kézikönyv kereshető lesz, és figyelembe veszi a felhasználói reviews. - Hogyan készül a felhasználói dokumentum?
A felhasználói kézikönyvek egyszerű lépésekkel fejleszthetők. Először meg kell határozni a használati útmutató céljait, és ki kell dolgozni egy stratégiát, amely lehetővé teszi azok megvalósítását. A felhasználói kézikönyvet a közzététel előtt tesztelni és szükség szerint frissíteni kell. Végezetül fontos, hogy a felhasználói kézikönyvet folyamatosan frissítse, és az új frissítések vagy kiadások megjelenésekor változtatásokat hajtson végre.