Vsebina

• Stopati
• 1. del od 4: Načrtovanje lastniškega priročnika
• Del 2 od 4: Vdelajte bistvene informacije
• Del 3 od 4: Opis vzdrževanja izdelka
• 4. del od 4: Napišite berljiv priročnik
• Nasveti

Programska oprema, računalniki, igre in naprave zahtevajo uporabniške priročnike; vodniki, ki pojasnjujejo, kako uporabljati izdelek (in kako se ne). Uporabniški priročnik je uradni dokument s posebno strukturo in ga mora napisati nekdo, ki izdelek pozna od znotraj, na primer tehnični pisec ali oblikovalec izdelka. Za pisanje učinkovitega uporabniškega priročnika morate vedeti, kdo bo izdelek uporabljal, in priročnik napisati z mislijo na te uporabnike. Pisanje naj bo jasno, natančno in preprosto, da zagotovite brezskrbno uporabniško izkušnjo.

Stopati

1. del od 4: Načrtovanje lastniškega priročnika

1. Naredite analizo uporabnika. Uporabniški priročnik mora biti napisan za uporabnike - tiste, ki bodo kupili vaš izdelek ali storitev in prebrali uporabniški priročnik. Analiza uporabnikov vam bo povedala, kdo bo vaša glavna ali ciljna publika, in vas vodila skozi pisanje besedila.
   • Pogovorite se z ljudmi, ki bodo uporabljali vašo napravo. Ponudite testnim uporabnikom prototipe naprave in osnutek uporabniškega priročnika pod nadzorovanimi pogoji. Prosite te testne uporabnike za povratne informacije o stvareh, ki so v uporabniškem priročniku nejasne ali zmedene, in spremenite svoj uporabniški priročnik na podlagi teh povratnih informacij.
   • Nikoli ne morete zadovoljiti celotnega občinstva; napišite priročnik po meri ciljne publike ali največje publike.
   • Upoštevajte starost, zdravje (ali imajo kakršne koli bolezni, učne težave ali motnje?) In stopnjo izobrazbe občinstva, da določite najboljši pristop k pisanju uporabniškega priročnika.
2. Uskladite zasnovo uporabniškega priročnika. Če ste bili del ekipe, ki je pomagala pri oblikovanju in razvoju naprave ali izdelka, je težko objektivno pogledati izdelek in razložiti, kako deluje. Zato morate poiskati nasvet pisca (po možnosti nekoga z izkušnjami pri pisanju navodil) in grafičnega oblikovalca, ki vam bo pomagal pri pripravi uporabniškega priročnika. Te ljudi lahko izberete prek zunanjega svetovanja ali iz lastnega podjetja ali organizacije.
3. Naredite analizo naloge. Analiza dela je postopek prepoznavanja in organiziranja korakov, potrebnih za uporabo naprave. Temeljita analiza dela opredeli materiale in opremo (kot so baterije, zdravila ali drugi izdelki, ki jih dobavi uporabnik), potrebne za posamezen korak, pa tudi ukrepe, napake in nasvete za odpravljanje težav, ki jih lahko zahtevajo posamezni koraki.
   • Če imate izdelek, ki lahko izvaja veliko različnih nalog ali podopravil, morate za vsako opravilo opraviti analizo. Na primer: v avtomobilu lahko trobite, se privežete in vklopite ali izklopite žaromete. Po potrebi naredite analizo dela za vsako od teh.
4. Prepričajte se, da vaš izdelek izpolnjuje zahteve za označevanje in dovoljenje za promet. Te zahteve zagotavljajo, da so izdelki izdelani z upoštevanjem varnosti uporabnika in da je uporabnikova izpostavljenost nevarnim pogojem, kot sta sevanje in električni udar, omejena. V oglasih mora biti jasno naveden namen in osnovne smernice delovanja izdelka, vire pa uporabite pri pisanju lastniškega priročnika.
   • Da bo uporabniški priročnik izdelka učinkovit, mora biti napisan v skladu z nalepkami, pritrjenimi neposredno na izdelek.
   • Pred pisanjem uporabniškega priročnika preverite, ali ima vaša naprava uradno licenco za prodajo.
