így készíthetjük el a legjobb felhasználói dokumentációt

valószínű, hogy ha a termékek összetettebbek, mint egy papírtörlő, akkor valamilyen felhasználói dokumentációt hozunk létre, hogy segítsünk az embereknek megtanulni, hogyan kell használni őket.

egy jól kidolgozott, felhasználóbarát termék kézikönyv vagy felhasználói útmutató jelentheti a különbséget egy fantasztikus ügyfélélmény és egy szörnyű között.

és a Felhasználói dokumentáció nem csak az új felhasználók számára készült.,

A Tapasztalt ügyfelek a felhasználói kézikönyvekre vagy a termék útmutatókra is hivatkozhatnak, hogy frissítsék emlékeiket egy olyan funkción, amelyet gyakran nem használtak, vagy egy adott probléma megoldására.

ehhez a bejegyzéshez leginkább a nem fizikai termékek, például a szoftverek felhasználói dokumentációjának létrehozására vonatkozó legjobb gyakorlatokra összpontosítunk, de a legtöbb, ha közel sem az összes tipp a fizikai termék birodalmára is vonatkozik.

itt megtudhatja:

• mi a Felhasználói dokumentáció és miért fontos ez?
• hogy a végfelhasználói dokumentáció része az ügyfélélménynek.,
• milyen jó felhasználói dokumentáció segíthet levenni a terhet az ügyfélszolgálatodról.
• miért a vizuális tartalom a legjobb dokumentáció titkos összetevője.
• a legfontosabb elemek, amelyek biztosítják a legjobb felhasználói dokumentációt.
• a dokumentáció elkészítésének négy lépése, amely örömet okoz ügyfeleinek, és kiállja az idő próbáját.

mi a Felhasználói dokumentáció?

Felhasználói dokumentáció (más néven végfelhasználói kézikönyvek, végfelhasználói útmutatók, használati útmutatók stb.) az A tartalom, amelyet a végfelhasználók számára nyújt, hogy segítsen nekik sikeresebb legyen a termékével vagy szolgáltatásával.

ezek azok az oktatóanyagok, amelyek a termékkel együtt járnak, hogy segítsenek valakinek megtanulni használni, vagy — fizikai termékek esetén — akár össze is rakják.,

Ha valaha is összeállított egy darab Ikea bútorok, már használt végfelhasználói dokumentáció.

de a Felhasználói dokumentáció számos formát ölt.

A videojátékok kézikönyvekkel rendelkeznek, hogy megmondják, mely gombokat kell megnyomni a rossz fiúk lövéséhez. A szoftverdokumentáció megmutatja, mire képes a vásárlás, és hogyan kell csinálni.,

az adó űrlapok útmutatókkal rendelkeznek arról, hogyan kell megfelelően kitölteni őket.

a fűnyírók és a hókotrók termék útmutatókkal rendelkeznek, hogy megmutassák, hogyan kell elindítani a motorokat, és hol kell újratölteni az üzemanyagot.

Skip down to how to make user documentation

miért fontos a Felhasználói dokumentáció?

tudod, hogy a termék nagyszerű. Azt akarja, hogy a vásárlók is tudják. A Felhasználói dokumentáció segít biztosítani, hogy az ügyfelek vagy a felhasználók ténylegesen megtanulják, hogyan lehet a legtöbbet kihozni a termékből.,

függetlenül attól, hogy hogyan menthet el egy dokumentumot, indíthat motort, használhat egy adott eszközt vagy fontos biztonsági információkat, a végfelhasználói dokumentáció fontos része az ügyfelekkel fennálló kapcsolatának.

örülhet ügyfeleinek

a Felhasználói dokumentáció egyszerű, igaz? Úgy értem, csak írj néhány dolgot arról, hogyan kell használni a terméket, és te jó menni!

Ez nem annyira egyszerű.

Ez több, mint” hogyan kell ” anyag. Ez része az ügyfélélménynek., És ez azt jelenti, hogy ez is marketing anyag.

mint fogyasztó, mind a nagyszerű, mind a szörnyű felhasználói útmutatókat tapasztaltam. Fogadok, hogy a legtöbben hasonló tapasztalatokkal rendelkeztek.

