A felhasználói kézikönyv papír vagy elektronikus (PDF vagy XPS) formátumú kézikönyv, amely utasításokat tartalmaz egy eljárással vagy valami használatával kapcsolatban. Bár a „felhasználói kézikönyvek” gyakran számítógépes alkalmazási útmutatókhoz kapcsolódnak, a felhasználói kézikönyveket számítógépekkel és más elektronikus eszközökkel, például televíziókkal, sztereó készülékekkel, telefonrendszerekkel, MP3 -lejátszókkal, valamint háztartási és kerti berendezésekkel is ellátják. A jó felhasználói útmutató a termék jellemzőiről tanítja a felhasználókat, miközben megtanítja őket a funkciók hatékony használatára. A felhasználói kézikönyv úgy van felépítve, hogy könnyen olvasható és hivatkozhasson rá. Íme néhány lépés, amelyet figyelembe kell vennie a hatékony tartalom fejlesztése és a felhasználói útmutató elrendezésének tervezése során.
Lépés
Rész 1 /3: Megfelelő felhasználói útmutató létrehozása
1. lépés Döntse el, ki fogja használni az útmutatót
Ahhoz, hogy jó felhasználói útmutatót írhasson, ki kell alakítania egy felhasználói profilt, akár formálisan, írott profil létrehozásával, akár informálisan, ha időt szán arra, hogy ésszerű feltételezéseket tegyen a felhasználói jellemzőkről. Az ilyen profilok akkor hasznosak, ha Ön része a felhasználói kézikönyv író csapatának, és amikor a tervezett terméken dolgozik a koncepciótól a végső formáig. A felhasználói profil létrehozásakor vegye figyelembe a következő tényezőket:
- A felhasználó tartózkodási helye használja az útmutatót, például otthon, az irodában, egy távoli munkahelyen vagy az autóban. Ez a tényező nemcsak a tartalmat, hanem az írási stílust is meghatározza, amelyet az útmutató elfogad.
- Hogyan használja a felhasználó az útmutatót. Ha ritkán használják, vagy csak információszerzésre van szükségük, akkor a legjobb, ha az útmutató referenciadokumentum formájában készül. Másrészt, ha a felhasználó az elején rendszeresen használni fogja, akkor a referenciarészhez mellékelni kell a „Hogyan kell kezdeni” részt, valamint a termék leggyakoribb funkcióival kapcsolatos utasításokat.
- Mennyi tapasztalata van a felhasználónak a termékkel vagy hasonló termékkel kapcsolatban. Ha a termék új vagy nagyon különbözik a hasonló termékektől, akkor magyarázatot kell adnia arra vonatkozóan, hogy ez miben különbözik a többitől, valamint utasításokat a használatára vonatkozóan. Ha a termék olyan dolgokkal foglalkozik, amelyeket a felhasználók gyakran nehéznek találnak, például számítógépes alkalmazással, akkor érthető módon kell megadnia a megfelelő információkat és részleteket.
Lépés 2. Hozzon létre egy útmutatót, amely megérti a felhasználói igényeket
Ha a felhasználók nem technikailag hozzáértő emberek, akkor valószínűleg a legjobb elkerülni a rendkívül szakszerű nyelvezetet, és világos és egyszerű magyarázatokat adni. A szöveget is úgy kell megszervezni, hogy hasonlítson a felhasználó gondolkodásához. A termékjellemzők funkció szerinti csoportosítása gyakran értelmesebb, mint a leggyakrabban használt funkciók.
Néha elkerülhetetlen a szakkifejezések használata, például olyan grafikonalkalmazásoknál, amelyek Fibonacci -diagramokat, kördiagramokat és a leggyakoribb oszlopdiagramokat tartalmaznak. Egy ilyen esetben jobb lenne, ha meghatározná a kifejezéseket és információt adna meg, például magyarázatot arra, hogy mi a Fibonacci -diagram és hogyan használják fel a pénzügyi elemzésben
3. lépés. Írja le a felhasználó által megoldandó problémát, majd adjon megoldást a problémára
A funkciók felajánlása a gyakori problémák megoldására jó, ha reklámoz egy terméket, de ha az ügyfél birtokolja a terméket, meg kell értenie, hogyan kell használni. Határozza meg a problémát, amellyel a felhasználó találkozik, írja le a használati útmutatóban, majd kövesse a megoldási utasításokat.
Ha a probléma összetett, ossza fel kisebb darabokra. Írja le az egyes szakaszokat a megoldással vagy a kezeléssel kapcsolatos utasításokkal, majd kövesse egymást sorrendben. Az információk ilyen módon történő lebontását csoportosítási vagy felosztási módszernek nevezzük
Rész 2 /3: Felhasználói útmutató összetevői
1. lépés Hozzon létre megfelelő borítót és címlapot
Szüksége lesz egy borítóra minden olyan felhasználói kézikönyv számára, amely több, mint egy referenciakártya, és egy címoldalra, amely egy olyan útmutatót tartalmaz, amely több, mint egy hajtogatott papírlapot (4 vagy több oldalt) tartalmaz.
- Ha az útmutatót szerzői jog védi, a szerzői jogi megjegyzést az első és hátsó borítón, valamint a címlapon kell feltüntetni.
- Ha az útmutató és a hozzá kapcsolódó termékek használatának feltételei vannak, kérjük, tüntesse fel azokat az előlap belső oldalán.
2. lépés. A bevezetőben tegyen hivatkozást a kapcsolódó dokumentumra
Ha egynél több felhasználói kézikönyv található, kérjük, hivatkozzon egy másik dokumentumra, beleértve a helyes verziószámot is. Az előszó egyben az „Útmutató használata” szakasz elhelyezésének helye, ha van ilyen.
Lépés 3. Ha az útmutató hosszabb, mint 10 oldal, akkor tartalmazzon tartalomjegyzéket
4. lépés Helyezze az utasításokat/eljárásokat és a referenciaanyagokat az útmutató testére
A legtöbb esetben mind az eljárásnak, mind a referenciaanyagnak külön szakasznak kell lennie. Mindazonáltal utasíthatja a felhasználókat, hogy hivatkozzanak egy adott tartalomra az egyik szakaszban, és különböztessék meg a többi résztől. Ily módon a felhasználó gyorsan megtalálhatja a keresett információt.
- Az eljárásokat egységes szerkezetben kell leírni a kézikönyvben található utasítások során. Kezdje a termék működésének áttekintésével, majd magyarázza el, mit kell tennie a felhasználónak, és milyen eredményeket fog elérni vagy látni. A lépéseket számozni kell, és egy cselekvési igével kell kezdeni, ahogy a cikk egyes szakaszaiban is írják a lépéseket.
- A referenciaanyag tartalmazhat ellenőrző listákat, hibaelhárítási tippeket és gyakran ismételt kérdéseket. Az útmutató végén szószedet és index is hozzáadható, bár az elején gyakran használt kifejezések szószedete is megtalálható. Az index elhagyható, ha az útmutató kevesebb, mint 20 oldalt tartalmaz.
5. lépés Szükség esetén használjon grafikus képeket a szöveg támogatásához
A grafikus képek vagy képernyőképek jobban szemléltethetik az útmutató egyes pontjait, mint a szöveget, különösen azokban az összetett eljárásokban, ahol a felhasználóknak vizuális megerősítésre van szükségük annak biztosításához, hogy helyesen kövessék a lépéseket. Grafikus rajzok számítógépes rajzolás (CAD) vagy grafikus szerkesztő alkalmazások, digitális fényképezőgép és fényképfeldolgozó alkalmazások használatával hozhatók létre, vagy ha képernyőképeket szeretne használni, akkor használja a számítógépbe épített képernyőkép-szolgáltatásokat vagy egy képernyőfelvételi képességgel rendelkező grafikus programot.
- Miután létrehozott egy grafikus képet, mentse tömörített formátumban, hogy szövegszerkesztő vagy asztali közzétételi alkalmazásban használhassa. Azt is csökkentenie kell a kép méretét, hogy jobban illeszkedjen az oldalhoz, de továbbra is teljes részletet kell nyújtania a felhasználó számára. (Szükség esetén az eredeti képet szakaszokra vághatja, és a vonatkozó részeket a támogató szöveggel együtt megjelenítheti).
- Ha több grafikus képet használ az eljárásban, győződjön meg arról, hogy a képek egyenletes méretben készültek, akár azonos hosszúságú és szélességű méretekben, akár az eredeti kép méretével arányosan. Így a kép vonzóbb lesz a felhasználók számára. Ugyanez vonatkozik a képernyőképek számítógépről történő készítésére is; győződjön meg arról, hogy a számítógép megjeleníti a szabványos színsémát képek készítésekor, különben a varázsló színes képernyőképet jelenít meg.
- Míg a képszerkesztő alkalmazások, mint például a Photoshop és a Paint Shop Pro jó képfelvételi képességekkel rendelkeznek, a képernyőképek készítésére szánt programok, mint például a Snagit, szintén lehetővé teszik a képernyőképek egyszerű módosítását, katalogizálását és jegyzetelését.
Rész 3 /3: Könnyen kezelhető felhasználói útmutató tervezése
1. lépés Válasszon néhány könnyen olvasható betűtípust
Bár a számítógép számos betűtípust támogat, a felhasználói útmutató létrehozásának célja könnyen olvasható. Több célnak megfelelő betűtípus kiválasztása a legjobb módja a cél elérésének. A betűtípusok két típusba sorolhatók: serif és sans serif.
- A Serif betűtípusok kis dekoratív vonalakkal rendelkeznek a betűket alkotó fővonalak végén. A serif betűtípusok közé tartozik a Times New Roman, a Baskerville és a Book Antiqua. A Serif betűtípusok tökéletesek a legtöbb szöveghez, amelyek 10-12-es méretben jelennek meg a nyomtatási útmutatók törzsében.
- A Sans serif betűtípusok csak a betűket alkotó sorokat tartalmazzák, díszítések nélkül. A sans serif csoportba tartozó betűtípusok közé tartozik az Arial, a Calibri és a Century Gothic. A Sans serif betűtípusok a legtöbb 8-10 -es szövegmérethez használhatók PDF fájlokban vagy online útmutatókban, bár a díszítetlenség megnehezíti a 12 vagy annál nagyobb betűkkel megjelenített mondatok olvasását. A betűtípusok azonban hatékonyan használhatók nagyobb méretben a címsorok és címsorok megjelenítésére, kisebb méretben pedig tökéletesek lábjegyzetekhez és számokhoz az oszlopokban és táblázatokban.
- Általában a legjobb, ha egy egyszerű betűtípust választ, mint például az Arial vagy a Times New Roman, de használhat dekoratív betűtípust idézetekhez vagy címekhez, ha útmutatót ír egy fantasy vagy sci -fi környezetben játszódó videojátékhoz.. (Idézetek esetén gyakran használhat egyszerű betűtípust, és a teljes idézetet dőlt betűvel jeleníti meg).
- Miután eldöntötte, hogy melyik betűtípust használja, hozzon létre mintaoldalakat annak ellenőrzésére, hogy jól néznek -e ki papíron. Mielőtt folytatná az írási folyamatot, ezt a mintaoldalt is meg kell mutatnia az útmutató megjelenítésének jóváhagyásáért felelős személynek.
2. lépés Gondolja át az elrendezést
Miután kiválasztotta az útmutató betűtípusát, el kell döntenie, hogyan strukturálja az oldal tetején található tartalmat.
- Általánosságban elmondható, hogy a dokumentum címét vagy fejezetcímét valószínűleg a fejlécben vagy láblécben kell elhelyezni, esetleg az oldal bal oldalán található útmutató címsorok és az oldal jobb oldalán található fejezetcímek használatával. Az oldalszámot a fejlécben vagy láblécben kell elhelyezni, akár kívül (fejléc vagy lábléc), akár középen (csak láblécben). Szükség lehet arra is, hogy megkülönböztesse minden szakasz vagy fejezet első oldalát a többi oldaltól úgy, hogy az oldalszámot a lábléc közepére, a következő oldalt pedig a fejléc külső sarkába helyezi.
- Előfordulhat, hogy a beszúrás szövegét színes dobozba vagy blokkdobozba kell helyeznie, hogy megkülönböztesse azt a szöveg többi részétől. Győződjön meg arról, hogy színt vagy blokkolási szintet választ, hogy ne nehezítse a szöveg olvasását.
- Hagyjon meglehetősen széles margót minden oldalon, és tegyen több helyet a kötendő szélein.
Lépés 3. Tekintse meg a felhasználói kézikönyv kötet típusát
Ha az útmutató hosszabb, mint 4 oldal, akkor az oldalakat bizonyos módon be kell kötni. Bár a belső dokumentumok tűzővel tűzhetők az oldal sarkában, a termékhez mellékelt külső felhasználói útmutatót általában az alábbi 3 módszer egyikével tűzik össze:
- Az oldaltűzési módszer (tűzővel az oldalára szorítva) 21 x 27,5 cm, 21 x 35 cm vagy 27,5 x 42,5 cm-es hajtogatott papírra nyomtatott vezetőkhöz. A legtöbb olcsó, legfeljebb 48 oldalas útmutatót így kötik össze.
- A nyeregvarrási módszert (az oldal szélére fűzve) gyakrabban használják harmadik féltől származó referencia-útmutatókhoz, mint az autókhoz nem tartozó termékekhez mellékelt útmutatókhoz, bár néhány hosszabb útmutató ilyen módon van kötve. (A Paint Shop Pro Guide eredetileg egy nyeregvarrási útmutatót tartalmazott, miközben még a JASC Software gyártotta).
- A spirálkötés a legmegfelelőbb a zordabb környezetben használt vezetőkhöz, például a szabadban (ebben az esetben az oldaltűzés és a nyeregvarrás nem elég erős ahhoz, hogy az oldalak elcsússzanak). Egyes spirálkötésű vezetők műanyaggal laminált oldalakat is tartalmazhatnak, amelyek megakadályozzák, hogy nedves vagy sárnak kitett állapotban megsérüljenek.
4. lépés: Hozzon létre sablon dokumentumot útmutatásként
Sok szövegszerkesztő és asztali közzétételi alkalmazás lehetőséget kínál sablonok létrehozására a felhasználói útmutatókhoz. Így gépelés közben a szöveg automatikusan megjelenik a varázsló azon részével kiválasztott betűtípussal. (Valójában ez a cikk eredetileg Microsoft Word sablon használatával készült). A legtöbb ilyen program tartalmaz egy szabványos sablonkészletet is, amelyet szükség szerint módosíthat, így nem kell saját kezűleg létrehoznia a sajátját.
