Sadržaj

• Kročiti
• Dio 1 od 4: Planiranje korisničkog priručnika
• Dio 2 od 4: Ugraditi bitne informacije
• Dio 3 od 4: Opisivanja održavanja proizvoda
• Dio 4 od 4: Napišite čitljiv priručnik
• Savjeti

Softver, računala, igre i uređaji zahtijevaju korisničke upute; vodiči koji objašnjavaju kako koristiti proizvod (i kako ne). Korisnički priručnik formalni je dokument s određenom strukturom i mora ga napisati netko tko proizvod poznaje iznutra, poput tehničkog pisca ili dizajnera proizvoda. Za pisanje učinkovitog korisničkog priručnika potrebno je znati tko će koristiti proizvod i napisati priručnik imajući na umu te korisnike. Neka vaše pisanje bude jasno, precizno i ​​jednostavno kako biste osigurali korisničko iskustvo bez muke.

Kročiti

Dio 1 od 4: Planiranje korisničkog priručnika

1. Napravite analizu korisnika. Korisnički priručnik trebao bi biti napisan za korisnike - one koji će kupiti vaš proizvod ili uslugu i pročitati korisnički priručnik. Analiza korisnika reći će vam tko će biti vaša glavna ili ciljna publika i vodit će vas kroz pisanje teksta.
   • Razgovarajte s ljudima koji će koristiti vaš uređaj. Ponudite testnim korisnicima prototipove uređaja i nacrt korisničkog priručnika u kontroliranim uvjetima. Zatražite od ovih testiranih korisnika povratne informacije o stvarima koje su nejasne ili zbunjujuće u korisničkom priručniku i na temelju tih povratnih informacija napravite promjene u svom korisničkom priručniku.
   • Nikada ne možete zadovoljiti cijelu svoju publiku; napisati priručnik prilagođen ciljanoj publici ili najvećoj publici.
   • Uzmite u obzir dob, zdravlje (imaju li bolesti, teškoće u učenju ili invaliditet?) I razinu obrazovanja publike kako bi se utvrdio najbolji pristup pisanju korisničkog priručnika.
2. Koordinirati dizajn korisničkog priručnika. Ako ste bili dio tima koji je pomagao u dizajniranju i razvoju uređaja ili proizvoda, može biti teško objektivno pogledati proizvod i objasniti kako on funkcionira. Stoga biste trebali potražiti savjet pisca (po mogućnosti nekoga s iskustvom u pisanju uputa) i grafičkog dizajnera koji će vam pomoći u pripremi korisničkog priručnika. Te biste ljude mogli birati putem vanjskog savjetovanja ili iz vlastite tvrtke ili organizacije.
3. Napravite analizu zadatka. Analiza posla postupak je identificiranja i organiziranja koraka potrebnih za upotrebu uređaja. Temeljita analiza posla identificira materijale i opremu (poput baterija, lijekova ili drugih proizvoda koje isporučuje korisnik) potrebnih za svaki korak, kao i radnje, pogreške i savjete za rješavanje problema koji bi mogli zahtijevati svaki korak.
   • Ako imate proizvod koji može izvoditi mnogo različitih zadataka ili podzadataka, za svaki zadatak morate izvršiti analizu zadatka. Na primjer: u automobilu možete zatrubiti, vezati se i uključiti ili isključiti prednja svjetla. Ako je potrebno, napravite analizu posla za svaku od njih.
4. Provjerite ispunjava li vaš proizvod zahtjeve za označavanje i odobrenje za stavljanje u promet. Ovi zahtjevi osiguravaju da se proizvodi proizvode s korisnikovom sigurnošću na umu i da je izloženost korisnika opasnim uvjetima, poput zračenja i strujnog udara, ograničena. Oglasi bi trebali jasno navesti svrhu i osnovne smjernice rada proizvoda, a vi biste ih trebali koristiti prilikom pisanja korisničkog priručnika.
   • Da bi korisnički priručnik za proizvod bio učinkovit, mora biti napisan u skladu s naljepnicama koje su izravno pričvršćene na proizvod.
   • Prije pisanja korisničkog priručnika provjerite je li vaš uređaj službeno licenciran za prodaju.
5. Odlučite o izgledu vašeg priručnika. Postoji nekoliko važnih načina na koje možete pojednostaviti svoj priručnik. Na početku svakog odjeljka morate staviti podebljani naslov uz svaku riječ velikim slovima. Na primjer, "Postavljanje uređaja", "Upravljanje uređajem" i "Rješavanje problema" svi mogu biti podebljani naslovi odjeljaka.
   • Drugi način za pojednostavljivanje vodiča je upotreba dva stupca, jedan s desne strane s tekstom, a drugi s lijeve strane teksta, s oznakama, brojevima ili malim ikonama, poput znakova upozorenja ili crvenih uskličnika.
   • Priručnik se može sastojati uglavnom od slika s nekim tekstom ispod svake slike kako bi se objasnio uređaj, ili može biti uglavnom tekst sa samo nekoliko pratećih slika. Također možete koristiti dijagram toka za usmjeravanje korisnika. Razmislite o svom proizvodu i kako vam svaka metoda može pomoći u pisanju priručnika. Međutim, izbjegavajte miješanje različitih izgleda unutar jednog priručnika. Odaberite jedan i držite se njega.