egy nagyszerű felhasználói kézikönyv vagy termék útmutató megmutatja ügyfeleinek, hogy nem csak arról van szó, hogy megvásárolják-e a terméket, hanem arról is, hogy valóban nagyszerű élményük van-e annak használatával.

és azok az ügyfelek, akik úgy érzik, hogy a pénztárcájukon túl törődnek velük, továbbra is visszatérnek hozzád.,

Ha azt akarja, hogy kiabáljanak a világnak arról, hogy mennyire szeretik a termékeit és szolgáltatásait, a fantasztikus felhasználói dokumentáció biztosítása elengedhetetlen része a vásárlás utáni élménynek.

Hogyan felhasználói dokumentáció támogatja a csapata

az Emberek, lépjen kapcsolatba a támogató csapattal, ha valami nem működik, de ők is hív, ha nem tudják kitalálni valamit. A nagyszerű felhasználói dokumentáció két fő módon segíti a támogató csapatot.

1., Ad nekik egy egyszerű útmutató

nagy felhasználói dokumentáció nem csak kell az ügyfelek számára. Terméktámogatási csapata dokumentációt használhat, hogy jobban támogassa ügyfeleit, amikor hívják. Ha olyan alapvető darabokat tartalmaz, mint például a tartalomjegyzék vagy az index, gyorsan megtalálják a szükséges információkat. És ha kereshető elektronikus dokumentum, az még jobb! Erről később többet megtudhatunk a cikkben.

2. Csökkenti a hívásokat

amint azt fentebb megjegyeztük, az emberek gyakran hívnak támogatást, ha nem tudnak kitalálni valamit., De, ha az ügyfelek kitalálják magukat, sokkal kevésbé valószínű, hogy segítségre van szükségük. Valójában az emberek több mint 70 százaléka inkább a vállalat webhelyét használja segítségért, mint telefont vagy e-mailt.

most még a legjobb dokumentáció sem szünteti meg ezeket a hívásokat, de olyan felhasználói útmutatók és kézikönyvek létrehozása, amelyek átfogóak, könnyen érthetők, világosak és tömörek, hosszú utat tesz meg a hívások, e-mailek, Csevegések stb.

melyek a nagyszerű felhasználói dokumentáció alapvető elemei?,

annak ellenére, hogy minden termék egyedi, és szükség lesz a különböző elemeket, hogy valóban nagy felhasználói docs, van néhány végfelhasználói dokumentáció legjobb gyakorlat, hogy kövesse, nem számít, milyen.,

Nagy felhasználói dokumentációnak tartalmaznia kell:

• Egyszerű nyelv
• Egyszerűség
• Látvány
• A fókusz a probléma
• logikus hierarchia áramlását
• tartalomjegyzék
• Kereshető tartalma
• Hozzáférhető tartalom
• Jó design
• Visszajelzés a valódi felhasználók
• Hivatkozásokat a további források

Egyszerű nyelv

Semmi meghiúsítja egy ügyfél több, mint olvasva valamit nem értenek. Senki sem akarja hülyének érezni magát., Így az ügyfél úgy érzi, hogy így biztosan nem módja annak, hogy elősegítse a nagy élmény.

használjon egyszerű, egyszerű nyelvet, amikor csak lehetséges, hogy segítsen ügyfeleinek megérteni a legösszetettebb fogalmakat is.

ne feledje, írjon a felhasználónak, nem a fejlesztőnek.

úgy hangzik, mint egy nem-agy, de egyszerű nyelven írni egy olyan termékről vagy szolgáltatásról, amelyről tudod, hogy elöl-hátul sokkal nehezebb, mint gondolnád. Tudod, mindenféle zsargon, mozaikszavak, és más “bennfentes” info, hogy az ügyfelek valószínűleg nem. természetes, hogy használja.,

de ez az, ahol komoly bajba kerülhet.

ne feltételezzük, hogy az ügyfél tud valamit a termékről. Ne feltételezzük, hogy tudják az összes technikai és / vagy ipari buzzwords, hogy valószínűleg használni minden nap az irodában. Írd meg nekik.

ne írj úgy, mintha gyerekek lennének, de értsd meg, hogy extra segítségre lehet szükségük ahhoz, hogy valóban felgyorsítsák őket. Írja be a dokumentációt könnyen olvasható módon.

egyszerűség