5. Odločite se za postavitev priročnika. Navodila lahko poenostavite na več pomembnih načinov. Na začetek vsakega odseka morate postaviti krepki naslov z vsako besedo z velikimi črkami. Na primer »Nastavitev naprave«, »Upravljanje naprave« in »Odpravljanje težav« so lahko odebeljeni naslovi.
   • Drug način za poenostavitev vodnika je uporaba dveh stolpcev, enega na desni z besedilom in drugega levo od besedila, z oznakami, številkami ali majhnimi ikonami, na primer z opozorilnimi znaki ali rdečimi klicaji.
   • Priročnik je lahko sestavljen predvsem iz slik z nekaj besedila pod vsako sliko, ki pojasnjuje napravo, ali pa je pretežno besedilo z le nekaj spremnimi slikami. Za usmerjanje uporabnika lahko uporabite tudi diagram poteka. Razmislite o svojem izdelku in kako vam lahko posamezna metoda pomaga pri pisanju priročnika. Vendar se izogibajte mešanju različnih postavitev v enem priročniku. Izberite enega in se ga držite.

Del 2 od 4: Vdelajte bistvene informacije

1. Priročnik organizirajte logično. Priročnik mora biti strukturiran tako, da bo imel uporabnik od njega največ koristi. Priročnik razdelite na poglavja ali odseke, ki so smiselni za uporabo izdelka, in vključite kazalo na sprednji strani priročnika, da boste lahko hitro našli vsak odsek.
   • Kazalo je še posebej potrebno za daljše priročnike.
   • Če obstaja veliko izrazov, ki pojasnjujejo, da vaše občinstvo morda ni seznanjeno, je potreben glosar ali kazalo. Vendar glosar ni priporočljiv; najboljša izbira je razlagati zmedene izraze v samem besedilu priročnika. Če se odločite vključiti glosar, ga postavite na sprednjo stran priročnika, takoj za kazalom.
   • Seznam tabel ali slik je potreben samo, če je v priročniku več tabel ali slik.
   • Dodatek je potreben za stvari, ki jih je treba razložiti, vendar jih ni mogoče razložiti drugje v priročniku, saj bi to motilo tok in osredotočenost.
2. Vključite potrebna opozorila. Splošna opozorila ali previdnostni podatki morajo vsebovati informacije o morebitnih nevarnostih, ki jih povzroči nepravilna uporaba izdelka, vključno s smrtjo ali resnimi poškodbami. Ta opozorila naj bodo na prvi strani priročnika, za prvo stranjo, tako da jih uporabnik najprej vidi. V besedilo priročnika je treba vključiti tudi posebna opozorila tik po ali tik pred predlaganjem potencialno nevarnega koraka.
   • Na primer, splošno opozorilo za električni aparat je lahko, da ga ne uporabljate, ko dežuje.
   • Posebno navodilo bi lahko bilo, da se prepričate, da so vaše roke in naprava suhe, preden napravo priključite v električno vtičnico.
   • Navedite slike (na primer lobanjo in prečne kosti) ali besedilo druge barve (na primer rdeče besedilo), da boste opozorilo razlikovali od ostalih navodil v IFU in uporabnike opozorili nanj.
3. Opišite napravo. Opis mora vsebovati tako pisno razlago namena naprave kot tudi majhen grafični prikaz videza naprave. Na sliki naj bodo označena in poimenovana vsa stikala, gumbi in pritrdljivi deli, ki jih vsebuje naprava.
4. Navedite navodila za namestitev. Oddelek za namestitev mora vsebovati osnovne informacije o tem, kako se pripraviti na uporabo izdelka ali naprave. Če naprave ne more zgraditi ali nastaviti domači uporabnik, to jasno navedite v krepkem naslovu na vrhu namestitvenega razdelka. Vključiti morate tudi naslednje:
   • Seznam delov
   • Navodila za razpakiranje
   • Opozorila o namestitvi
   • Posledice nepravilne namestitve
   • Koga poklicati v primeru težav med namestitvijo
5. Navedite informacije o operaciji. Ta razdelek je najpomembnejši del uporabniškega priročnika in mora vsebovati konkretne podrobne informacije o uporabi naprave. Začnite z osnovnimi pripravami za uporabo enote, na primer priklopom napajalnega kabla ali umivanjem rok. Nadaljujte z logičnimi oštevilčenimi koraki, ki opisujejo, kako uporabljati napravo, in vsemi povratnimi informacijami (na primer "Slišali boste klik ..."), ki jih lahko uporabnik pričakuje pri pravilni uporabi naprave.
   • Na koncu tega poglavja je treba uporabnike napotiti na poglavje o odpravljanju težav, da rešite težave, ki jih ni mogoče hitro razložiti.
   • Po potrebi postavite slike. Nekatere korake je najbolje razložiti s slikami in besedami. Razmislite o uporabi fotografij ali ilustracij v priročniku.
   • Tako kot v katerem koli tudi v tem poglavju vključite ustrezna varnostna opozorila o nepravilni uporabi ali delovanju. Uporabnike motornih žag lahko na primer opozorite, naj ne pijejo alkohola ali uporabljajo motorne žage, medtem ko uporabljajo nekatera zdravila.
   • Če menite, da bodo uporabniki imeli koristi, vključite povezave do spletnih videoposnetkov, ki dokazujejo pravilno uporabo in delovanje naprave. Te videoposnetke lahko posnamete na začetku tega razdelka ali (v primeru videoposnetkov, ki ponazarjajo samo en korak) na koncu vsakega koraka.
