1. Lépés Egyre Általános Ismeretek a Felhasználói Kézikönyv Template
Mielőtt ténylegesen használja a Felhasználói Kézikönyv Sablon, valamint az egyéb eszközök, amelyek nem fejlesztették ki, Philip, biztos akartam lenni benne, hogy ugyanaz a kiindulási pont. Néhány általános információt adtam neki a felhasználói utasításokról, valamint néhány jó példát a meglévő felhasználói kézikönyvekről.
az alábbiakban felsoroltam ezt az információt.,
mi a felhasználói kézikönyv meghatározása?
a felhasználói kézikönyv egy műszaki kommunikációs dokumentum, amelynek célja, hogy segítséget nyújtson az embereknek a termék használatáról. Egy jó felhasználói kézikönyv segít a felhasználóknak, hogyan kell használni a terméket biztonságosan, egészségesen és hatékonyan.,
Egyéb nevek, vagy más formában, a felhasználói kézikönyv, lehet, hogy:
- Felhasználói útmutató
- Műszaki dokumentáció
- Használati útmutató
- a Működési kézikönyv
- Képzési kézikönyv
- első lépések Útmutató
- Telepítési útmutató
- Karbantartási kézikönyv
- Szoftver kézi
Emellett az elsődleges cél a felhasználói kézikönyv (hogy segítse a felhasználó), másodlagos célok lehet létrehozni egy jobb felhasználói élményt, majd a találkozó jogi követelményeknek.
a felhasználói kézikönyv szöveges vizuális információkból áll (illusztrációk, képernyőképek, táblázatok stb.,) segíti a felhasználót bizonyos feladatok elvégzésében.
a felhasználó központi szerepet játszik a felhasználói kézikönyv elkészítésekor. Egy jól kidolgozott felhasználói kézikönyv csak azokat az információkat tartalmazza, amelyek relevánsak a termék tervezett felhasználója számára.
a felhasználói kézikönyvnek tartalmaznia kell mind az eljárási információkat (lépésről lépésre), mind a koncepcionális információkat (a felhasználónak az eljárási információk megértéséhez szükséges információkat).
egy jó felhasználói kézikönyv tömör és zsargonmentes nyelvet használ. Egy jó felhasználói kézikönyvnek meg kell válaszolnia, hogyan és milyen kérdéseket., Információkat kell tartalmazniuk arról, hogy mi történik, ha egy feladatot nem végeznek megfelelően.
bizonyos esetekben a terméket különböző típusú felhasználók használják. Jellemző felhasználói típusok a végfelhasználó, a telepítő, a karbantartó mérnök és az Üzemeltető. Minden felhasználói típusnak eltérő megközelítésre van szüksége a használni kívánt nyelv, a hangszín és a fogalmi információk tekintetében.
milyen információnak kell lennie a felhasználói kézikönyvben?
a különböző típusú termékeknek felhasználói kézikönyvre van szükségük. A termék lehet rendszer, eszköz, eszköz, eszköz, eszköz, szoftver vagy alkalmazás.,arnings
hibaelhárítási szakasz és a problémák megoldására vonatkozó utasítások
MŰSZAKI ADATOK
felhasználói kézikönyv sablon használata
a felhasználói kézikönyv elkészítéséhez kifejlesztett fő eszköz egy felhasználói kézikönyv sablon., A sablon tartalmazza az összes információt a fenti listából. Megfelel a termékére vonatkozó követelményeknek.
a Felhasználói kézikönyv sablon használható a rendszer, eszköz, eszköz, eszköz vagy telepítési kézikönyv, szoftver kézikönyv, működési kézikönyv, karbantartási kézikönyv vagy képzési kézikönyv létrehozásához.
a Philip első sablonja alapján sablonokat fejlesztettünk ki a következő termékcsoportokhoz:
- orvostechnikai eszközök
- játékok
- gépek
- Elektronika
milyen formátumokkal rendelkezik a felhasználói kézikönyv?,
a felhasználói kézikönyvek papír formátumban vagy elektronikus dokumentumként (PDF vagy online vagy eszközön HTML formátumban) nyújthatók. A felhasználói kézikönyv sablon egy MS Word dokumentum, amely kinyomtatható vagy Online elhelyezhető.
felhasználói kézikönyvek segítségével lehet létrehozni a különböző eszközöket. Minden eszköznek megvannak a maga előnyei és hátrányai., a tartalom lehetséges
Minden-ban egy megoldás
Omni-platform kiadványok
Tartalmaz alapértelmezett felhasználói kézikönyv sablonok
Felhasználói kézikönyv példák
kidolgozása Közben egy felhasználói kézikönyv segítségével a Felhasználói Kézikönyv Sablon ez akkor lehet hasznos, hogy vannak jó példák., A következő linkek letölthető felhasználói kézikönyv minta dokumentáció:
- IKEA-telepítési utasításokat
- Jura felhasználói útmutató
2. Lépés Azonosítása, a Felhasználó(k) Felhasználói Kézikönyv Template
Ok, így most Philip van néhány alapvető ismeretek felhasználói kézikönyvek. Merüljünk bele a részletekbe és a tettekbe.
ha olyan kézikönyvet szeretne írni, amely segít a Felhasználónak a problémák megoldásában, először meg kell határoznia, hogy ki a felhasználó. Ezt meg lehet tenni egy felhasználói profil létrehozásával, amelyet persona-nak is neveznek.,
egy személyiséggel ésszerű feltételezéseket tesz a felhasználó jellemzőiről. Ez nem csak a felhasználói utasítások létrehozásához hasznos, hanem lényeges elem bármely termék fejlesztésének kezdetén! Képzett ipari tervezőmérnökként így kezdtük el az összes tervezési feladatot.
az ISOVOX webhely ellenőrzésekor nem találtam egyértelmű leírást a tervezett felhasználókról. Ezért kértem Philipet, hogy határozza meg a felhasználóit, és válaszoljon olyan kérdésekre, mint:
- ki a termék felhasználója?,
- a terméket professzionálisan vagy elsősorban magántulajdonban használják?
- milyen más technikai tapasztalataik vannak? Mi írja le a felhasználót?
létrehoztam egy sablont, amely tartalmazza a kérdéseket. Megkértem Philipet, hogy töltse ki a sablont.
a sablont saját maga is használhatja annak meghatározására, hogy ki a felhasználó. Felhívjuk figyelmét, hogy a második fül Philip válaszait is tartalmazza, így van egy példa arra, hogy a lapot hogyan lehet használni.
művelet: használja a sablont a felhasználó(k) leírásához.
nagy rajongója vagyok a dolgok megjelenítésének., Tehát, ha azt szeretnénk, hogy meghatározó a felhasználó egy lépéssel tovább, azt javaslom, hogy láthatóvá a felhasználó formájában egy személy. A persona létrehozásakor nevet ad a felhasználónak, életkor stb., így valódi személyré válik, aki képviseli a felhasználót.
ezt Philipért tettem., Ez az eredmény:
Akció: hozzon Létre egy megjelenítését a felhasználó
Ha többet szeretne tudni arról, hogy meghatározó a közönség létrehozása personas:
3. Lépés Létre Témákat, A Felhasználói Problémák
a Start-val azonosítja a problémákat, hogy a felhasználó(k) lehet, hogy a találkozás során az életciklus a termék, illetve, hogy a s/akarja megoldani. Jellemző problémák lehetnek: a termék telepítése, a termék használata, a termék biztonságos használata, a termék karbantartása, a termék ártalmatlanítása.,
Ha a probléma túl bonyolult, akkor darabokra bonthatja.
megkértem Philipet, hogy azonosítsa azokat a problémákat és megoldásokat, amelyekkel a felhasználó a termék életciklusa során találkozhat. Ennek érdekében létrehoztam egy másik sablont Philip számára. Az életciklus lap bal oldali oszlopában a termék életciklusának szakaszai szerepelnek. Ezek a felhasználói utasítások nemzetközi szabványából, az IEC/IEEE 82079-ből származnak. Felhasználói kézikönyv sablonjaink megfelelnek ennek a szabványnak.
az életciklus lapon láthatja, hogy Philip hogyan igazította az életciklust a saját termékéhez.,
művelet: használja ezt a sablont és az első lapon található utasításokat, hogy azonosítsa azokat a problémákat, amelyekkel a felhasználó a termék életciklusa alatt szembesülhet, és bemutassa azok megoldásait.,
Ha többet szeretne tudni arról, hogy meghatározza a felhasználói problémák létrehozása témák:
- a Témakör alapú szerzői
- a Minimalizmus
- Információk feltérképezése
- Feldarabolását
4. Lépés adjuk meg a Szerkezet a Felhasználói Kézikönyv Template
Philip már azonosította a problémák egy felhasználó lehet a termék érvényességi ideje alatt, de ő már azt hittem, az a megoldás, hogy megoldja a problémát. Más szavakkal: Philip meghatározta a felhasználói kézikönyv témáit., Minden téma csak egy konkrét témáról szólhat, azonosítható célja van, és képesnek kell lennie arra, hogy egyedül álljon.
egy témának csak egy felhasználó kérdésére kell megadnia a választ. A felhasználó egyszerre egy problémát akar megoldani. Ha a felhasználó megoldotta a problémát, akkor a következő problémát fogja megoldani.
a téma a felhasználói kézikönyv szakaszává válik. Ez lehet egy fejezet vagy egy (al)bekezdés. Amint a felhasználó választ keres a problémájára, a tartalomjegyzéket fogja használni, hogy megtudja, hogyan kell navigálni erre a válaszra.,
megkértem Philip-et, hogy strukturálja a témákat, és határozza meg a helyüket a felhasználói kézikönyvben, egy adott téma hozzárendelésével egy adott fejezethez vagy (al)bekezdéshez. Az eredmény látható a ToC lapon.
művelet: a felhasználói kézikönyv szerkezetének meghatározása:
- másolja a tartalmat az életciklus fülről a ToC fülre.
- a ToC lapon cserélje ki a termék nevét a saját termék nevére.
- adjon hozzá egy oszlopot balra. Nevezze meg “szakasz” – nak.
- adott esetben logikusan szervezze meg a szakaszokat.
- határozza meg, hogy mely témák válnak fejezetekké fejezetszámok hozzáadásával., Indítsa el a számozási előkészítő terméket a 4.számmal való használatra. A következő lépésben még néhány fejezetet adunk hozzá.
- határozza meg, hogy mely témák lesznek bekezdések a szakaszszámok hozzáadásával.
- határozza meg, hogy mely témák lesznek al-bekezdések az alszakaszszámok hozzáadásával.
most létrehozta a tartalomjegyzéket (ToC). A ToC a felhasználói kézikönyv vázlata. Később még néhány témát/szakaszt adunk hozzá, mint például a bevezetés, a biztonsági információk stb., tehát ne aggódj hozzá, hogy most.,
5. lépés Hozzon létre értelmes címsorokat
A felhasználói kézikönyv minden témája saját címet kap. A címsorok azok a (Al)címek, amelyek megelőzik a tényleges szöveget. Ezek a ToC-ban jelennek meg, így a felhasználó navigálhat a szükséges információkhoz.
tehát Philip éppen létrehozta témáinak (al-)címeit.
mivel a ToC bejegyzések ilyen fontos szerepet játszanak abban, hogy a felhasználó megtalálja az utat, és hogy segítsen nekik kihagyni, ami nem fontos, szükségük van egy kicsit több figyelmet.
alapvetően meg kell próbálnia három szintű címsorral dolgozni: első-, második – és harmadik szintű címsorokkal.,
az első szintű címsor leírja, hogy miről szól az egész fejezet vagy szakasz (pl. a termék telepítése). A második szintű fejezeteknek a “Hogyan” megfogalmazási stílust kell használniuk (például a termék összeszerelésének módját és az elektromos telepítés módját). A harmadik szintű címszó főnév-mondatokat használ (pl. csomagolási tartalom és használandó eszközök).
megkértem Fülöpöt, hogy irányítsa át a fejléceit, és vegye figyelembe a következő általános irányelveket:
- használja a szerkezetet a fent látható módon az első, második és harmadik szint fejlécéhez.,
- ellenőrizze, hogy a címsorok magától értetődőek-e. A palacsintát készítő cím sokkal felhasználóbarátabb, mint a MagicCook5000 használata.
- ellenőrizze, hogy a címsor lefedi-e a teljes témát. Ha a szakasz egy termék karbantartására és javítására terjed ki, a címkarbantartás hiányos lenne.
- ha lehetséges, próbálja meg kihagyni a cikkeket a
címsorok elején művelet: írjon Új címsorokat a ToC-bejegyzésekhez.
A Philips értelmes címsorokkal ellátott ToC-ja megtalálható a ToC W. értelmes címsorok lapon.,
6. lépés Határozza meg a jogi tartalmat
a termék forgalomba hozatalának vagy üzembe helyezésének piacától függően, valamint attól a termékcsoporttól függően, amelyhez a termék tartozik, egyedi jogszabályok vonatkoznak az Ön termékére.
általában a jogszabályok előírják, hogy a termék “biztonságos” legyen, ezért általános biztonsági követelményeket ír elő, amelyeknek a terméknek meg kell felelnie.
Ezek a követelmények tartalmazzák a felhasználói kézikönyv tartalmára és a biztonsági utasításokra vonatkozó követelményeket is.,
annak érdekében, hogy a terméket egy adott piacon értékesítse, győződjön meg róla, hogy felhasználói kézikönyve megfelel ezeknek a követelményeknek.
az alábbi két cikkből megtudhatja, hogy pontosan mely jogszabályok vonatkoznak az Ön termékére az európai és az amerikai piacon, valamint milyen követelmények vonatkoznak az Ön felhasználói kézikönyvére. Pro tipp: Ha már rendelkezésre áll megfelelőségi nyilatkozat, ott megtalálhatja a vonatkozó irányelveket.,
- Hogyan hozzunk létre megfelelő kézikönyveket az EU számára
- Hogyan hozzunk létre megfelelő kézikönyveket az Egyesült Államok számára
Philip-nek nem kellett elvégeznie ezeket a lépéseket, mivel az általa használt sablon már tartalmazta a vonatkozó irányelvek által előírt jogi tartalmat.
termékéhez a következő információk szükségesek a termék felhasználói kézikönyvéhez:
EU (vonatkozó CE-jelölési Irányelvek: LVD, EMC, RoHS, WEEE, REACH):
- a használati útmutatót le kell fordítani annak az országnak a nyelvére(nyelveire), ahol a terméket értékesítik.,
- a használati utasításban le kell írni a termék rendeltetésszerű használatát.
- a használati utasításban le kell írni a termék ésszerűen előrelátható, nem szándékos használatát.
- adott esetben meg kell említeni a lakóövezetekben való meg nem felelést.
- a termék azonosítását lehetővé tevő típust, tételszámot vagy sorozatszámot vagy egyéb elemet fel kell tüntetni a terméken. Ha a termék túl kicsi, akkor ezt be lehet helyezni a felhasználói kézikönyvbe.
- a terméken fel kell tüntetni a nevét, bejegyzett kereskedelmi nevét vagy bejegyzett védjegyét, valamint a postai címet., Ha a termék túl kicsi, akkor ezt be lehet helyezni a felhasználói kézikönyvbe.
- kockázatelemzést kell végezni a termék használatával kapcsolatos maradék kockázatok meghatározása céljából. Biztonsági információkat kell szolgáltatni annak érdekében, hogy tájékoztassák a felhasználót a meghozandó intézkedésekről.
- az WEEE-információkat fel kell tüntetni
- a csomagolási hulladékra vonatkozó információkat is.
ezen jogszabályok mellett létezik egy nemzetközi szabvány a felhasználói kézikönyvek számára, az IEC/IEEE 82079-1:2019. Ezt a szabványt az EU-ban harmonizálták., A harmonizált szabványoknak való megfelelés vélelmezi a megfelelő jogszabályoknak való megfelelést!
a felhasználói kézikönyv sablon megfelel ennek a szabványnak.
létrehoztam egy IEC 82079 ellenőrző listát is, amely felhasználható annak ellenőrzésére, hogy a felhasználói kézikönyv megfelel-e ennek a szabványnak.
a nemzetközileg megfelelő felhasználói kézikönyv létrehozásához mindig győződjön meg arról, hogy kézikönyve megfelel az EU, az USA és a 80279 követelményeinek.,
Akció: meghatározni a jogi követelmények a felhasználói kézikönyv:
- Kövesse 1-2 az EU megfelelőségi és/vagy 1-6 lépéseket a VELÜNK való megfelelés annak meghatározásához a jogi keretet az utasításokat.
- tanulmányozza az IEC 82079 ellenőrző listát annak biztosítása érdekében, hogy kézikönyve megfeleljen a 82079 szabványnak.
ebben a videóban elmagyarázom, hogyan hozhat létre olyan kézikönyvet,amely megfelel a 82079 szabványnak:
a boltba
7. lépés Töltse le és készítse el a Felhasználói kézikönyv sablont
most Philip elindíthatja a felhasználói kézikönyv tényleges létrehozását.,
megkértem, hogy állítsa be a sablon tartalmát a saját tartalomjegyzéke szerint. Természetesen a kötelező elemek eltávolítása nélkül…
emlékszel a 4. lépésből, hogy megkértem a szakaszok számozását a 4. fejezettel? Miután letöltötte a felhasználói kézikönyv sablont doc magad, látni fogja, hogy néhány szabványos fejezetet adtak hozzá, valamint néhány függeléket.,
művelet: a felhasználói kézikönyv sablonjának beállításához:
Ha az ingyenes sablonnal szeretne dolgozni:
- töltse le a Word 2013 vagy 2007 INGYENES felhasználói kézikönyv sablont
- változtassa meg a szakaszfejléceket a saját ToC szerint. Figyelem! Ne állítsa be a tartalomjegyzéket. A tartalomjegyzék automatikusan frissíthető, miután beállította a szakaszcímeket.
- adja hozzá a kötelező tartalmat a kézikönyv 6. lépésében meghatározottak szerint.
- adott esetben módosítsa az 1-3. szakaszt és a függelékeket saját igényei szerint.,
Vagy használja a fizetett sablonok, amelyek tartalmazzák az összes kötelező tartalom, mint Philip volt:
- Orvosi Eszközök EU
- Orvosi Eszközök NEKÜNK,
- Gép EU
- Gép MINKET
- Elektronika EU
- Játékok EU
8. Lépés Létre a Tartalom Az ön Felhasználói Útmutató Template
Írd meg a Rendeltetésszerű Használat
A célja, hogy a termék, vagy jobb: a rendeltetésszerű használat, a szíve egy felhasználói útmutató, valamint az alapja annak, hogy a biztonságos, egészséges a termék használata.,
a rendeltetésszerű használat leírása az Ön felelősségét is meghatározza, valamint befolyásolja a felhasználói kézikönyv további tartalmát.
a legtöbb jogszabály megköveteli, hogy a használati utasításban tartalmazza a tervezett használat leírását.
a felhasználói utasításokra vonatkozó nemzetközi szabvány, az IEC 82079-1 a következő meghatározást biztosítja a tervezett felhasználásra:
a termék szállítója által meghatározott és tervezett funkciók vagy alkalmazások kimerítő skálája
a tervezett felhasználás leírásával meghatározza a termék biztonságos borítékát., Miután meghatározta a tervezett felhasználást, összpontosíthat arra, hogy csak azokat a biztonsági és felhasználói utasításokat adja meg, hogyan kell a terméket az adott borítékban használni.
továbbá, a tervezett felhasználás, sokkal több szabványok, irányelvek és rendeletek is megkövetelik, hogy tartalmazza a leírást az ésszerűen előrelátható visszaélés.
például az agresszív mosószer ésszerűen előrelátható visszaélése lehet az élelmiszer-feldolgozási környezetben történő felhasználása.
Ha túl kevés figyelmet fordítunk az ésszerűen előrelátható visszaélések leírására, az hatással lesz a vállalat felelősségére.,
termékfelelősségi törvények / szabályozás a gyártót terheli felelősség a hibás termékért. Ha meg kell határozni a termék hibáját, minden körülményt figyelembe kell venni. Ez magában foglalja a termék ésszerűen előrelátható használatát is.
a rendeltetésszerű használat leírása határozza meg, hogy mely utasítások szerepelnek a kézikönyv többi részében. Például, ha egy hűtőrendszert csak bizonyos gyógyszerek hűtésére használnak, akkor csak ezeket az eljárásokat kell leírni.,
ha ésszerűen feltételezhető, hogy a hűtőrendszert rendszerként lehet használni a szervek hűtésére, ezt az utasításokban le kell írni. Ezzel Ön, mint gyártó, korlátozza a felelősségét, és csak arra összpontosíthat, hogy leírja, hogyan kell a rendszert a gyógyszerek hűtésére használni.
művelet: írja be a termék rendeltetésszerű használatát és és ésszerűen előrelátható helytelen használatát.
1.ábra. Ésszerűen előrelátható visszaélés?,
írja be a biztonsági figyelmeztetéseket a
kockázatelemzés alapján annak ellenére, hogy a tervezett alkalmazást egyértelműen meghatározták, ez nem jelenti azt, hogy a termék használata teljesen kockázatmentes.
a termék használatával járó veszélyek azonosításához kockázatelemzést végezhet. A kockázatelemzés bizonyos termékcsoportok esetében is kötelező lehet, mint például a kisfeszültségű berendezések, játékok, gépek és berendezések robbanásveszélyes légkörben történő használatra.
szabványokat fejlesztettek ki, mint például az ISO 12100, hogyan kell kockázatelemzést végezni., Az ISO 12100 módszert ad az enyhítési intézkedések meghozatalára is: a háromlépcsős módszer. E szerint a módszer szerint, a következő hierarchia kockázat csökkentő intézkedések:
- Eleve biztonságos tervezési intézkedések
- Védelme, valamint kiegészítő védelmi intézkedéseket
- Információk használata
Ez azt jelenti, hogy a felhasználói útmutatójában figyelmeztetni kell a maradék kapcsolatos kockázatok a termék használatát. Ez biztonsági figyelmeztetésekkel történik.,
BUY NOW
egy jó biztonsági figyelmeztetés leírja a veszélyes helyzet jellegét, annak következményeit, hogy nem kerüljük el a veszélyes helyzetet, valamint az elkerülés módszerét(módszereit).
a felhasználó által esetlegesen előforduló veszély mértékének jelzéséhez a “veszély”, “figyelmeztetés” és “Vigyázat” jelzőszavakat kell használni.
nézze meg a következő biztonsági üzeneteket:
figyelmeztetés! Forgó alkatrészek. Súlyos sérülések kockázata. Tartsa tisztán a kezét. Lockout / Tagout szervizelés előtt.
akkor figyelmeztetni szeretné a felhasználót, ha veszélyes helyzet merül fel. Az ANSI Z535.,Az 6 szabvány a felhasználói kézikönyv következő helyeit írja le, ahol ez lehet:
- külön fejezetbe csoportosítva.
- az adott szakasz első részében:
1. Csináld ezt.
2. Tedd azt. Figyelem! Ez beágyazott biztonsági üzenetek. Általános szöveg általános szöveg általános szöveg.
3. Csináld ezt.,
- az előszóban Minden kiegészítő irányelv elhelyezhető, például használat előtt olvassa el az összes utasítást, vagy tartsa meg ezeket az utasításokat a későbbi hivatkozás céljából, beilleszthető a felhasználói kézikönyv bevezetésébe.
az EU-ban a termék típusától függően csak a biztonsági információkat szabad nyomtatott formában, a többi információt pedig online megadni.
annak érdekében, hogy segítsen Philip létrehozni és elhelyezni egy biztonsági üzenetet, létrehoztam egy másik sablont.
művelet: végezzen kockázatelemzést, és készítse el biztonsági üzeneteit ezzel a sablonnal.,
hozzon létre minden más tartalmat
most megkértem Philip-et, hogy hozzon létre minden más tartalmat, például az eljárásokat, a műszaki specifikációkat és a jogi információkat.
a következő tippeket adtam:
- kizárja a felesleges anyagokat az információ túlterhelésének elkerülése érdekében (például értékesítési promóció, kiterjedt ismétlés stb.).
- győződjön meg róla, hogy a feltételek ismerősek a felhasználó számára, a műszaki jellemzők és a feltételek jól magyarázhatók és a Felhasználási feltételek következetesen.
- ismertesse azokat az előfeltételeket, amelyeket a tényleges utasítások megkezdése előtt teljesíteni kell., Ez is leírhat speciális eszközöket vagy helyet a karbantartáshoz és javításhoz.
- adjon meg fogalmi információkat, ha az információ szükséges a feladatok megfelelő megértéséhez és végrehajtásához.
- mindig írjon témát.
- minden termékelemhez használjon félkövér betűtípust.
- használjon stílus útmutató segítségével írni és formázni dokumentáció világosabb módon.
- jelölje meg, hogy mikor szeretne képet hozzáadni a későbbi jobb megértés érdekében.
- győződjön meg róla, hogy a szavak és kifejezések nem túl bonyolultak vagy túl kifinomultak.,
- használjon egyszerű / szabványosított és rövid kifejezéseket: egy mondat-egy parancs.
- ne tegyen túl sok információt egy mondatba.
- használja a direct active voice és assertive parancsokat.
- a kétértelműség elkerülése érdekében következetesen használjon olyan szavakat, mint a főnevek és az igék.
- jobb utasítások írásához használja a minimalizmus elveit a műszaki kommunikációban és egyszerűsített technikai angol nyelven.
művelet: hozzon létre minden más tartalmat a felhasználói kézikönyvhez.
ismét, a legtöbb termékcsoport számára fizetett sablonok állnak rendelkezésre, amelyek megkönnyíthetik a munkát., Ezek a sablonok minden jogi szöveget, kötelező ártalmatlanítási információt, szerzői jogi nyilatkozatot tartalmaznak, valamint megfelelnek az IEC 82079 szabványnak a felhasználói utasításokban.
helyezze a biztonsági figyelmeztetéseket a megfelelő helyzetbe
amikor a sablont használja a biztonsági üzenetek készítéséhez, megkértem Philip-et, hogy jelezze, hogy a biztonsági üzenet kiegészítő irányelv-e, vagy csoportosított, szakaszos vagy beágyazott biztonsági üzenetként kell elhelyezni.
most az összes szöveg létrejött, a biztonsági üzenetek a megfelelő helyre helyezhetők.,
művelet: helyezze az összes biztonsági üzenetet a megfelelő helyre a felhasználói kézikönyvben.
9. lépés navigáció hozzáadása a felhasználói kézikönyv sablonjához
a felhasználói kézikönyvnek segítséget kell nyújtania az embereknek a termék használatára vonatkozó információk megadásával. A felhasználó problémáját megoldó megfelelő információk megtalálása a lehető legkevesebb időt vesz igénybe.
az értelmes fejezetek készítése az egyik olyan eszköz, amely segíti a felhasználókat az információk megtalálásában., Azonban számos más eszköz is segít a felhasználónak megtalálni a kívánt információkat, mint például:
- Tartalomjegyzék
- oldalszámozás
- Index
arra kértem Fülöpöt, hogy frissítse a tartalomjegyzéket, és adjon hozzá oldalszámozást és indexet.
művelet: Tartalomjegyzék, oldalszámozás és index hozzáadása vagy frissítése.
10. lépés tekintse át a felhasználói kézikönyvet
Philip most elkészítette felhasználói kézikönyvének tervezetét a felhasználói kézikönyv sablon segítségével. Ezt a verziót szöveges tartalomtervezésnek nevezzük.,
mivel Philipnek üzleti partnere és mélyreható műszaki ismeretekkel rendelkező fejlesztője van, megkértem Philipet, hogy engedje meg, hogy vizsgálják felül a munkát eddig.
mind üzleti partnere, mind a fejlesztő visszajelzést adott. Philip ezt a visszajelzést használta a felhasználói kézikönyv optimalizálására.
művelet: küldje el a felhasználói kézikönyv tervezetét bárkinek a csapatán belül, aki képes lehet visszajelzést adni. Kérje meg őket, hogy egyesítsék az összes visszajelzést egy dokumentumba, mielőtt visszaküldenék neked. Ez ösztönzi a csapat tagjainak megbeszélését, és megakadályozza a nézeteltérést egy későbbi szakaszban.,
11. lépés hozza létre a képeket
A felhasználói kézikönyv áttekintése és optimalizálása után a szövegek többé-kevésbé meghatározottak. Ez azt jelenti, hogy most már bármilyen kép létrehozható és hozzáadható a tartalomhoz.
a szövegek készen tartásának oka az, hogy a képek létrehozása vagy szerkesztése időigényes lehet. Mivel a képeknek támogatniuk kell, helyettesíteniük vagy növelniük kell a szöveget, meg kell várniuk, hogy létrehozzák őket, amíg a szövegek véglegesek.
A felhasználói kézikönyvekben szereplő képek lehetnek illusztrációk, fényképek, képernyőképek, táblázatok, diagramok és vázlatok.,
számos nagyszerű eszköz segíthet a képek létrehozásában, például:
- Snagit vagy Adobe Photoshop képernyőképek vagy fényképek szerkesztéséhez
- Solidworks Composer vagy Google Sketchup vonalrajzok készítéséhez
- Lucidchart vagy Microsoft Visio diagramokhoz és vázlatokhoz
ne használjon fényképeket olcsó alternatívaként az illusztrációkhoz. A fényképek gyakran nem annyira informatívak, mert túl sok információt tartalmaznak. Emellett a Fotók a felhasználói kézikönyvet rendetlenné teszik.,
ezért Philip a Google Sketchup segítségével készítette illusztrációit.
művelet: hozza létre a képeket a felhasználói kézikönyvhez.
Ha többet szeretne tudni a képek készítéséről:
- szöveg, kép vagy videó használata
- IKEA-ish kézikönyvek létrehozása
12.lépés a Felhasználói kézikönyv sablon végső ellenőrzése
mielőtt elkezdjük szépnek tűnni és lefordítani a tartalmat, biztosak akarunk lenni abban, hogy a tartalom teljes.
ennek érdekében megkértem Philipet, hogy használjon ellenőrző listát.,
művelet: l ellenőrizze, hogy felhasználói kézikönyve megfelel-e az IEC 82079-1:2012 összes vonatkozó követelményének ezen ellenőrzőlista használatával.
13. Lépés tervezze meg a Felhasználói kézikönyv sablonját
egy jól megtervezett kézikönyv hozzájárul a jobb márkához és felhasználói élményhez.
a felhasználói kézikönyv sablont az MS Wordben egy vállalati logó hozzáadásával állíthatja be, és módosíthatja a betűtípust, a színeket stb., de ennek lehetnek korlátai.
Ha tudja, hogyan kell dolgozni az Adobe Indesign programmal, vagy hajlandó megtanulni vele dolgozni, ez sokkal nagyobb tervezési lehetőségeket kínál Önnek.,
létrehoztam ezt a sablont az Indesign alkalmazásban, és megkértem Philipet, hogy állítsa be, hogy megfeleljen a márka identitásának.
művelet: állítsa be a Felhasználói kézikönyv sablont, hogy illeszkedjen a márka identitásához, vagy töltse le az InDesign felhasználói kézikönyv sablont és állítsa be.
14. lépés a DTP Works
a DTP az asztali kiadást jelenti, a Wikipedia pedig úgy írja le, hogy “dokumentumok létrehozása oldalelrendezési készségekkel a személyi számítógépen elsősorban nyomtatáshoz”.
Philip most mind a felhasználói kézikönyv (Word file), mind a Felhasználói kézikönyv sablon (InDesign file) tartalmát tartalmazza., A tartalmat az InDesign sablonba kell helyezni. Ez az úgynevezett Desktop Publishing.
művelet: helyezze a Word fájl tartalmát az Indesign sablonba. Ha úgy döntött, hogy nem használja az InDesign sablont, hanem ragaszkodik a Word fájlhoz, akkor kihagyhatja ezt a lépést.
15. lépés fordítsa le és tegye közzé felhasználói kézikönyveit
attól függően, hogy milyen piacon kívánja eladni a terméket, előfordulhat, hogy le kell fordítania a felhasználói kézikönyvet.
néhány általános tipp:
- keressen hasonló tapasztalattal rendelkező fordítót., Ez lehet egy fordító, aki tapasztalt a technikai tartalom fordításában, hasonló termékekkel vagy felhasználói kézikönyvek fordításával.
- ha több nyelvre kell fordítania, a fordítóirodával való munka sok időt takaríthat meg.
- kérdezze meg a fordítót vagy az Ügynökséget a minőségi eljárásaikról, és ki fogja felülvizsgálni a szöveget a fordítás után.
- mivel Ön a legjobban ismeri a terméket, és ki a közönség, jó ötlet lehet, hogy a fordítónak vagy az Ügynökségnek szószedet vagy listát adjon a használni kívánt terminológiával.,
- Keressen egy fordítót, aki közvetlenül a Word vagy az InDesign fájlban dolgozhat, vagy kereshet egy ügynökséget, amely képes a DTP működését is elvégezni. Alternatív megoldásként természetesen ezt is megteheti.
mivel Philip mind az Egyesült Államokban, mind az EU-ban eladja termékeit, úgy döntött, hogy egy ügynökséggel dolgozik.
művelet: keressen olyan fordítót vagy ügynökséget, amely megfelel az Ön igényeinek, és lefordítsa a felhasználói kézikönyvet.
általában a felhasználói kézikönyvnek olyan formátumban kell rendelkezésre állnia, amely könnyen elérhető a felhasználó számára. Ez lehet nyomtatni, vagy használható online vagy on-device.,
mivel a Felhasználó információt szeretne abban a pillanatban, amikor szüksége van rá, és így nem gondolkodik a csatornákon, a legjobb megközelítés az lenne, ha az utasításokat omni-platform.
Az Európai Unióban egyes termékcsoportok esetében továbbra is korlátozott a termékkel nyomtatott felhasználói kézikönyv biztosítása.
2016 áprilisától azonban számos termékcsoport utasításai más formátumban, nem pedig nyomtatásban továbbíthatók. Van azonban egy kivétel.
A biztonsági információkat továbbra is papír formában kell kézbesíteni a termékkel együtt., Emellett a fogyasztó kérésére a fogyasztó rendelkezésére kell bocsátani egy papír felhasználói kézikönyvet.
Philip úgy döntött, hogy a következő:
- ő biztosítja a nyomtatott teljes kézikönyv a termék, beleértve a biztonsági utasításokat.
- külön gyorsindítási útmutatót készített a termékhez is.
- a teljes kézikönyv PDF verzióját helyezte el online.
- létrehoz egy online súgó részt a webhelyén a felhasználói kézikönyv HTML verziójával. Itt videókat is hozzáadhat., A keresőmotorok HTML verziójának optimalizálásával megkönnyíti a felhasználó számára, hogy információt találjon a felhasználó számára
következtetés
Ez minden. Így készített Philip egy megfelelő felhasználói kézikönyvet a felhasználói kézikönyvek sablonjának segítségével, valamint az általam biztosított egyéb elérhető eszközökkel.
ennek a legjobb része az, hogy ugyanazokat az eredményeket kaphatja meg, mint Philip, ha követi ezt a lépésről lépésre a felhasználói kézikönyv létrehozásának folyamatát.