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?
Nužno je
- - stopostotno poznavanje uređaja ili softverskog proizvoda za koji je napisan priručnik;
- - znanje iz područja lingvistike;
- - vještine pisanja.
Upute
Korak 1
Korisnički priručnik ili, drugim riječima, operativni priručnik dokument je koji je namijenjen pružanju pomoći korisnicima u korištenju određenog sustava. Da biste sastavili korisnički priručnik, morate sto posto znati opisani sustav, ali gledati ga očima neukog učenika. Pretpostavimo da je korisnički priručnik napisan za uslužni program koji još nema analoge. Zamislite da prvi put koristite ovaj program. Gdje započinjete? Što 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 svom programu od nule, ostavljajući za kraj najteže detalje, poput reprogramiranja značajki ili rješavanja kritičnih pogrešaka. U ovoj fazi trebali biste pripremiti sadržaj korisničkog priručnika - jedan od potrebnih dijelova ovog dokumenta.
3. korak
Ako je priručnik koji izrađujete namijenjen uporabi u velikoj tvrtki, tada biste trebali obratiti pažnju na tamošnje korporativne standarde. Na primjer, u mnogim ruskim tvrtkama korisnički priručnici ne prihvaćaju se bez ilustrativne podrške, drugim riječima, slika koje objašnjavaju što je napisano. Uz sadržaj, korisnički priručnik trebao bi sadržavati i ostale obvezne 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 uporabu proizvoda u različitim fazama njegove uporabe, na primjer, prvi koraci, popravak ili održavanje; - odjeljak često postavljanih pitanja i odgovori na njih; - pojmovnik ili predmetni indeks.
4. korak
Obično je tehnički pisac uključen u izradu korisničkog priručnika - osoba koja ima sve potrebno znanje kako na jeziku tako i na proizvodu koji se opisuje. Kao tehnički pisac bez izobrazbe, imajte na umu nekoliko pravila. Prvo, ne smijete zloupotrijebiti posebne pojmove koji nisu razumljivi običnom korisniku. Drugo, svaki upotrijebljeni pojam mora biti detaljno obrazložen. Treće, morate pisati što jasnije i sažetije. Konačno, tehnički pisac mora biti u stanju gledati vlastiti tekst očima običnog korisnika kako bi vidio 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 s opisanim proizvodom. Zajedničkim naporima moguće je ukloniti sve nedostatke i zamke dokumenta.
