Kako napraviti korisnički priručnik: 12 koraka

Korisnički priručnik je u papiru ili digitalnim medijima (u PDF ili XPS formatu) u kojem upute za upotrebu nečega ili opisuju ispravan postupak za obavljanje procesa. Iako kada osoba čuje frazu "priručnik", Obično predstavlja vodič za upotrebu određenog programa, upute za uporabu računarskih i kućanskih aparata (televizori, stereo sistemi, telefoni, MP3 playeri, vrtna oprema i t.D.). Dobar korisnički priručnik govori o osnovnim funkcijama uređaja ili programa i objašnjava kako ih pravilno koristiti, a informacije su obično dobro strukturirane. Ovaj članak će reći o onome što je važno zapamtiti se prilikom kreiranja i izvršenja korisničkog priručnika.

Korake

Dio 1 od 3:

Izrada dokumentacije

jedan. Odredite ko je vaš čitalac. Da biste stvorili dobar korisnički priručnik, morate razumjeti koja će osoba kupiti uređaj na koji kreirate upute. Možete snimiti svoje misli, ali možete samo zamisliti ovu osobu. Korisno je učiniti ako radite kao tim za kreiranje dokumentacije i ako sudjelujete u razvoju proizvoda od samog početka do kraja. Razmislite o sljedećem:

Ako će osoba koristiti upute za uporabu: kod kuće, na poslu, u autu, na internetu? To će odrediti ne samo sadržaj, već i stil dokumentacije.
Kao osoba će koristiti upute? Ako osoba treba samo povremeno pogledati korisnički priručnik, to znači da uputstvo mora biti uokvirena u komprimiranom obliku. Ako se priručnik često koristi, posebno na samom početku, trebali biste uključiti cjelovit odjeljak o tome kako početi koristiti uređaj ili softverski proizvod i opisati sve najvažnije karakteristike.
Koliko iskustva treba imati osobu? Ako je vaš proizvod relativno nov ili značajno razlikuje od sličnih proizvoda, morat ćete uključiti podatke o tome kako se ovaj proizvod razlikuje od analoga i pružaju korisniku detaljne upute. Ako je roba povezana sa čestim problemima (na primjer, s velikim brojem programa), opišite što treba učiniti kada se pojavi problem.

Slika pod nazivom Kreirajte korisnički priručnik Korak 2

2. Pisati tako da vas čitalac razumije. Ako samo vaš proizvod ne podrazumijeva usko znanje korisnika, bolje je izbjeći tehničke uvjete i opisati sve jednostavan, razumljiv jezik. Tekstualna struktura mora biti u skladu s nizom pitanja koja mogu dogoditi korisnik. Tačnije je grupirati funkcije uređaja, ovisno o zadacima koje izvodi i napuštaju ideju ujedinjavanja u jednoj grupi najpopularnijih funkcija.

Ponekad je nemoguće potpuno isključiti tehničke izraze (na primjer, ako uputite upute za izradu grafova i dijagrama, gdje se uz standardne fondove koriste i fibonaccijem grafički instrumenti). U ovom je slučaju korisno definirati izraz i kratak opis (to je ono što je Fibonacci grafika i kako se koriste u analizi finansijskih pokazatelja).

Slika pod nazivom Kreirajte korisnički priručnik Korak 3

3. Opišite problem s kojim se korisnik može susresti, a zatim ponuditi rješenje. Kada oglasite neku vrstu proizvoda, fraze o tome kako može riješiti određeni problem nesumnjivo privući puno pažnje. Ali kada korisnik kupi ovaj proizvod, on treba objasniti što s tim. Opišite, sa kojim problemima se korisnik može susresti tokom rada i uključiti u ručne upute za tekuće probleme.

Ako je problem komplikovan, razgradite ga na nekoliko dijelova. Napravite listu i pratite svake upute za stavku. To se zove blokovi.

Dio 2 od 3:

Kompozitni dijelovi korisničkog priručnika

jedan. Razmotrite poklopac i dizajn prvih stranica odjeljaka. Trebat ćete stvoriti poklopac ako upute zauzme nekoliko stranica. Također će biti potrebno postaviti stranice s nazivom odjeljka za upute, gdje ukupni iznos informacija traje više od 4 stranice.

Ako je korisnički priručnik zaštićen autorskim pravom, odgovarajuća indikacija mora biti na poklopcu i na particijskim stranicama.
Ako korisnički priručnik pruža određene uvjete za korištenje proizvoda i uputstava za njega, postavite ove informacije s unutarnje strane poklopca.

Slika pod nazivom Kreirajte korisnički priručnik Korak 5