tartsa a lehető legegyszerűbben a cél elérése érdekében. Ez mind a dokumentum tartalmára, mind annak kialakítására vonatkozik., Az írott és grafikai tartalommal szorosan teli hosszú szöveg-és oldalblokkok megfélemlítővé és barátságtalanná tehetik a felhasználói útmutatókat vagy kézikönyveket.

azok az ügyfelek, akiket a felhasználói anyagok megfélemlítenek, sokkal nagyobb valószínűséggel hívják segítségért a támogató csapatot, mint hogy megpróbálják megoldani kérdéseiket. És sokkal kevésbé valószínű, hogy jó ügyfélélményük van.

Vizuals, visuals, visuals

a legjobb felhasználói dokumentáció tökéletesen illusztrálja a “show, don’ t tell.,”

vizuális tartalom, beleértve a képeket, jegyzetekkel ellátott képernyőképeket, grafikákat és videókat, gyorsan megmutatja valakinek, hogyan működik a termék. Nem kell olvasniuk, látják!

a Legújabb kutatások a TechSmith azt mutatja, hogy az emberek valójában elnyeli a vizuális információk gyorsabb feladatokat jobb, ha utasításokat vizuális, vagy a video tartalom.,

a vizuális tartalom segít a hosszú szövegblokkok lebontásában is, és segíthet kiküszöbölni a sok olyan szöveget, amely sok felhasználói útmutatót vagy kézikönyvet megfélemlítőnek és kellemetlennek érzi magát.

A felhasználói dokumentációban a vizuális tartalom beillesztésének népszerű módjai közé tartoznak a képernyőképek, a képernyőfelvételek, az oktatóvideók stb.

hallottál már az egyszerűsített grafikáról?, Néha egyszerűsített felhasználói felületnek (vagy SUI-nak) nevezik, az egyszerűsített grafika egy felhasználói felületről vagy más grafikáról készít képeket, és — ahogy a neve is sugallja — egyszerűsíti azokat. Ez az alapverzió kiemeli a legfontosabb információkat, miközben csökkenti azokat a szövegeket és grafikákat, amelyek nem fontosak az egyszerűbb formákhoz., Szóval, valami, ami így néz ki:

Most így néz ki:

Ha meg akartam volna mutatni valakinek, hogyan válasszuk ki a Connect Mobile Device menu elemet, a második kép eltávolítja a rendetlenség pedig lehetővé teszi, hogy az ügyfél szemében koncentrálni, ahol kell.

valószínű, hogy már találkozott egyszerűsített grafikával, és nem is vette észre.,

ez Tetszik a G Suite oktatóközpont:

Van egy csomó szerszámot, de ha keresel, erős, egyszerű módon lehet létrehozni screenshotok, valamint a képernyő felvételek, Én nagyon ajánlom letölteni egy ingyenes próba rejtett akadály.

összpontosítson a megoldandó problémára

minden termék megoldja a problémát., De túl gyakran annyira szeretjük a hűvös termékjellemzőinket, csak annyit akarunk tenni, hogy kiemeljük, mit tehet, inkább azt, hogy miért van szüksége ügyfeleinknek.

győződjön meg róla, hogy megmutatja a felhasználóknak, hogyan kell feladatokat végrehajtani a termékkel.

természetesen ez magában foglalja a termék jellemzőit, de ezt abban az összefüggésben teszi, hogy segítse a felhasználót abban, hogy elsősorban a terméket vásárolta — egy adott probléma megoldásához.,

például a Camtasia és a Snagit oktatóanyagok (igen, a bemutató videók lehetnek a dokumentáció egy formája) kiemelik a konkrét funkciókat, de ezt annak összefüggésében teszik, hogy miért használhatja valaki ezt a funkciót. Ez a miért, nem csak a Hogyan.

Itt egy remek példa …

Logikai hierarchia áramlását

Jó dokumentációt kell hierarchikus osztályokból, valamint alszámok, amely lehetővé teszi, hogy a felhasználó tudja, mi minden szakasz megjeleníti őket., Ennek a hierarchiának olyan logikai folyamatot kell követnie, amely segít a felhasználónak megtanulni használni a terméket a leghasznosabb módon.

például valószínűleg nem akarja elindítani a dokumentációt azáltal, hogy megmutatja ügyfeleinek, hogyan kell használni a fejlettebb funkciókat anélkül, hogy először megmutatná nekik a termék működésének alapjait. Először kezdje az egyszerű dolgokkal, majd, ahogy a felhasználók felépítik tudásukat, mutassa meg nekik a fejlett funkciókat.,

