Bez obzira koliko izumitelj, programer ili racionalizator bio genijalan, ponekad se njegove kreacije jednostavno ne mogu koristiti u predviđenu svrhu. Razlog tome je pogrešno sastavljen priručnik s uputama ili njegovo potpuno odsustvo. Ali čak i domišljati izumitelji ponekad napišu takve upute da, osim uskih stručnjaka, nitko ne može pročitati te radove. Pa kako pravilno sastaviti tako potreban dokument?
Neophodno je
- - sto posto znanja o uređaju ili softverskom proizvodu za koji je napisan priručnik;
- - znanje iz oblasti lingvistike;
- - vještine pisanja.
Instrukcije
Korak 1
Korisnički priručnik ili, drugim riječima, priručnik za upotrebu je dokument osmišljen da pruži pomoć u korištenju određenog sistema svojim korisnicima. Da biste sastavili korisnički priručnik, morate sto posto znati opisani sistem, ali gledati ga očima neukog učenika. Pretpostavimo da je napisan korisnički priručnik za uslužni program koji još nema analoge. Zamislite da prvi put koristite ovaj program. Gde da započnete? Šta je prvo što treba znati? Organizirajte ovo znanje u važne kategorije.
Korak 2
Podijelivši sve informacije o svom stvaranju u grupe, izradili ste plan za pisanje korisničkog priručnika. Počnite opisivati rad u vašem programu od nule, ostavljajući za kraj najteže detalje, poput reprogramiranja funkcija ili rješavanja kritičnih grešaka. U ovoj fazi trebali biste pripremiti sadržaj korisničkog priručnika - jedan od obaveznih dijelova ovog dokumenta.
Korak 3
Ako je priručnik koji kreirate namijenjen za upotrebu u velikoj kompaniji, tada treba obratiti pažnju na tamošnje korporativne standarde. Na primjer, u mnogim ruskim kompanijama korisnički priručnici nisu prihvaćeni bez ilustrativne podrške, drugim riječima, slika koje objašnjavaju što je napisano. Pored sadržaja, korisnički priručnik trebao bi sadržavati i druge obavezne dijelove: - bilješku, odnosno objašnjenje općih ciljeva priručnika i opisanog proizvoda, - uvod, koji opisuje dokumente koji se odnose na korisnički priručnik i kako koristiti priručnik; - odjeljci koji objašnjavaju upotrebu proizvoda u različitim fazama njegove upotrebe, na primjer, prvi koraci, popravak ili održavanje; - odjeljak često postavljanih pitanja i odgovori na njih; - pojmovnik ili indeks predmeta.
Korak 4
Obično je tehnički pisac uključen u stvaranje korisničkog priručnika - osoba koja ima sva potrebna znanja kako na jeziku tako i na proizvodu koji se opisuje. Kao tehnički pisac bez obuke, imajte na umu nekoliko pravila. Prvo, ne smijete zloupotrijebiti posebne izraze koji nisu razumljivi običnom korisniku. Drugo, svaki upotrijebljeni izraz mora biti detaljno obrazložen. Treće, morate pisati što je moguće jasnije i sažetije. Konačno, tehnički pisac mora biti u stanju da svoj vlastiti tekst pogleda očima običnog korisnika kako bi uvidio nedostatke vlastitog teksta.
Korak 5
Gotov tekst korisničkog priručnika dobro je testirati u praksi tako što ćete ga ponuditi osobi koja nema nikakve veze sa opisanim proizvodom. Zajedničkim naporima moguće je ukloniti sve nedostatke i zamke dokumenta.