2. Veze na dodatnu dokumentaciju Mjesto u uvodu. Ako se priručnik sastoji od nekoliko brošura, na početku navedite sav broj brošura. Pored toga, trebalo bi da se takođe stavi i odeljak "Kako koristiti ovaj korisnički priručnik", Ako odlučite da je takav odjeljak potreban.

Slika pod nazivom Kreirajte korisnički priručnik Korak 6

3. Ako broj stranica prelazi 10 komada, trebat će vam tabela sadržaja.

Slika pod nazivom Kreirajte korisnički priručnik korak 7

4. Osnova upute za uporabu treba biti uputstva i informacije o komponentama robe. U pravilu se upute razbije u blokovima, a u svakom bloku možete odrediti u kojim se dijelovima korisnik treba potražiti za to ili te informacije. Dakle, korisnik će biti lakši i brži pronaći informacije koje su im potrebne.

Procesi trebaju biti opisani jasno i dosljedno. Započnite s općim opisom zadatka, a zatim objasnite da će korisnik trebati učiniti i koji će rezultat morati dobiti. Svi koraci moraju biti numerirani, a prijedlozi trebaju započeti s glagolima.

Referentni materijali trebaju sadržavati listu funkcija, metode za dijagnosticiranje grešaka i često postavljanih pitanja. Na kraju korisničkog priručnika možete postaviti kratki rečnik pojmova i abecedni pokazivač, iako se glavni uvjeti često donose na početku. Abecedni pokazivač preporučuje se za upute čija jačina prelazi 20 stranica.

Slika pod nazivom Kreirajte korisnički priručnik Korak 8

pet. Koristite slike i sheme. Crteži i snimke zaslona mogu opisati određene procese bolje od teksta, posebno kada je u pitanju iz složenih procesa, gdje trebate imati vizualnu potvrdu da osoba radi u pravu. Grafičke slike mogu se kreirati u posebnim programima: u sistemima dvo- i trodimenzionalnog crteža, u grafičkim urednicima, u aplikacijama za obradu fotografija itd.D. Ako treba napraviti snimke zaslona, mogu se dobiti pomoću osoblja nadzornog programa i grafičkog programa sa mogućnošću sačuvanja snimka zaslona.

Nakon što dobijete grafičku sliku, sačuvajte ga u komprimiranom formatu. Možda ćete morati i smanjiti veličinu slike tako da se postavlja na stranici, ali veličina ne treba biti premala, jer u suprotnom korisnik neće moći razmotriti kako i šta treba učiniti. Ako je potrebno, sliku možete razbiti na nekoliko dijelova i opisati svaki od njih.

Ako koristite više slika, oni moraju imati istu veličinu, udio i rezoluciju. Takve slike bit će razumljivije i ugodnije čitatelju. Prilikom kreiranja snimka zaslona, provjerite da koristite standardnu shemu boja (za slučajeve kada se priručnik ispisa u boji).

Iako su grafički urednici (na primjer, Shophop i Shop Pro) prikladni za stvaranje snimka zaslona, bolje je koristiti posebne programe (na primjer, snagit), jer im omogućavaju da budu odmah brzo i jednostavno za uređivanje, sačuvajte i sačuvajte slike.

Dio 3 od 3:

Registracija priručnika

jedan. Odaberite čitljivi font. Iako računari podržavaju različite fontove, korisnički priručnik mora biti dobro čitljiv, pa dajte prednost najjednostavnijom. Najbolje je odabrati nekoliko fontova koji izgledaju dobro zajedno. Postoje dvije vrste fontova: sa Serifsom i bez tenisica.

Fontovi sa serif-om imaju male crtice duž ivica linija. Takvi fontovi uključuju vremena novih Romana, Baskerville i rezervirajte Antiqua. Takvi fontovi će odgovarati velikim količinama teksta ispisanim za 10 ili 12 veličine i komponentu korisničkog priručnika.
Fontovi bez tenisica imaju jednostavne linije bez ukrasa. To su fontovi poput žitaričnih, kalibri i stoljeća gotika. Fontovi bez serifa bolje gledaju u tekstove tiskanim za 8 ili 10 fontova u priručnicima za PDF ili web dokumente. Što je veći font, to je teže čitati ga bez tenisica. Međutim, ovi se fontovi mogu koristiti za veliki tekst - na primjer, za skup zaglavlja. Socirski fontovi su pogodni za cifre za zapošljavanje u tablicama i stupovima.
Trebali biste odabrati jednostavne fontove poput arialnog ili puta New Romana, mada je neki složeniji font pogodan za ponudu. Ako napišete korisnički priručnik za maštu igru, možete istaknuti naslov naslova siročada. Dozvoljeno je i šivanje citata u kurzivu.
Nakon odabira fontova, napravite testnu stranicu kako biste bili sigurni da su ovi fontovi kombinirani jedni s drugima na papiru. Pokažite ovu stranicu osobi koja odobrava izgled prije nego što date korisnički priručnik za ispis.