6. Na koncu vključite povzetek izdelka. Povzetek se mora prikazati na koncu priročnika, tik pred indeksom, da vsebuje osnovne korake delovanja. To bi morala biti poenostavljena, skrajšana različica operativnih informacij in ne sme biti večja od ene strani. Povzemite, kako naj bo naprava ali izdelek uporabljen. Vključite osnovna opozorila, oštevilčene korake, ki pojasnjujejo, kako uporabljati izdelek, ter telefonske številke ali e-poštne naslove, ki uporabnike usmerjajo k pomoči.
   • Če pričakujete, da bo uporabnik povzetek pogosto odstranil ali se skliceval nanj, ga lahko natisnete na odstranljivo laminirano kartico ali debel karton, da bo uporabniku olajšal prenos in sklicevanje.
   • Lahko pa povzetek uporabite neposredno za izdelek, da ga uporabnik hitro in enostavno pregleda.

Del 3 od 4: Opis vzdrževanja izdelka

1. Pojasnite, kako očistite napravo. Če vašo napravo ali izdelek potrebujete za čiščenje, razložite, kako to storiti. Navedite potrebna čistila. Povejte bralcu, kako pogosto naj čisti. Nato, tako kot v katerem koli drugem delu priročnika, vključite oštevilčena navodila po korakih, kako jih očistiti.
   • Če je za čiščenje treba izdelek razstaviti ali odstraniti določen del ali dele, navedite, kako ga je treba razstaviti.
   • Opozorilo o rezultatih neuspešnega čiščenja naprave. Lahko bi na primer rekli: "Če naprave ne očistite, bo zmogljivost nižja od optimalne."
2. Štejte uporabniku, kako izvede osnovno vzdrževanje. Če izdelek ali napravo uporabnik lahko popravi, da odpravi težave z delovanjem, navedite oštevilčena navodila, kako to storiti za uporabnika. Če je na primer treba baterije zamenjati po vsakih 300 urah uporabe, navedite navodila, kako preveriti, ali je treba baterije zamenjati, kako odstraniti prazne baterije in kako namestiti nove.
   • Če obstajajo nekatere naloge vzdrževanja, ki jih lahko opravi samo pooblaščeni tehnik, del priročnika za vzdrževanje razdelite na dva dela.
3. Pogovorite se o možnostih shranjevanja. Če je potrebno, mora biti v priročniku razloženo, kako pravilno shraniti izdelek ali napravo. vključite tudi informacije o tem, zakaj je shranjevanje potrebno in posledice nepravilnega shranjevanja. Na primer: lahko bi napisali:
   • Izdelek shranjujte v hladnem in suhem prostoru. Nepravilno shranjevanje lahko skrajša življenjsko dobo izdelka zaradi kopičenja vlage. "
   • "Izdelka ne izpostavljajte vročini ali ga shranjujte pri temperaturah nad 50 stopinj Celzija.Če to storite, lahko privede do zgorevanja. "
4. Navedite informacije o odpravljanju težav. Ta razdelek lahko organizirate kot seznam pogostih težav in njihovih rešitev. Podobne probleme združite v logičen naslov. Na ta način lahko uporabniki hitro najdejo določene težave.
   • Če je na primer več težav z računalnikom, ki prikazuje modri zaslon, jih razvrstite v podnaslov, na primer "Pogoste težave z zaslonom".
   • V ta odsek morate vključiti tudi telefonsko številko in / ali e-pošto za podporo strankam.

4. del od 4: Napišite berljiv priročnik

1. Preberite druge uporabniške priročnike. Preden napišete priročnik za svoj izdelek, si oglejte druge učinkovite uporabniške priročnike. Bodite pozorni na strukturo, izbiro besed in strukturo stavkov. Glavne blagovne znamke, kot so Apple, Google in Microsoft, izdelujejo močne in učinkovite uporabniške priročnike, ki vam lahko pomagajo izdelati bolj premišljeno napisan uporabniški priročnik.
   • Ne beri samo vse uporabniški priročniki. Preberite priročnike za podobne izdelke, ki jih prodajate. Če na primer prodajate otroške izdelke, preberite otroške priročnike, ne tehničnih.