Dio 2 od 4: Ugraditi bitne informacije

1. Priručnik organizirajte logično. Priručnik bi trebao biti strukturiran na takav način da će korisnik imati najviše koristi od njega. Podijelite priručnik u poglavlja ili odjeljke koji imaju smisla za uporabu proizvoda i uključite sadržaj na prednjoj strani priručnika kako bi se svaki odjeljak mogao brzo pronaći.
   • Sadržaj je posebno potreban za duže upute.
   • Pojmovnik ili indeks potreban je ako postoji mnogo pojmova koji objašnjavaju da vaša publika možda nije upoznata. Međutim, pojmovnik se ne preporučuje; najbolji je izbor objasniti zbunjujuće pojmove u samom tekstu priručnika. Ako odlučite uključiti pojmovnik, stavite ga na prednju stranu priručnika, odmah iza sadržaja.
   • Popis tablica ili slika potreban je samo ako je u priručniku više od nekoliko tablica ili slika.
   • Dodatak je potreban za stvari koje treba objasniti, ali ne mogu se objasniti drugdje u priručniku, jer bi to poremetilo tok i fokus.
2. Uključite potrebna upozorenja. Opća upozorenja ili podaci o mjerama predostrožnosti trebaju pružiti informacije o potencijalnim opasnostima uzrokovanim nepravilnom uporabom proizvoda, uključujući smrt ili ozbiljne ozljede. Ova upozorenja trebaju biti postavljena na prednju stranu priručnika, nakon naslovnice, tako da ih korisnik prvo vidi. Posebna upozorenja također trebaju biti uključena u tekst priručnika neposredno nakon ili neposredno prije nego što se predloži potencijalno opasan korak.
   • Na primjer, općenito upozorenje za električni aparat može biti da ga ne koristite kad pada kiša.
   • Određena uputa može biti kako biste bili sigurni da su vam i ruke i uređaj suhi prije nego što ga uključite u utičnicu.
   • Navedite slike (poput lubanje i prekriženih kostiju) ili tekst druge boje (poput crvenog teksta) kako biste upozorenje razlikovali od ostalih uputa u IFU-u i skrenuli pozornost korisnika na to.
3. Opišite uređaj. Vaš opis treba sadržavati i pismeno objašnjenje svrhe uređaja i mali grafički prikaz kako uređaj izgleda. Na slici trebaju biti označeni i imenovani svi prekidači, tipke i dijelovi koji se mogu pričvrstiti u uređaju.
4. Navedite upute za instalaciju. Odjeljak za instalaciju trebao bi sadržavati osnovne informacije o tome kako se pripremiti za upotrebu proizvoda ili uređaja. Ako uređaj ne može izraditi ili postaviti kućni korisnik, to jasno navedite podebljanim naslovom na vrhu odjeljka za instalaciju. Također biste trebali uključiti sljedeće:
   • Popis dijelova
   • Upute za raspakiranje
   • Upozorenja o instalaciji
   • Posljedice netočne instalacije
   • Koga nazvati u slučaju poteškoća tijekom instalacije
5. Navedite informacije o operaciji. Ovaj je odjeljak najvažniji dio korisničkog priručnika i trebao bi pružiti konkretne, detaljne informacije o načinu korištenja uređaja. Započnite s osnovnom pripremom za uporabu jedinice, poput uključivanja kabela za napajanje ili pranja ruku. Nastavite s logičnim, numeriranim koracima koji opisuju kako koristiti uređaj, kao i bilo kakve povratne informacije (na primjer, "Čut ćete klik ...") koje korisnik može očekivati ​​kada pravilno koristi uređaj.
   • Na kraju ovog poglavlja, korisnike treba uputiti na poglavlje o rješavanju problema radi rješavanja problema koji se ne mogu brzo objasniti.
   • Po potrebi postavite slike. Neke korake najbolje je objasniti slikama i riječima. Razmotrite upotrebu fotografija ili ilustracija u vašem priručniku.
   • U ovaj odjeljak, kao i u bilo koji odjeljak, trebali biste uključiti relevantna sigurnosna upozorenja o nepravilnoj uporabi ili radu. Na primjer, možete upozoriti korisnike motorne pile da ne piju alkohol ili ne koriste motornu pilu dok su na određenim lijekovima.
   • Ako mislite da će korisnici imati koristi, razmislite o uključivanju veza do mrežnih videozapisa koji pokazuju pravilnu upotrebu i rad uređaja. Te videozapise možete snimiti na početku ovog odjeljka ili (u slučaju videozapisa koji ilustriraju samo jedan korak) na kraju svakog koraka.