Slika pod nazivom Kreirajte korisnički priručnik Korak 10

2. Razmislite o lokaciji sheme informacija o blokovima. U ovoj fazi morate odlučiti koje su informacije o narudžbi.

U pravilu se naziv korisničkog priručnika i imena poglavlja postavljaju na vrh ili dnu stranice zajedno sa brojevnim stranicama. Podaci se mogu locirati s vanjske strane (za vrh i dno stranice) ili u sredini (za Nizu). Prva stranica svakog dijela može se razlikovati od ostalih, tako da nježni broj svojih stranica možete staviti na sredinu dna i brojeve svih ostalih stranica - izvana.

Odvojeni fragmenti teksta mogu se izolirati boje tako što ih postavljate u posebne blokove. Važno je odabrati takvu hladovinu koja ne bi postigla tekst.

Ostavite prilično velike uvlake sa svih strana. Od vezivanja uvlake moraju biti širi.

Slika pod nazivom Kreirajte korisnički priručnik korak 11

3. Razmislite o vrsti vezivanja. Ako u vašem korisničkom priručniku postoji više od 4 stranice, trebat će vam vezanje. Dokumenti za unutrašnju upotrebu obično pričvršćuju spajler u uglu, ali ako unesite svoj vodič u okvir s robom, trebat ćete pristupiti ovom pitanju odgovornije. Postoje tri vrste vezivanja:

Zapadnički nosač. Ova vrsta je pogodna za brošure sa dimenzijama 21x 27.5 cm, 21x35 cm ili 11 x 27.5x42.5 cm. Najistaknutija uputstva za upotrebu koja se sastoji od 48 stranica i manje isprepletene na ovaj način.

Vezna vnakidka. Dakle, isprepleteni većina uobičajenih uputstava za upotrebu, ne računajući upute za automobile, iako su neki dugi vođe i na ovaj način isprepleteni. Paint Shop Pro prvobitno je isporučen sa takvim korisničkim priručnikom.)

Vezivanje žičanom spiralom. Na ovaj način, priručnici koji se koriste u težim uvjetima isprepleteni su, na primjer, na ulici, gdje se spajalice mogu lako slomiti ili raširiti. U nekim se uputama za upotrebu sa takvim vezivanjem pronađene i laminirane stranice koje ne vlaže i ne prljavštinu u prljavštini.

Slika pod nazivom Kreirajte korisnički priručnik korak 12

4. Uzmi dokument. Većina urednika teksta i programi za objavljivanje teksta na Internetu postoji prilika za izgled. Dok kucate tekst, automatski će se prikazati u odabranom fontu. (Ovaj je članak prvobitno napisan pomoću predloška u Microsoft Word-u.) Ovi programi imaju i gotove predloške koje možete promijeniti, uzimajući u obzir svoje potrebe, umjesto da stvarate obrazac ispočetka.

U tekstualnim urednicima i programima za objavljivanje teksta na Internetu postoji i funkcija stvaranja "stilovi", Spremanje fontova i poslovnih zadataka za stolove i podnožje i osnovni tekst. Možete birati između već postojećih stilova ("Naslov1", "Uobičajen", "Citat") ili stvorite svoj stil i dajte mu svoje ime. Preporučuje se pozivanje stilova uz isti sistem kao što je pruženo u programu. (Na primjer, Microsoft Word stvara takva imena kao "Naslov1", "Naslov2"- Pored toga, još uvijek postoje titlovi.) Konfigurirajte program unaprijed tako da se ne morate vratiti na njega kada ćete napisati pisanje teksta.

Savjeti

Ako je moguće, koristite kodove polja ili varijable teksta. Možete promijeniti svoje vrijednosti (na primjer, naziv proizvoda, naziv glave korisničkog priručnika) i stavite ih u dokument u mjestu na kojem se obično ručno preselite na riječi. Kada predate pregled dokumenta ili ga pripremite za ispis, željeni tekst će se postaviti u varijable. Ako se ime robe promijeni ili ako se odlučite za promjenu imena poglavlja, bit ćete lakše promijeniti tekst zamjenom vrijednosti varijable.

Sta ti treba

Uređivač teksta ili program za objavljivanje teksta na Internetu
Grafički uređivač ili program za kreiranje snimka zaslona