Tartalomjegyzék

a tartalomjegyzék egyszerű, hatékony és ismerős módot biztosít ügyfeleinek arra, hogy gyorsan megoldást találjanak kérdésükre vagy problémájukra. A dokumentum elején van, így nem kell szitálniuk a szövegoldalakat, hogy megtalálják, amit keresnek. Tartalmaznia kell a fent leírt összes főbb vámtarifaszámot és alcímet.

volt idő, amikor a legtöbb felhasználói dokumentációt kinyomtatták., Most, egy olyan korban, ahol szinte mindenki hozzáfér egy okostelefonhoz, több értelme van elektronikus dokumentáció létrehozására. Ez nem jelenti azt, hogy nem hozhat létre nyomtatott verziókat is, de az elektronikus változat számos előnyt kínál, amelyeket az alábbiakban részletesebben ismertetünk.

mint egy tartalomjegyzék, a kereshető tartalom könnyebb hozzáférést biztosít a felhasználók számára az Ön tartalmához, és segít nekik saját megoldásokat találni.

Kisegítő lehetőségek

elérhető tartalom létrehozása., Ez azt jelenti, hogy az elektronikus dokumentáció megfelel azoknak az embereknek a hozzáférhetőségére vonatkozó szabványoknak, akik vakok vagy látássérültek, süket vagy hallássérültek, vagy kognitív fogyatékossággal rendelkezhetnek.

ne feledje, hogy sok ügyfelének szüksége van erre ahhoz, hogy megértse és teljes mértékben hozzáférjen a felhasználói dokumentációhoz. Ne hagyd őket hátra!

Good design

adjon meg a felhasználóknak egy dokumentumot, amelyet meg akarnak nézni, és nagyobb valószínűséggel fogják használni.

tervezési anyagok az ügyfelekkel szem előtt tartva. Legyen használható és barátságos., Kerülje a szöveg vagy oldalak hosszú bekezdéseit, amelyek túl tele vannak tartalommal. Lehetővé teszi a fehér tér, hogy segítsen szakítani a monotónia, hogy a kilátás a tanulás egy új termék kevésbé ijesztő.

tartalmazzon grafikát és képeket, amennyire csak lehetséges, hogy megmutassa, ahelyett, hogy elmondja ügyfeleinek, hogyan kell használni a terméket. Az elektronikus dokumentációhoz használjon videót és GIF-eket.

használjon következetes betűtípusokat és kiegészítő színeket több dokumentumban. Ha a szervezet rendelkezik stílus útmutatóval (amit nagyon ajánlom), győződjön meg róla, hogy dokumentációja betartja azt.,

a Snagit sablonok hihetetlenül egyszerűvé teszik a professzionális felhasználói dokumentáció létrehozását képernyőképek vagy más képek sorozatából. Egyszerűen gyűjtsd össze a szükséges képeket, válaszd a Create and Image from Template lehetőséget, és már úton vagy.

Snagit jön egy csomó ingyenes, professzionálisan tervezett sablonok, és TechSmith eszközök Snagit, kapsz hozzáférést egy csomó több!

visszajelzés valódi felhasználóktól és/vagy béta tesztelőktől

addig nem hozhat létre igazán nagyszerű felhasználói dokumentációt, amíg nem hallgatta a szervezeten kívüli embereket, akik ténylegesen használják a termékeket.,

Ismerje meg a fájdalom pontjait, és próbálja meg a lehető legjobban kezelni őket. Tudja meg, mit mondanak, hogy tudniuk kell, hogy a legjobban használni a termékeket. Bár néhány nyilvánvaló lehet, garantálom, hogy olyan dolgokat tanulsz meg,amelyeket soha nem is gondoltál.

linkek más dokumentációhoz

győződjön meg róla, hogy ügyfelei hozzáférhetnek a szervezet több erőforrásához arról, hogyan lehet sikeres a termékeivel. Az elektronikus felhasználói dokumentációhoz ez olyan egyszerű lehet, mint az oktatóanyagok, GYIK-ek, felhasználói fórumok stb.,