6. Na kraju priložite sažetak proizvoda. Sažetak bi se trebao pojaviti na kraju priručnika, neposredno prije indeksa, kako bi pružio osnovne radne korake. Ovo bi trebala biti pojednostavljena, uklonjena verzija operativnih informacija i trebala bi imati najviše jednu stranicu. Sažeti kako će se uređaj ili proizvod koristiti. Uključite osnovna upozorenja, numerirane korake koji objašnjavaju kako koristiti proizvod te telefonske brojeve ili adrese e-pošte koje korisnike usmjeravaju na pomoć.
   • Ako očekujete da će korisnik često uklanjati ili upućivati ​​na sažeti list, možete ga ispisati na uklonjivu laminiranu karticu ili debeli karton kako biste ga lakše nosili i upućivali.
   • Alternativno, sažetak možete primijeniti izravno na proizvod za brzu i jednostavnu referencu korisnika.

Dio 3 od 4: Opisivanja održavanja proizvoda

1. Objasnite kako očistiti uređaj. Ako vaš uređaj ili proizvod trebaju čišćenje, objasnite kako to učiniti. Navedite potrebna sredstva za čišćenje. Recite čitatelju koliko često treba čistiti. Zatim, kao i u bilo kojem drugom dijelu priručnika, dodajte numerirane detaljne upute o načinu čišćenja.
   • Ako čišćenje zahtijeva rastavljanje proizvoda ili uklanjanje određenog dijela ili dijelova, navedite kako proizvod treba rastaviti.
   • Dajte upozorenje o rezultatima neuspjelog čišćenja uređaja. Na primjer, mogli biste reći: "Ako se uređaj ne očisti, performanse će biti manje od optimalne."
2. Brojte korisnika kako treba obaviti osnovno održavanje. Ako proizvod ili uređaj korisnik može servisirati radi ispravljanja problema s performansama, navedite numerirane upute kako to učiniti za korisnika. Primjerice, ako baterije treba zamijeniti nakon svakih 300 sati uporabe, navedite upute kako provjeriti treba li baterije zamijeniti, kako ukloniti ispražnjene baterije i kako instalirati nove.
   • Ako postoje određeni zadaci održavanja koje može izvoditi samo ovlašteni tehničar, podijelite dio priručnika za održavanje u dva dijela.
3. Raspravite o mogućnostima pohrane. Ako je potrebno, priručnik treba objasniti kako pravilno skladištiti proizvod ili uređaj. trebali biste uključiti i informacije o tome zašto je skladištenje potrebno i posljedice nepravilnog skladištenja. Na primjer: mogli biste napisati:
   • Proizvod čuvajte na hladnom i suhom mjestu. Nepravilno skladištenje može skratiti vijek vašeg proizvoda zbog nakupljanja vlage. "
   • "Ne izlažite proizvod grijanju niti ga čuvajte na temperaturama višim od 50 Celzijevih stupnjeva.Ako to učinite, to može dovesti do izgaranja. "
4. Navedite informacije o rješavanju problema. Ovaj odjeljak možete organizirati kao popis uobičajenih problema i njihovih rješenja. Grupirajte slične probleme pod logički naslov. Na taj način korisnici mogu brzo pronaći određene probleme.
   • Na primjer, ako postoji nekoliko problema s računalom koji prikazuje plavi zaslon, grupirajte ih u podnaslov, na primjer "Uobičajeni problemi sa zaslonom".
   • U ovaj odjeljak morate uključiti i telefonski broj i / ili e-poštu za korisničku podršku.

Dio 4 od 4: Napišite čitljiv priručnik

1. Pročitajte ostale korisničke upute. Prije pisanja priručnika za vlastiti proizvod, pogledajte druge učinkovite korisničke vodiče. Obratite pažnju na strukturu, izbor riječi i strukturu rečenice. Glavne marke kao što su Apple, Google i Microsoft proizvode jake, učinkovite korisničke vodiče koji vam mogu pomoći u stvaranju promišljenijeg korisničkog vodiča.
   • Nemojte samo čitati svi korisničke upute. Pročitajte priručnike za slične proizvode koje prodajete. Primjerice, ako prodajete dječje proizvode, pročitajte dječje priručnike, a ne tehničke.
