a felhasználói kézikönyv vagy felhasználói útmutató egy műszaki kommunikációs dokumentum, amelynek célja a felhasználók oktatása egy adott termékről. Nyomtatott vagy digitális formában szinte bármilyen termékről írhatók, de leggyakrabban számítógépes szoftverekkel és hardverekkel, elektronikus eszközökkel és videojátékokkal.
általában műszaki írók vagy terméktervezők írják, célja a felhasználók tájékoztatása és a termékkel kapcsolatos problémák megoldása. A termékforgalmazás létfontosságú elemeként a kézikönyv minősége nagymértékben befolyásolhatja az Általános vásárlói élményt, ezért szeretné, hogy helyes legyen!
ebben a cikkben megosztom a tippeket, hogyan kell írni egy felhasználói kézikönyvet, amely egyértelműen továbbítja az információkat az ügyfeleknek, és megmutatja, hogyan szervezheti meg az írási folyamatot a Zenkitben.
tippek az írás egy felhasználói kézikönyv
van egy csomó, hogy megy írásban egy felhasználói kézikönyv. A funkciók leírásától a javítási utasításokig, a jogi részletekig és a biztonsági figyelmeztetésekig. Íme néhány tipp, hogy tartsa szem előtt, amikor az írás:
- Ismerje meg a célját
minden felhasználói kézikönyvnek célnak kell lennie. Általában ez segít a felhasználóknak a termékkel kapcsolatos problémák megoldásában, de ezzel el kell döntenie, hogyan szeretne segíteni nekik. Miután eldöntötte a kívánt szöget, bontsa le az információkat szakaszokra és lépésről lépésre, amelyek elég egyszerűek ahhoz, hogy kövessék.
- határozza meg a felhasználót
elengedhetetlen tudni, hogy milyen közönség fogja olvasni a felhasználói kézikönyvet, mivel ez befolyásolja, hogyan írja meg. Az átlagos felhasználó ismerete képet adhat arról, hogy milyen nyelvet kell használnia a felhasználói kézikönyv írásakor, a formátumot és az általános stílust. Például a tech-hozzáértő informatikai szakemberek számára történő írás nagyon különbözik a fiatal családokkal rendelkező szülők számára történő írástól.
- use accessible language
függetlenül attól, hogy ki a közönség, a nyelv a felhasználói kézikönyv szövegének hozzáférhetőnek kell lennie még a leginkább nem technikai személy. Feltételeznie kell, hogy az olvasónak nulla ismerete van a termékéről, ezért érthetőnek, világosnak és tömörnek kell lennie. Meg kell szólítania az olvasót, és korlátozni kell a zsargon használatát.
- legyen vizuális
az emberekről ismert, hogy a vizuális adatokat 60 000-szer gyorsabban dolgozzák fel, mint a szöveg, ezért szeretné, ha a felhasználói kézikönyv képeket tartalmazna. A felhasználói kézikönyvek szinte mindig tartalmaznak releváns képeket a szöveggel. Egyes termékek még a képernyőképeket is megosztják lépésről lépésre, vagy csak tisztán képek (az IKEA kézikönyvek híresen szövegmentesek). A képek valóban segíthetnek abban, hogy közvetítsék a kommunikálni kívánt üzenetet az olvasónak.
- Enhance findability
Nézz szembe vele, senki sem fogja elolvasni a teljes felhasználói kézikönyvet, így az olvasók számára, hogy értéket találjanak benne, elég egyszerűvé kell tennie, hogy az emberek átlapozhassák, és megtalálják, amit keresnek. Adjon tiszta formátumot azáltal, hogy következetes elrendezést biztosít az oldalról az oldalra, és győződjön meg róla, hogy sok hely van a szövegdarabok között. Használjon ismerős kulcsszavakat a termékhez, és győződjön meg arról, hogy a betűtípus egyszerű és olvasható.
hogyan tervezze meg a felhasználói kézikönyvet
a Zenkit nagyszerű eszköz a felhasználói kézikönyv tervezéséhez. A projektmenedzsment eszköz tele van olyan funkciókkal, amelyek lehetővé teszik az adatok gyűjtését, majd strukturálását egy optimalizált munkafolyamat létrehozásához. Íme a felhasználói kézikönyv írási folyamatának megszervezésének lépései.
1. lépés:
iratkozzon fel egy ingyenes Zenkit fiókra és jelentkezzen be.
2. lépés:
miután testre szabta profilját, kattintson az “új gyűjtemény” elemre, adjon nevet a gyűjteményének, majd nyomja meg az enter vagy a “create”gombot. Az alapértelmezett Kanban nézetre lesz irányítva.
tudod, hogy a gyűjtemény egy kis karaktert testreszabásával egy ikont is. Ehhez kattintson a gyűjtemény címére, válassza a “Testreszabás” lehetőséget, és válassza ki a kívánt színeket és ikon logót.
én személy szerint rajongója vagyok annak, hogy Kanban táblát használjak a projektterv vizuális feltérképezéséhez. A vizuális ütemezési rendszer kiválóan alkalmas a tervezési folyamat során felmerülő szűk keresztmetszetek és problémák azonosítására. Azt is kapsz egy kristálytiszta áttekintést, hogy a projekt előrehaladtával.
a Kanban nézet három alapértelmezett oszlopot mutat be, amelyek “teendők, folyamatban és kész”felirattal vannak ellátva. Az oszlopokat átnevezheti úgy, hogy egyszerűen rákattint az egyik címke nevére, majd a megjelenő menüsor név szakaszára lép. További szakaszok hozzáadásához a munkafolyamathoz csak annyit kell tennie, hogy rákattint a “+ színpad hozzáadása” gombra, címkét ad az oszlopnak, majd kattintson a “Létrehozás” gombra, vagy nyomja meg az enter billentyűt.
természetesen kiválaszthat annyi szakaszt, amennyit csak akar a munkafolyamathoz, és felcímkézheti őket, amit jónak lát. A következő szakaszokra mentem:
- Info & Resources
- Feedback & Instructions
- szekciók
- Piszkozatok
3.lépés:
miután meghatározta a munkafolyamat szerkezetét, elkezdhet más elemeket hozzáadni elemként az egyes oszlopok alá.
mint a cikk elején említettem, egy olyan projekt, mint a felhasználói kézikönyv írása, sok tartalmat tartalmaz; olyan tartalmat, amelyet különféle fejezetekre és szakaszokra, valamint szakaszokra kell bontani.
a Zenkit alelemei tökéletes funkció a nagyobb feladatok kisebbre bontásához. Az egyik projektmenedzsment eszközünk 12 egyéni mezője, strukturált módon mutatja be az összes elemet, így kezelhető idővonalon dolgozhat.
ha alelemet szeretne hozzáadni az egyik elemhez, egyszerűen kattintson az elemre a megnyitásához. Ezután kattintson a ” + “jelre, amely a megjegyzés szakasz felett található, majd válassza az “egyéni mező” lehetőséget. A” típus “szakaszban görgessen lefelé, majd válassza az” alelemek ” mezőt. Ne felejtsen el nevet adni a mezőnek!
4. lépés:
további struktúra hozzáadásához a munkafolyamathoz használhatja a Zenkit hierarchia nézetét. Ha ezt a nézetet szeretné aktiválni a gyűjteményében, kattintson a “Kanban” (vagy annak a nézetnek a neve, amelyben éppen tartózkodik) elemre, amelyet a jobb felső sarokban talál, majd válassza az “új nézet”lehetőséget. Megjelenik egy menübővítmény, amely egyszerűen kiválasztja a “hierarchia”lehetőséget.
5. lépés:
amikor először használja a hierarchia nézetet, azt fogja találni, hogy az elemek nincsenek kapcsolatban. Csatlakoztathatja őket úgy, hogy az egyes elemeket áthúzza a fő hierarchia panelre. Ha húz egy szülő elemet, azt fogja találni, hogy az alelemek együtt fognak jönni.
az elemhez rendelt hierarchia attól függ, hogy hol helyezi el. Például a tetejére húzott elemek első szintű hierarchiával rendelkeznek, a másik alá húzott elemek pedig az adott elem alelemévé válnak.
a hierarchia nézet minden egyes elemet megjelenít, amelyet hozzáadott az elemek hierarchiájához, behúzásokkal jelezve, hogy egy elem mikor válik altémává. Csak a legfontosabb feladatokról kaphat áttekintést, vagy az elemek összecsukásával vagy megnyitásával egyszerre láthat mindent a projektben.
más típusú szöveges dokumentumok és anyagok tervezése
csakúgy, mint a felhasználói kézikönyv tervezése, a Zenkit is használható más szöveges dokumentumok vagy anyagok tervezésére. A hierarchia nézet és a subitem funkció tökéletes minden olyan projekt tervezéséhez, amely nagy mennyiségű tartalmat igényel, amelyet különböző szakaszokra kell bontani, például egy regényt vagy egy főiskolai szakdolgozatot.
Regényírási terv
egy regény megírása évekig tarthat, ezért jó ötlet, ha van valahol, ahol mindent feljegyezhet. A felhasználói kézikönyv útmutatójához hasonló sablon segítségével fejezetről fejezetre strukturálhatja regényét, és nyomon követheti az összes karaktert, cselekményt és témát egy platformon.
tézis / disszertáció terv
a témaötletektől a kutatáson át az adatgyűjtésig, a tézis vagy disszertáció írása sok tervezést igényel. A Zenkit használatával mindent kezelhet, segíthet abban, hogy időben elvégezze a szakdolgozatát, és biztosítsa, hogy ne hagyja figyelmen kívül valami fontosat!
kattintson ide a dolgozat / Disszertáció tervezési sablonjának használatához.
egy nagyszerű felhasználói kézikönyv egyértelműen közli az információkat az olvasóval, hogy képesek legyenek leküzdeni a termékkel kapcsolatban felmerülő problémákat. A Zenkit használata az írási folyamat megtervezéséhez, valamint a hierarchia nézet és a subitem funkció kihasználása segíthet abban, hogy minőségi felhasználói kézikönyvet készítsen, amely a lehető legjobb élményt nyújtja ügyfeleinek.
melyik volt az utolsó hasznos felhasználói kézikönyv?
Cheers,
Dinnie és a Zenkit csapata