Kako pisati korisničke upute (SaaS)

Dobili ste zadatak napisati korisničke upute za jednu web ili mobilnu aplikaciju. Nema problema, svakodnevno koristite desetke aplikacija. Koliko teško može biti?

Nema velikog obrata, nije teško. Naravno, ako si posložite neku strukturu i napravite plan. Iako u bespućima interneta postoje stotine članaka i vodiča za pisanje, stvar je zapravo poprilično jednostavna. Da biste napisali kvalitetne upute, trebate si postaviti nekoliko pitanja.

1. Tko čita?

Prije nego uopće počnete pisati, trebate poznavati svoju publiku. Možda ste u članku odlučili iskazati svoja zavidna tehnička znanja, dok s druge strane ekrana potpunog laika samo zanima kako promijeniti lozinku.

No alt text provided for this image

Dobro provjerite tko je ciljana publika i zatim krenite s planiranjem i pisanjem. Ako čitaju ljudi s dobrim tehničkim predznanjem (tj. ako je riječ o specijaliziranom proizvodu), možete preskočiti objašnjavanje termina i prijeći na stvar. No ako čita laik Marko kojeg samo zanima kako postaviti jednu stvar u aplikaciji, pišite kao da objašnjavate mlađem bratu.

Na kraju krajeva, i Einstein je rekao da nešto razumijete tek kad možete objasniti svojoj baki. Pozdrav svim bakama!

2. Tko piše?

Koliko iskustva imate u pisanju? Koliko ste tehnički potkovani? Kakvo radno iskustvo imate?

Vjerojatno se pitate kakve to veze ima. Pa naravno da je važno, jer programer ili QA (tester) neće pisati isto kao netko iz marketinga ili prodaje. Tehničari često previše odu u dubinu, koriste žargon i pretpostavljaju da ih čitatelj razumije. Testeri su navikli pisati scenarije, ali se ponekad ne koncentriraju na dodanu vrijednost neke značajke već razmišljaju o nedostatcima. Ekipa iz marketinga ponekad nije potpuno upoznata s funkcionalnostima već su usmjereni na reklamiranje i SEO. Prodaja…mislim da možete pretpostaviti.

No alt text provided for this image

Važno je biti svjestan svojih prednosti i mogućih zamki u koje možete upasti pri pisanju uputa. Pišite ih iz perspektive prosječnog čitatelja (točka broj 1), pritom misleći samo na krajnju svrhu članaka. Bitnije je kome i zašto ih pišete nego kako vi možete iskoristiti članak da biste pokazali svoje vještine, podigli vidljivost stranice itd.

Ipak, pritom ne treba zaboraviti na terminologiju, ritam i stil.

3. Kako je napisano?

Možda ste stekli dojam da kod pisanja korisničkih uputa stil nije važan, ipak je u pitanju donekle tehnički tekst. E pa, i takve tekstove netko treba pročitati i shvatiti, tako da je stil pisanja ipak jako bitan. Evo o čemu biste trebali voditi računa:

  • Terminologija – iako je dobro pisati razumljivo, svaki element sučelja jedne aplikacije ima svoj naziv. Nemojte pisati napamet ili nagađati kako se nešto zove. Ako niste sigurni, pitajte stručnu osobu (ako možete) ili provjerite u različitim online resursima poput ovog.
  • Pravopis – iako ne pišete blog, pripazite na pravopis. Ako pišete upute u Wordu upalite provjeru pravopisa, ili skinite Grammarly. Postoji i puno besplatnih alata na internetu koji mogu pomoći da izbjegnete pogreške i tipfelere. Ozbiljno, evo dokaza da u takvim situacijama i bogati plaču:

No alt text provided for this image

  • Čitkost i ritam – kako čitatelj ne bi odustao nakon dvije sekunde, razlomite tekst u logične cjeline. Koristite natuknice i podnaslove i izbacite sve nepotrebne riječi. Potrudite se da tekst vjerno prati korake koje u uputama opisujete. Ako jedan korak podrazumijeva više akcija, može uključivati više teksta. U slučaju da je korak “click ‘Save'”, napišite samo to. Izbjegavajte prevelike uvode i uvijek gledajte prijeći na stvar. Što bi rekli naši stari, “in medias res“. Kad smo kod medija…

No alt text provided for this image

  • Multimedija – koristite što više slika ili video materijala, a što manje teksta. Osim klišeja da slika vrijedi 1000 riječi, ovo može pomoći pri preskakanju jezične barijere. Naime, koliko god dobro napisali članak, uvijek postoji čitatelj koji ga neće shvatiti. Video je univerzalan i razumljiv svima, baš kao i slike. Također, s obzirom da je koncentracija prosječnog čitatelja na razini vinske mušice, video u minuti može rezimirati cijeli članak.

Ovisno o situaciji, idealno bi bilo da postoji osoba koja će pročitati tekst nakon što ga napišete. Pritom to ne mora biti lektor, već netko tko spada u ciljanu skupinu kojoj je tekst namijenjen. Neka “baci oko” i procijeni koliko je tekst smislen i dobro napisan. Također, dobro je provjeriti s nekim tko je uključen u razvoj proizvoda, kako biste dobili potvrdu da je tekst točan i da terminologija ima smisla.

4. U čemu je problem?

Egzistencijalna pitanja uvijek dolaze na kraju. Zapitajte se zašto pišete članak, tj. koja je njegova krajnja svrha. Koji problem rješava?

No alt text provided for this image

Recimo da pišete upute o postavkama korisničkog računa unutar neke web aplikacije. Svrha je objasniti korisniku aplikacije 1) koje postavke može promijeniti i 2) kako da ih promijeni. Krenite od pretpostavke da je čitatelj ulogiran u aplikaciju i da se trenutno nalazi na početnoj stranici. U dvjema uvodnim rečenicama navedite svrhu članka i zatim odmah prijeđite na korake. Pri svakom koraku koristite natuknice, redne brojeve koji će označavati redoslijed aktivnosti i koristite slike i/video.

S obzirom da se vrlo često jedna značajka veže ili nastavlja na drugu, bit ćete u iskušenju da ih sve utrpate u jedan članak. Nemojte. Ubacite poveznicu u tekst ili na kraj članka. Koga bude zanimalo, kliknut će.

Primjerice, ako vas zanima više o pisanju korisničkih uputa za aplikacije, pogledajte neke od sljedećih članaka: HelpScout, Freshdesk ili HubSpot. Ako ste pak pali s neba u svijet IT-ja (poput moje malenkosti), evo jednog zgodnog glosara.

A ako ste (budući) virtualni asistent ili trebate virtualne asistente, bacite oko na Go2Human hub.

Očekujte još ovakvog sadržaja, ali i intervjua, savjeta iz prakse, članaka, video materijala i još puno, puno toga.