Ne glede na to, kako iznajdljivi, programer ali racionalizator je iznajdljiv, včasih njegovih stvaritev preprosto ni mogoče uporabiti za predvideni namen. Razlog za to je nepravilno sestavljen priročnik z navodili ali njegova popolna odsotnost. Toda tudi iznajdljivi izumitelji včasih napišejo takšna navodila, da teh dokumentov razen ozkih strokovnjakov ne more prebrati nihče. Torej, kako pravilno sestaviti tako potreben dokument?
Potrebno je
- - stoodstotno znanje o napravi ali programskem izdelku, za katerega je napisan priročnik;
- - znanje s področja jezikoslovja;
- - veščine pisanja.
Navodila
Korak 1
Uporabniški priročnik ali z drugimi besedami operativni priročnik je dokument, ki svojim uporabnikom nudi pomoč pri uporabi določenega sistema. Če želite sestaviti uporabniški priročnik, morate stoodstotno poznati opisani sistem, a nanj gledati skozi oči nevednega študenta. Recimo, da je napisan uporabniški priročnik za programsko opremo, ki še nima analogov. Predstavljajte si, da prvič uporabljate ta program. Kje začnete? Kaj morate najprej vedeti? Organizirajte to znanje v pomembne kategorije.
2. korak
Z razdelitvijo vseh informacij o svojem ustvarjanju v skupine ste pripravili načrt za pisanje uporabniškega priročnika. Začnite opisovati delo v svojem programu od začetka, za konec pa pustite najtežje podrobnosti, na primer funkcije za reprogramiranje ali reševanje kritičnih napak. Na tej stopnji bi morali imeti pripravljeno vsebino uporabniškega priročnika - enega od zahtevanih delov tega dokumenta.
3. korak
Če je priročnik, ki ga ustvarjate, namenjen uporabi v velikem podjetju, bodite pozorni na tam sprejete korporacijske standarde. Na primer, v mnogih ruskih podjetjih uporabniški priročniki niso sprejemljivi brez ilustrativne podpore, z drugimi besedami, slik, ki pojasnjujejo, kaj je napisano. Uporabniški priročnik mora poleg vsebine vsebovati še druge obvezne dele: - opombo, to je razlago splošnih ciljev priročnika in opisanega izdelka; - uvod, ki opisuje dokumente v zvezi z uporabniškim priročnikom in kako za uporabo priročnika; - razdelki, ki razlagajo uporabo izdelka na različnih stopnjah njegove uporabe, na primer prvi koraki, popravilo ali vzdrževanje; - odsek pogostih vprašanj in odgovorov nanje; - slovarček ali predmetni indeks.
4. korak
Običajno pri izdelavi uporabniškega priročnika sodeluje tehnični pisatelj - oseba, ki ima vsa potrebna znanja tako v jeziku kot v izdelku, ki ga opisujemo. Kot tehnični pisec brez izobrazbe morate upoštevati nekaj pravil. Prvič, ne smete zlorabljati posebnih izrazov, ki običajnemu uporabniku niso razumljivi. Drugič, vsak uporabljeni izraz mora biti podrobno opisan in razložen. Tretjič, pisati morate čim bolj jasno in jedrnato. Nazadnje mora biti tehnični pisec sposoben pogledati lastno besedilo z očmi običajnega uporabnika, da vidi pomanjkljivosti lastnega besedila.
5. korak
Končno besedilo uporabniškega priročnika je dobro preizkusiti v praksi, tako da ga ponudite osebi, ki z opisanim izdelkom ni imela nič skupnega. S skupnimi močmi je mogoče odpraviti vse pomanjkljivosti in pasti dokumenta.
