A felhasználói kézikönyv létrehozása

A Felhasználói kézikönyv egy papír vagy digitális média (PDF vagy XPS formátumban) papírkönyv, amelyben az utasítások valamit használnak, vagy leírják a folyamat végrehajtására vonatkozó helyes eljárást. Bár amikor egy személy hallja a kifejezést "kézikönyv", Általában egy adott program használatának útmutatója, számítógépes és háztartási készülékekhez (TV, sztereó rendszerek, telefonok, mp3 lejátszók, kerti berendezések és t és t.D.). A jó felhasználói kézikönyv az eszköz vagy program alapvető funkcióiról szól, és megmagyarázza, hogyan kell helyesen használni, és az információ általában jól strukturált. Ez a cikk megmondja, hogy mi fontos, hogy emlékezzen a felhasználói kézikönyv létrehozásakor és végrehajtásakor.

Lépések

3. rész:
Dokumentáció létrehozása
  1. A címmel ellátott kép Használati útmutató létrehozása 1. lépés
egy. Határozza meg, ki az olvasója. Jó felhasználói kézikönyv létrehozásához meg kell értened, hogy melyik személy megvásárolja az eszközt, amelyhez utasításokat hoz létre. Rögzítheti gondolatait, de el tudod képzelni ezt a személyt. Hasznos lehet, ha csapatként dolgozik dokumentáció létrehozásához, és ha részt vesz a termékfejlesztésben a végéig a végéig. Gondolj a következőkre:
  • Ha egy személy használja a használati útmutatót: otthon, munkahelyen, az autóban, az interneten? Ez nemcsak a tartalmat, hanem a dokumentáció stílusát is meghatározza.
  • Mivel személy használja az utasításokat? Ha egy személynek csak alkalmanként szüksége van a felhasználói kézikönyvre, akkor azt jelenti, hogy az utasítást összenyomott formában kell megfogalmazni. Ha a kézikönyvet gyakran használják, különösen a kezdetektől fogva tartalmaznia kell egy egész szakaszt az eszköz vagy a szoftvertermék használatának megkezdéséhez, és írja le az összes legfontosabb jellemzőt.
  • Mennyi tapasztalat van egy személynek? Ha a termék viszonylag új vagy szignifikánsan különbözik a hasonló termékektől, olyan információkat kell tartalmaznia arról, hogy ez a termék milyen eltér a analógoktól, és részletes utasításokkal rendelkezik a felhasználónak. Ha az áruk gyakori problémákkal járnak (például nagyszámú program), írja le, mit kell tenni a probléma merül fel.
  • A címmel létrehozott kép Használati útmutató 2. lépés
    2. Írjon úgy, hogy az olvasó megértse Önt. Ha csak a terméke nem jelent szűk ismereteket a felhasználónak, akkor jobb elkerülni a technikai feltételeket, és leírja mindent egyszerű, érthető nyelv. A szövegszerkezetnek meg kell felelnie a felhasználó által előforduló kérdések sorrendjének. Javítóbb a készülék funkcióinak csoportosítása attól függően, hogy milyen feladatokat végez, és hagyja abba a legnépszerűbb funkciók egy csoportjának egyesítésének ötletét.
  • Néha lehetetlen teljesen kizárni a technikai feltételeket (például, ha utasításokat készít a grafikonok és diagramok létrehozására, ahol a szabványos források mellett a Fibonacci grafikus eszközöket is használják). Ebben az esetben hasznos meghatározni a kifejezést és egy rövid leírást (vagyis mi a Fibonacci grafika, és hogyan használják őket a pénzügyi mutatók elemzésében).
  • Kép címe Használati utasítás létrehozása 3. lépés
    3. Ismertesse azt a problémát, amellyel a felhasználó találkozhat, majd megoldást kínál. Amikor hirdetsz valamilyen terméket, kifejezéseket arról, hogy hogyan tudja megoldani egy bizonyos problémát, kétségtelenül sok figyelmet vonz. De amikor a felhasználó megvásárolja ezt a terméket, meg kell magyaráznia, mit kell tennie vele. Írja le, hogy milyen problémákkal találkozhatnak a felhasználó a működés során, és tartalmazza a folyamatban lévő problémák kézi utasításait.
  • Ha a probléma bonyolult, törje meg több részre. Készítsen egy listát, és kísérje el az egyes elem utasításait. Ezt hívják blokkok.
  • 3. rész: 3:
    A felhasználói kézikönyv kompozit részei
    1. A felhasználói kézikönyv létrehozása
    egy. Tekintsük az első oldalak első oldalait és tervezését. Meg kell hoznia egy fedelet, ha az utasítás több oldalt vesz igénybe. Szükség lesz arra is, hogy az oldalakat a szekciók nevével utasítják meg, ahol az információ teljes összege több mint 4 oldalt igényel.
    • Ha a felhasználói kézikönyvet szerzői joggal védi, a megfelelő jelzésnek a fedélen és a partíciós oldalakon kell lennie.
    • Ha a felhasználói kézikönyv bizonyos feltételeket biztosít a termék és utasítások használatához, tegye ezt az információt a fedél belsejéből.
  • Kép címe Hozzon létre egy felhasználói kézikönyvet 5. lépés
    2. Linkek a további dokumentációhoz a bevezetéshez. Ha a kézikönyv több brosúrából áll, adja meg a brosúrák összes számát az elején. Ezenkívül egy szakaszot is el kell helyeznie "A felhasználói kézikönyv használata", Ha úgy dönt, hogy ilyen szakasz szükséges.
  • Kép címe Használati útmutató létrehozása 6. lépés
    3. Ha az oldalak száma meghaladja a 10 darabot, akkor szüksége lesz egy tartalomjegyzékre.
  • A (z) Felhasználói kézikönyv létrehozása 7. lépés
    4. A használati útmutató alapja az áruk komponenseiről szóló utasításoknak és információknak kell lennie. Általában az utasítások blokkokba kerülnek, és minden egyes blokkban megadhatja, hogy melyik szakaszban meg kell keresnie a felhasználónak ezt vagy az információt. Így a felhasználó könnyebb és gyorsabb lesz, hogy megtalálja a szükséges információkat.
  • A folyamatokat egyértelműen és következetesen kell leírni. Indítsa el a feladat általános leírását, majd magyarázza el, hogy a felhasználónak meg kell tennie és milyen eredményt kell kapnia. Minden lépést meg kell számozni, és a javaslatoknak meg kell kezdeniük az igékkel.
  • A referenciaanyagoknak tartalmazniuk kell a funkciók listáját, a hibák diagnosztizálására szolgáló módszereket és a gyakran feltett kérdéseket. A felhasználói kézikönyv végén egy rövid szótárat helyezhet el a kifejezésekről és az ábécéjelre, bár a fő kifejezések gyakran az elején történnek. Az alfabetikus mutató ajánlott az utasításoknál, amelyek mennyisége meghaladja a 20 oldalt.
  • Kép címe Hozzon létre egy felhasználói kézikönyvet 8. lépés
    öt. Használjon képeket és rendszereket. A rajzok és a képernyőképek jobban leírhatják bizonyos folyamatokat, mint a szöveg, különösen akkor, ha komplex folyamatokból származik, ahol vizuális visszaigazolással kell rendelkeznie, hogy a személy mindent megtesz. A grafikus képek speciális programokban hozhatók létre: a két- és háromdimenziós rajz rendszerében, a grafikus szerkesztőkben, a fotófeldolgozó alkalmazásokban stb.D. Ha a képernyőképeket meg kell tenni, akkor a versenyző és a grafikus program személyzetének használatával érhető el, amely képes a képernyőképek mentésére.
  • Miután grafikus képet kaptunk, mentse el tömörített formátumban. Lehet, hogy csökkentenie kell a kép méretét, hogy az oldalra kerüljön, de a méret nem lehet túl kicsi, hiszen a felhasználó nem tudja megfontolni, hogyan és mit kell tenni. Szükség esetén megszakíthatja a képet több részre, és írja le mindegyiküket.
  • Ha több képet használ, ugyanolyan méretű, arányos és felbontásnak kell lennie. Az ilyen képek értesebbek és kellemesebbek lesznek az olvasó számára. A képernyőképek létrehozásakor győződjön meg róla, hogy a szabványos színsémát használja (az esetekben, ha a kézikönyv színes nyomtatása).
  • Bár a grafikus szerkesztők (például a Photoshop és a Paint Shop Pro) kényelmesek a képernyőképek létrehozásához, jobb, ha speciális programokat használnak (például Snagit), mivel lehetővé teszik számukra, hogy azonnal gyors és könnyen szerkeszthetők, mentse és aláírhatja az összeset kép.
  • 3. rész: 3:
    A kézikönyv nyilvántartása
    1. A cím kézikönyvének létrehozása 9. lépés
    egy. Válassza ki az olvasható betűtípust. Bár a számítógépek különböző betűtípusokat támogatnak, a felhasználói kézikönyvnek jól olvashatónak kell lennie, így a legegyszerűbbnek kell lennie. A legjobb, ha néhány betűtípust választanak, amelyek jól néznek ki együtt. Kétféle betűtípus létezik: Serifs és nincsenek cipők.
    • A serifek betűkészletei kis kötőjelek vannak a vonalak szélei mentén. Az ilyen betűkészletek közé tartoznak az új római, a Baskerville és a Book Antiqua. Az ilyen betűkészletek megfelelnek a 10 vagy 12 méretű és összetevő által nyomtatott nagy mennyiségű szövegből.
    • A cipők nélküli betűkészletek egyszerű vonalakkal rendelkeznek díszítés nélkül. Ezek olyan betűtípusok, mint az Arial, a Calibri és a Century Gothic. A serifek nélküli betűtípusok jobbak a 8 vagy 10 betűtípusok által nyomtatott szövegekben a PDF vagy Web dokumentum kézikönyvekben. Minél nagyobb a betűtípus, annál nehezebb olvasni cipők nélkül. Azonban ezek a betűtípusok nagy szövegekhez használhatók - például a fejlécek sorozatához. A serve betűtípusok alkalmasak a táblázatokban és oszlopokban.
    • Válasszon egyszerű betűtípusokat, mint az Arial vagy Times New Roman, bár néhány összetettebb betűtípus alkalmas az idézetre. Ha a fantasy játékhoz használó kézikönyvet írsz, kiemelheti az árvaház címcímével. Ezenkívül megengedett, hogy az idézetet dőlt betűkkel.
    • A betűtípusok kiválasztása után hozzon létre egy tesztoldalt, hogy megbizonyosodjon arról, hogy ezek a betűtípusok egymással kombinálva vannak papíron. Mutassa be ezt az oldalt olyan személynek, aki jóváhagyja az elrendezést, mielőtt megadja a kézikönyvet a nyomtatáshoz.
  • Kép címe Használati utasítás 10. lépés
    2. Gondolj ki az információs blokkok helyszínére. Ebben a szakaszban el kell döntenie, hogy milyen megrendelési információk kerülnek be.
  • Általában a felhasználó kézikönyvének és fejezetneveinek neve az oldal tetejére vagy alján helyezkedik el a számozási oldalakkal együtt. A számok külső (az oldal tetejére és alján) vagy a középső (Niza). Az egyes szakaszok első oldala eltérhet a többiektől, így az oldalainak számát az alsó közepére helyezi, és az összes többi oldal számát - kívülről.
  • Külön szövegfragmenseket izolálhatjuk színes, ha speciális blokkokat helyeznek el. Fontos, hogy olyan árnyalatot választani, amely nem érte el a szöveget.
  • Hagyja elég nagy francia bekezdéseket minden oldalról. A francia kötésből szélesebbnek kell lennie.
  • A felhasználói kézikönyv létrehozása
    3. Gondolj át a kötés típusára. Ha több mint 4 oldal van a felhasználói kézikönyvben, akkor kötelező érvényű. A belső használatra vonatkozó dokumentumok általában rögzítik a tűzőgépet a sarokban, de ha az útmutatót az árucikkrel ellátott dobozba fekteted be, akkor jobban meg kell közelítenie ezt a kérdést. Háromféle kötelező érvényű:
  • Kötőelem. Ez a típus alkalmas a 21x 27 méretű brosúrákra.5 cm, 21x35 cm vagy 11 x 27.5x42.5 cm. A leginkább olcsó használati utasítás, amely 48 oldalból áll, és kevésbé összefonódik.
  • Kötés vnakidka. Tehát az InterTwine a szokásos használati utasítások többségét, nem számolva az autókra vonatkozó utasításokat, bár néhány hosszú vezetõ is összefonódik. A Paint Shop Pro eredetileg ilyen felhasználói kézikönyvvel szállították.)
  • Kötés vezetékes spirálral. Ily módon a súlyosabb körülmények között használt kézikönyvek összefonódnak, például az utcán, ahol a tűzőkapcsok könnyen megtörhetik vagy szétszedhetnek. Néhány ilyen kötéssel történő használatra vonatkozó utasítások laminált oldalak is megtalálhatók, amelyek nem nedvesek és nem szennyeznek a szennyeződésben.
  • Felhasználói kézikönyv létrehozása 12. lépés
    4. Vegye fel a dokumentumot. A legtöbb szövegszerkesztő és program az interneten történő szöveg közzétételéhez lehetőség van az elrendezésre. A szöveg beírásakor automatikusan megjelenik a kiválasztott betűtípusban. (Ezt a cikket eredetileg a Microsoft Word sablon segítségével írták.) Ezek a programok olyan kész sablonokkal is rendelkeznek, amelyeket megváltoztathatsz, figyelembe véve az Ön igényeit, ahelyett, hogy létrehozna egy mintát a semmiből.
  • A szövegszerkesztők és a szövegek közzétételére szolgáló programok az interneten, a létrehozás funkciója is van "stílusok", Betűtípusok és munkakörök mentése asztalokhoz és láblécekhez és alapszövegekhez. Választhat már meglévő stílusokból ("Címe1", "Szokásos", "Idézet") vagy hozzon létre saját stílusát, és adja meg a nevét. Javasoljuk, hogy a programot a programban ugyanazon a rendszer mentén hívja. (Például a Microsoft Word létrehozza az ilyen neveket "Címe1", "Cím"- Ezenkívül még mindig vannak feliratok.) Állítsa be a programot előre, hogy ne kelljen visszatérni, ha szöveges írásban írja.
  • Tippek

    • Ha lehetséges, használja a mezők kódjait vagy szöveges változókat. Megváltoztathatja értékeiket (például a termék nevét, a felhasználói kézikönyv fejét), és tegye őket a dokumentumba a helyszínen, ahol általában kézzel mozog a szavakra. Amikor előnézeti a dokumentumot, vagy előkészíti azt a nyomtatáshoz, a kívánt szöveg változókba kerül. Ha az áru neve megváltozik, vagy ha úgy dönt, hogy megváltoztatja a fejezet nevét, akkor könnyebb lesz megváltoztatni a szöveget a változó értékének cseréjével.

    Amire szükséged van

    • Szövegszerkesztő vagy program az interneten történő közzétételhez
    • Grafikus szerkesztő vagy program a screenshotok létrehozásához
    Hasonló publikációk