de még a nyomtatási dokumentáció is tartalmazhat olyan dolgokat, mint a weboldal címei és telefonszámai a további támogatáshoz.

bónusz! Add lépésről-lépésre utasításokat

lépésről-lépésre útmutatók segítenek elkerülni a hosszú szövegblokkokat, és sokkal tisztább módot biztosítanak a folyamat megjelenítésére, mint a szöveges magyarázatra. Könnyebben követhetők, könnyebben megérthetők, és sokkal felhasználóbarátabb élményt nyújtanak, mint egyszerűen elmondani valakinek, hogyan kell elvégezni a feladatot.,

és ne feledje, beleértve a vizuális tartalom a lépésről-lépésre utasításokat teszi őket még jobb.

Snagit egy szuper-könnyen használható lépés eszköz, amely segít létrehozni nagy lépésről-lépésre dokumentáció. Ráadásul a képek kombinálása eszköz lehetővé teszi, hogy az egyes képernyőképeket és más képeket egyetlen képbe egyesítse a könnyebb szerkesztéshez és jelöléshez.

Hogyan hozzunk létre nagyszerű felhasználói dokumentációt

1.lépés: terv

minden nagyszerű felhasználói dokumentumkészlet egy tervvel kezdődik., Íme néhány tipp, hogyan juthat el oda, ahová megy.

tudja, hol kezdje el

sokan azt feltételezik, hogy ha ismeri a terméket, akkor csak elkezdheti létrehozni a dokumentációt, de sokkal több megy bele. Ehelyett kezdje el egy tervet annak biztosítására, hogy valóban segítse a felhasználókat.

mielőtt dokumentációt készítene, itt van néhány szempont, amelyet figyelembe kell venni:

• mit kell tartalmaznia? Mit kell kihagyni? (Tipp: Ez az, ahol a felhasználói visszajelzések nagyon hasznos lehet!)
• milyen sorrendben kell bemutatnunk az információkat?, (Emlékszel esszé körvonalait középiskolás? Használd őket!)
• milyen egyéb források állnak rendelkezésre? Hogyan biztosítunk hozzáférést / linkeket ezekhez?
• ki felelős a dokumentum létrehozásáért? Ki felelős a dokumentumról szóló visszajelzésekért? Kinek van végleges jóváhagyása?
• le kell fordítani vagy lokalizálni?

ezekre a kérdésekre adott válaszok alakítják ki a dokumentáció elkészítésének módját. A tervezés biztosítja a zökkenőmentes folyamatot és a jobb felhasználói dokumentumot.

Ismerje meg a terméket

győződjön meg róla, hogy ismeri a terméket.,

Ez nem azt jelenti, hogy mindenben abszolút szakértőnek kell lennie, de bárki, aki felhasználói kézikönyvet vagy felhasználói útmutatót készít, gyakorlati tapasztalattal kell rendelkeznie a termékkel kapcsolatban.

támaszkodjon a tárgy szakértőire a mélyebb ismeretekre, biztosan, de tudnia kell, hogyan kell használni magad, mielőtt megpróbálna valaki mást tanítani.

válassza ki a formátumot

továbbá a dokumentum végső formátuma ugyanilyen fontos. Csak nyomtatott lesz? Elektronikus lesz? Ha igen, hol fog élni?,

nem volt túl régen, hogy szinte az összes felhasználói dokumentáció csak nyomtatott. De, hacsak nincs nagyon jó oka, azt javaslom, hogy legalább legyen elektronikus verziója a webhelyén.

A legtöbb felhasználó 24 órás hozzáféréssel rendelkezik okostelefonokhoz, számítógépekhez vagy táblagépekhez, és hozzászoktak ahhoz, hogy bármit megtaláljanak, amit tudni akarnak, amikor csak tudni akarják. Elhelyezés felhasználói erőforrások online ad számukra, bárhol is legyenek, ami azt jelenti, hogy nem kell menni keres keresztül fiókok vagy irattartó, hogy talál egy felhasználói útmutató ők évek óta nem láttam.,

továbbá egyszerűen könnyebb az elektronikus dokumentáció hozzáférhetővé tétele a fogyatékkal élők számára. A legtöbb ember számára csak nyomtatott verzió fog működni, de készen áll-e braille-verzió létrehozására olyan felhasználók számára, akik vakok vagy látássérültek lehetnek? Mi a helyzet azokkal a felhasználókkal, akiknek fizikai fogyatékosságuk van, ahol nehezen tudják manipulálni a tárgyakat a kezükkel?

