Tehničko pisanje čitateljima prenosi tehničke informacije o vještini ili proizvodu. Obično se koristi u tehničkim i profesionalnim područjima. Kao tehnički pisac često pišete dokumente poput korisničkih vodiča, dokumentacije o sučelju za programiranje aplikacija (API) i priručnika za popravke i proizvode.
Kao i druge pisačke niše, tehničko pisanje ima smjernice specifične za nišu. Slijeđenje ovih smjernica pomoći će vam da napišete dobro strukturirane dokumente i optimizirate način na koji čitatelji razumiju vaš rad. Evo nekih pravila kojih se trebate pridržavati kako biste postali dobar tehnički pisac.
1. Definirajte svoju publiku
Analiza publike neizostavan je čimbenik dobrog tehničkog dokumenta. Poznavanje vaše publike pomaže vam u određivanju vrste informacija o kojima ćete pisati, kako biste ih trebali strukturirati i tehničkih detalja vašeg jezika. Postoje četiri glavne publike za tehničko pisanje: rukovoditelji, stručnjaci, tehničari i nespecijalisti.
Rukovoditelji su pojedinci koji financiraju proizvod i donose političke, administrativne i ekonomske odluke koje njime upravljaju. Tehničari su ljudi koji grade, rukuju i popravljaju te proizvode. Stručnjaci dizajniraju, testiraju i znaju sve o proizvodu, dok su nestručnjaci krajnji korisnici proizvoda. Morate uzeti u obzir svoju publiku kako biste odredili najbolji ton i stil pisanja.
2. Prepoznajte potrebe svoje publike
Osim poznavanja i definiranja svoje publike, ključno je da razumijete njihove ciljeve, interese i potrebe. Dovršavanje analize publike ključno je u pripremi dokumenta jer je manja vjerojatnost da ćete pisati bez zastoja i dobro poznavati potrebe svoje publike.
Da biste proveli dobro zaokruženu analizu publike, morate uzeti u obzir pozadinu vaše publike, postojeće znanje o njoj proizvod, iskustvo, potrebe, interese, demografske karakteristike, kulturu i komunikacijske preferencije i ciljevi. Ove informacije će vam pomoći da svoje ideje predstavite na najučinkovitiji način.
3. Znajte granicu znanja svoje publike
Kao tehniku analize publike, možete koristiti ankete i upitnike kako biste saznali granicu znanja vaše publike. Također možete dobiti popularna mišljenja i stereotipe, osobno iskustvo, brainstorming i povratne informacije publike od marketinškog odjela.
Ako pravilno koristite gore navedene alate, znat ćete koliko vaša ciljana publika razumije informacije koje namjeravate prenijeti. Ove informacije uvelike će odrediti strukturu, ograničenja i opseg vašeg dokumenta, dajući vam osjećaj smjera.
4. Neka vaš jezik bude jednostavan
Tehničko pisanje trebalo bi predstavljati previše kompliciranu temu. To čini pomoću jednostavnog vodiča za stil pisanja. Trebali biste osigurati da prosječni čitatelj može lako razumjeti vaše pisanje.
Međutim, morate imati na umu da je razumijevanje vaše publike također ključno za jezični stil koji odaberete. Na primjer, stručni žargon u dokumentu o sučelja za programiranje aplikacija (API) može biti prikladan za tehničare, ali ne i za krajnje korisnike. Posljedično, morate koristiti jezik koji je lako razumljiv kako biste pomogli publici u razumijevanju. Možda želite i naučiti kako koristiti alat kao što je Microsoft Editor provjeriti vaš rad i osigurati da je napisano točno.
5. Koristite obrise
Obrisi daju čitateljima ideju o tome što mogu očekivati u dokumentu. Dokument bez okvira opterećuje čitatelje jer ih tjera da pročitaju cijeli tekst kada ih zanima samo stjecanje određenih znanja.
Kao tehničkom piscu, ocrtavanje vašeg dokumenta također vam daje osjećaj smjera pri pisanju. Drži vas na pravom putu i osigurava da ne propustite ili podcijenite relevantne točke. Osim toga, poboljšava strukturu vašeg dokumenta i služi kao povratna informacija o tome što namjeravate pokriti.
6. Koristite grafiku gdje je to potrebno
Pažnju većine čitatelja prirodno privlači grafika u usporedbi s tekstom. U tehničkim dokumentima, prikladna grafika može poboljšati čitateljevo razumijevanje teksta prezentirajući informacije jasnim i naglašenim.
Međutim, kao tehnički pisac, trebali biste paziti da ne koristite grafiku za ukrašavanje dokumenata. Tablice, grafikoni, dijagrami, fotografije i ilustracije često su korištene grafike i mogu poboljšati cjelokupnu strukturu dokumenta i privući ga čitateljima. Ipak, ako ste novi u Google dokumentima, evo kako izraditi i urediti tablice u Google dokumentima.
7. Uključite svoje čitatelje
Iako možda pokušavate prenijeti tehničke informacije svojim čitateljima, važno je da ih također angažirate. Svaki tehnički dokument usmjeren je na čitatelja i treba ga pisati po ukusu čitatelja, a ne pisca. Intelektualna znatiželja vašeg čitatelja mora biti zadovoljena da bi vaš dokument bio koristan.
Svojeg čitatelja možete aktivno uključiti pisanjem kako biste ga izrazili, a ne impresionirali i priješli izravno na stvar. Izbjegavajte kratice i žargon, koristite puno bijelog prostora za poboljšanje vizualne prezentacije i koristite naslove za usmjeravanje čitatelja.
8. Ne pozivajte se na vremenski osjetljive informacije
Uvijek je bolje izbjegavati upućivanje na vremenski osjetljive informacije, posebno one iz usporedivog razdoblja. Sigurnije je i mudrije koristiti analizu koja je odoljela testu vremena, što je čini zimzelenom i uvijek prikladnom za one koji će čitati vaš dokument u budućnosti.
Morate također imati na umu da prilaganje određenih godina, poput "2019.", kako biste naglasili svoje mišljenje, može smanjiti korisnost vašeg dokumenta tijekom vremena, osim u posebnim slučajevima. To možete spriječiti korištenjem šireg vremenskog okvira kao što je "U zadnjih sedam godina", dajući tako svom radu razinu vjerodostojnosti.
9. Koristite relevantne primjere
Kada pišete tehnički dokument, upotrijebite žive primjere kako biste naglasili svoje točke. Budući da vaša publika čita vaše pisanje kako bi stekla vještinu, riješila problem ili naučila neke smjernice, morate im pružiti praktične i srodne primjere.
Ovi primjeri poboljšavaju čitljivost vašeg rada i prenose složene informacije vašem čitatelju, pružajući kontekst proizvodima i procesima. Na taj način postoji veća vjerojatnost da će proizvode koristiti namjerno i sigurno.
10. Dobijte recenziju treće strane prije objavljivanja
Tehnički dokument uvijek treba proći kroz proces suradnje koji uključuje pisca i recenzenta. Recenzija treće strane pomaže u stvaranju dojmljivog dokumenta usmjerenog na publiku, bez pogrešaka.
Kao izvorni autor dokumenta, možda ste napisali mnoge skice prije stvaranja konačnog dokumenta. Ipak, koliko god vaš dokument izgledao dobro, nemojte se oslanjati samo na svoju pamet.
Postanite profesionalni tehnički pisac danas
Razumijevanje bitnih pravila koja vode tehničko pisanje učinit će vas vještijim i vrlo traženim. Mnoge organizacije znaju koliko je važno da se njihovi proizvodi ili usluge dobro plasiraju krajnjim korisnicima, a vaš je cilj kao tehničkog pisca pomoći im da to postignu.