Kako napisati odličen uporabniški priročnik za skoraj vse

Kazalo:

Anonim

Nekoč so trdni uporabniški priročniki spremljali nove izdelke vseh vrst, ki so nudili obsežna navodila za učenje vseh funkcij in povečanje vaše uporabe. Danes pa so tovarniško podprti uporabniški priročniki veliko bolj površni in pogosto v več jezikih, kar otežuje učno krivuljo. Imeti dostojen uporabniški priročnik je dragocena dobrina in če veste, kako ga napisati, je to talent, ki ga zelo zanima. Gre preprosto za obvladovanje nekaj ključnih načel.

Postavke, ki jih boste potrebovali

  • Microsoft Word ali drug program za urejanje besedil

  • Zbirka izrezkov ali digitalnih fotografij

  • Enostavna programska oprema za izdelavo spletnih strani

Odločite se za obliko, ali so natisnjeni dokumenti, spletne strani, e-pošta ali kakšna kombinacija. Ko pišete v eni obliki, jo lahko enostavno prenesete v drugo. Nekateri ljudje lažje berejo natisnjen dokument, ki ga lahko hranijo, in ga shranijo. Drugi lahko raje izberejo URL ali povezavo do dokumenta na vašem spletnem mestu.

Bodite organizirani, jasni in jedrnati. Predvidite in pojasnite ne samo, kaj bodo storili uporabniki, ampak tudi, kaj ne. Pisati morate z obojestranskim pogledom.

Začnite na začetku in v logičnem smislu razgrnite le potrebne informacije. Pišite v aktivnem glasu, ne pasivno. Obdržite svoj izvod lean, odpravljanje tujih besed. Naj bo preprosta in metodična.

Besedilo razdelite s fotografijami, ilustracijami ali diagrami, kolikor je to mogoče. Narediti bralce, da gredo skozi neskončno besedilo z monstruoznimi odstavki, je zanesljiv način, da jih izgubite. Dolgotrajni, kompleksni odstavki in strani so primerni za tehnične priročnike, vendar niso primerni za preproste uporabniške priročnike. Naj bo kratko in sladko.

Opozorite bralca, kaj naj ne počne v različnih intervalih. To pomaga zmanjšati frustracije pri učenju novega izdelka ali aplikacije.

Bralcem zagotovite druge vire, ki jih lahko uporabijo za dopolnitev vašega vodnika.

Nasveti

  • Pišite zelo preprosto. Ne prevzemajte nobenega znanja. Kar se vam zdi enostavno in dobro, vam morda ne bo tako za vaše bralce. Uporabite kakovostno grafiko, izrezke in fotografije, da izboljšate videz dokumenta in izboljšate berljivost. Hranite odstavke in opise kratke.

Opozorilo

Nikoli ne predvidevajte, da je bralec seznanjen z izdelkom. Vsak vodnik napišite, kot da ga še nikoli niste videli.

Priporočena