léteznek olyan eszközök, amelyek megkönnyítik az elektronikus dokumentáció mindenki számára történő elérését, de a csak nyomtatott verziók sokkal nehezebb akadálymentesítési problémát jelentenek.,

plusz, az elektronikus dokumentáció sokkal könnyebb frissíteni, mivel az interneten él.

Ha letölthető PDF verziót szeretne kínálni a dokumentációból, ez rendben van. De győződjön meg róla, hogy nem PDF formátumban is elérhető a webhelyén.,

2. lépés: hozza létre a felhasználói dokumentumot

miután megválaszolta az összes kérdést, és meghozta a fent vázolt döntéseket, itt az ideje, hogy létrehozza a felhasználói dokumentációt. Nem fogom feltételezni, hogy elmondjam, hogyan kell pontosan elkészíteni az adott termék dokumentációját, de van néhány kulcsfontosságú dolog, amelyet szem előtt kell tartani.

• kerülje a zsargont és a nagyon technikai kifejezéseket, kivéve, ha feltétlenül szükséges (majd feltétlenül határozza meg őket).
• kerülje a betűszavakat, hacsak nem magyarázza meg, mit jelentenek.
• használjon általánosan elismert írási stílust, például AP vagy Chicago, amikor csak lehetséges., Ha a szervezet rendelkezik vállalati stílus útmutatóval, használja ezt.
• ne feltételezzük, hogy a felhasználó tud valamit a termékről vagy arról, hogy mit csinál. Mutasd meg nekik, mit kell tudni, hogy sikeres legyen.
• ne felejtse el használni a sima nyelvet. Írjon egy nyolcadik osztályú szintre. Még a fejlett olvasók számára is, az egyszerű nyelv gyorsabb feldolgozáshoz és jobb megértéshez vezet.
• a kialakításnak kellemesnek, nem félelmetesnek kell lennie, és be kell vonnia a felhasználót. Hogy azok használni akarják a dokumentációt.,

3. lépés: tesztelje

a Felhasználói útmutató csak akkor nagyszerű, ha segít ügyfeleinek a termék legjobb felhasználásában. És ezt nem tudhatod, amíg valaki nem használja. Mielőtt az új teremtés kimegy a világ nagy, szeretné kipróbálni. Íme néhány tipp!

• legjobb gyakorlat: adja meg a valódi felhasználók vagy béta tesztelők egy csoportjának, és nézze meg, hogyan csinálják. Helyezze be visszajelzéseit a kész dokumentumba.
• ha nincs béta tesztelési felhasználói visszajelzése, tesztelje belsőleg, lehetőleg olyan alkalmazottakkal, akik a legkevésbé ismerik a terméket.,
• visszajelzést kap a fejlesztőktől és a mérnököktől. Jobban ismerik a terméket, mint bárki más, és rámutathatnak olyan dolgokra, amelyeket esetleg elmulasztott.

4. lépés: Tartsa naprakészen a dokumentációt

amikor a termék megváltozik, mindent naprakészen kell tartania. Mint fentebb megjegyeztük, ez óriási előnyt jelent az elektronikus dokumentációnak a nyomtatással szemben. Azonban még a csak nyomtatott dokumentumok is frissíthetők és letölthetők az Ön webhelyén.

ne feledje, hogy a tartalom csak akkor nagyszerű, ha pontos. Győződjön meg róla, hogy amit ad az ügyfelek valóban segít nekik használni a terméket.,

összefoglaló

ha másra nem emlékszik, ne feledje, hogy nagyszerű felhasználói dokumentációt kell létrehozni, megtervezni és bemutatni oly módon, hogy a felhasználók számára a leghasznosabb legyen.

adjon nekik olyan dokumentációt, amely továbbra is örömmel látja őket, és biztosítja azt a vásárlói élményt, amelyet szeretne.

tegye a dokumentációt elérhetővé, hasznossá, láthatóvá.

gyakran tegyen fel kérdéseket

Megjegyzés: Ezt a bejegyzést eredetileg 2019 augusztusában tették közzé, de 2020 szeptemberében frissítették az egyértelműség és az új információk beillesztése érdekében.