2. Izberite svoje standarde. Poenotenje črkovanja, izbire besed in besedil bo uporabniško navodilo uporabniku bolj prijazno. Čikaški priročnik sloga in Microsoftov priročnik sloga sta lahko tudi koristna slogovna vodiča pri pisanju lastniškega priročnika; preverite oba, ali je eden primeren za vaš priročnik.
   • Na primer, namesto da v priročniku uporabljate "stikalo za vklop" in "gumb za vklop", izberite enega od obeh izrazov in se ga držite.
3. Uporabite aktivni glas. Aktivni glas je način pisanja, ki razlaga stvari z vidika uporabnika. Lažje je razumeti kot alternativo, pasivni glas, v katerem je subjekt nedefiniran.
   • Preizkusite aplikacijo Hemingway (www.hemmingwayapp.com), da v svojem zapisu prepoznate pasivne odlomke.
   • Preučite ta dva vzorčna stavka - prvi je aktiven, drugi pa pasiven:
     • Paket morate odpreti počasi in previdno.
     • Embalažo je treba odpirati počasi in previdno.
4. Napišite oštevilčena navodila. Numerično urejena navodila pomagajo bralcu, da se bolje osredotoči na postopek uporabe, povezovanja ali izdelave zadevnega izdelka. Namesto da pišete dolg, podroben odstavek ali vrsto neštevilčenih odstavkov, napišite uporabniški priročnik s preprostimi, izrecnimi koraki, ki so jasno oštevilčeni.
5. Vsak korak začnite z imperativom. Imperativ je glagol, usmerjen v akcijo. Z začetkom vsakega koraka z glagolom daš bralcu namig o dejanju, ki je potrebno za dokončanje koraka. Na primer, glede na izdelek, o katerem pišete, lahko začnete korake z ukazom, kot so »Poveži«, »Potrdi« ali »Drsnik«. Ne začenjajte korakov z odzivom sistema.
   • Če na primer zaslon obarva modro in začne utripati, koraka ne začnite z: »Zaslon bo utripal in obarval modro.« Poskusite: »Pritisnite in pridržite tipko za dom. Zaslon bo utripal in postal moder. "
6. Določite, kateri besednjak boste uporabljali. Če pišete jo-jo priročnik, bodo vaše občinstvo večinoma majhni otroci. Z enostavnimi besedami in besediščem razložite, kako jo-jo deluje. Ko pišete priročnik za optični elektronski mikroskop, vaše občinstvo sestavljajo visoko usposobljeni znanstveniki, ki lahko razumejo zelo podrobne informacije, zato se ne izogibajte uporabi posebnega besedišča ali podrobnih razlag.
   • Na splošno se poskušate izogibati žargonu in tehničnemu jeziku.
   • Če želite biti učinkoviti za čim širšo bazo uporabnikov, poskusite pisati na ravni od šestega do sedmega razreda osnovne šole.
7. Ko pošiljate izdelek v tujino, se prepričajte, da so vaši prevodi točni. Najemite prevajalca, da bo vaš uporabniški priročnik prevedel v materni jezik države, v katero pošiljate izdelek. Uporabite lahko tudi spletni program za prevajanje, vendar prosite izvornega govorca, da prebere prevod in preveri, ali je prišlo do napak.
   • Če je v vaši publiki zastopanih več jezikovnih skupin, vključite prevode uporabniškega priročnika v vsak ustrezen jezik.
   • Prevajalec mora biti seznanjen z izdelkom, saj so lahko v ciljnem jeziku različne besede za določene izraze, ki niso prevodi od besede do besede.
8. Napišite v kratkih stavkih. Namesto nekaj dolgih odstavkov uporabite veliko kratkih odstavkov. Poiščite logične prelome v vsakem odseku in preberite koristne informacije v eno- ali dvostavkovnih delih. Enako velja na stavčni ravni. Naj bodo stavki kratki in preprosti, ne pa dolgi in podrobni.
   • Če je korak predolg, ga razdelite na manjše korake. To ne bo zmanjšalo števila besed, bodo pa prelomi vrstic lažje brali.
9. Preverite priročnik za napake. Priročnik lahko izgubi verodostojnost zaradi slovničnih in pravopisnih napak. Priročnik naj ureja in lektorira tudi kolega ali tehnični pisatelj. Lektor mora biti poleg črkovanja in slovnice pozoren tudi na naslednje:
   • Pasivni glas
   • Nejasen ali zmeden jezik
   • Zavita stavčna zgradba
   • Predolgi odstavki

Nasveti

• Ljudje se učijo na različne načine; Če je mogoče in primerno, v priročnik vključite vizualne pripomočke ali povezave do spletnih videoposnetkov, da boste lahko sprejeli vizualno usmerjene bralce.