2. Odaberite svoje standarde. Standardiziranje pravopisa, izbora riječi i formulacija učinit će korisnički priručnik jednostavnijim za upotrebu. Čikaški priručnik za stil i Microsoftov priručnik za stil također mogu biti korisni vodiči za stil prilikom pisanja vašeg korisničkog priručnika; provjerite oboje da li je jedan prikladan za vaš priručnik.
   • Na primjer, umjesto da u svom priručniku koristite i "prekidač za uključivanje" i "gumb za uključivanje", odaberite jedan od dva izraza i pridržavajte se toga.
3. Koristite aktivni glas. Aktivni glas je način pisanja koji objašnjava stvari iz perspektive korisnika. Lakše je razumjeti od alternative, pasivnog glasa, u kojem je subjekt nedefiniran.
   • Isprobajte aplikaciju Hemingway (www.hemmingwayapp.com) da biste prepoznali pasivne dijelove u svom pisanju.
   • Proučite ove dvije uzorke rečenica - prva je aktivna, a druga pasivna:
     • Paket morate otvoriti polako i pažljivo.
     • Pakiranje treba otvarati polako i pažljivo.
4. Napišite upute s brojevima. Numerički poredane upute pomažu čitatelju da se bolje usredotoči na postupak upotrebe, povezivanja ili izrade predmetnog proizvoda. Umjesto da napišete dugačak, opširan odlomak ili niz nebrojenih odlomaka, napišite svoj korisnički vodič jednostavnim, eksplicitnim koracima, od kojih su svi jasno numerirani.
5. Započnite svaki korak imperativom. Imperativ je glagol usmjeren na radnju. Započinjući svaki korak glagolom, čitatelju dajete savjet o radnji potrebnoj za dovršetak koraka. Na primjer, ovisno o proizvodu o kojem pišete, korake možete započeti naredbom poput "Poveži", "Potvrdi" ili "Kliži". Međutim, nemojte započeti korake odgovorom sustava.
   • Na primjer, ako zaslon postane plav i počne treptati, ne započinjte korak sa: "Zaslon će treptati i postajati plav." Pokušajte: "Pritisnite i držite tipku za početni zaslon. Zaslon će treptati i postat će plav. "
6. Odredite koji ćete rječnik koristiti. Ako pišete yo-yo priručnik, vaša će publika uglavnom biti mala djeca. Upotrijebite jednostavne riječi i rječnik da biste objasnili kako yo-yo djeluje. Kada pišete priručnik za skenirajući elektronski mikroskop, vašu publiku čine visoko kvalificirani znanstvenici koji mogu razumjeti vrlo detaljne informacije, zato nemojte bježati od korištenja specijaliziranog rječnika ili nijansiranih objašnjenja.
   • Općenito, pokušavate izbjegavati žargon i tehnički jezik.
   • Da biste bili učinkoviti za najširu moguću bazu korisnika, pokušajte pisati na razini od šestog do sedmog razreda osnovne škole.
7. Kada isporučujete proizvod u inozemstvo, pripazite da su vaši prijevodi točni. Angažirajte prevoditelja da prevede vaš korisnički priručnik na materinski jezik zemlje u koju šaljete svoj proizvod. Također možete koristiti mrežni program za prijevod, ali zamolite izvornog govornika da pročita prijevod i provjeri ima li pogrešaka.
   • Ako je u vašoj publici zastupljeno više jezičnih skupina, uključite prijevode korisničkog priručnika na svaki relevantni jezik.
   • Prevoditelj mora biti upoznat s proizvodom jer u ciljanom jeziku mogu postojati različite riječi za određene pojmove koji nisu prijevodi od riječi do riječi.
8. Napišite u kratkim rečenicama. Umjesto nekoliko dugih odlomaka, koristite puno kratkih odlomaka. Potražite logične prijelome u svakom odjeljku i probavite korisne informacije u dijelovima od jedne ili dvije rečenice. Isto vrijedi i na razini rečenice. Neka vaše rečenice budu kratke i jednostavne, a ne duge i opširne.
   • Ako korak postaje predug, raščlanite ga na manje korake. To neće smanjiti broj riječi, ali prijelomi redaka olakšat će čitanje.
9. U priručniku provjerite ima li pogrešaka. Priručnik može izgubiti vjerodostojnost zbog gramatičkih i pravopisnih pogrešaka. Neka kolega ili tehnički pisac također uređuje i lektorira priručnik. Pored pravopisa i gramatike, lektor treba obratiti pažnju na sljedeće:
   • Pasivni glas
   • Nejasan ili zbunjujući jezik
   • Umotana struktura rečenice
   • Predugi odlomci

Savjeti

• Ljudi uče na različite načine; Ako je moguće i prikladno, u priručnik uključite vizualna pomagala ili poveznice do mrežnih videozapisa za smještaj vizualno orijentiranih čitatelja.