Tehnično pisanje bralcem sporoča tehnične informacije o veščini ali izdelku. Običajno se uporablja na tehničnih in poklicnih področjih. Kot tehnični pisec pogosto pišete dokumente, kot so uporabniški priročniki, dokumentacija vmesnika za programiranje aplikacij (API) ter priročniki za popravila in izdelke.
Tako kot druge pisne niše ima tudi tehnično pisanje smernice za posamezne niše. Upoštevanje teh smernic vam bo pomagalo napisati dobro strukturirane dokumente in optimizirati, kako bralci razumejo vaše delo. Tukaj je nekaj pravil, ki jih morate upoštevati, če želite postati dober tehnični pisec.
1. Določite svoje občinstvo
Analiza občinstva je nepogrešljiv dejavnik dobrega tehničnega dokumenta. Poznavanje občinstva vam pomaga določiti vrsto informacij, o katerih želite pisati, kako jih strukturirati in tehnične značilnosti vašega jezika. Obstajajo štiri glavne ciljne skupine za tehnično pisanje: vodstvo, strokovnjaki, tehniki in nestrokovnjaki.
Vodstveni delavci so posamezniki, ki financirajo izdelek in sprejemajo politične, upravne in ekonomske odločitve, ki ga urejajo. Tehniki so ljudje, ki izdelujejo, upravljajo in popravljajo te izdelke. Strokovnjaki oblikujejo, testirajo in vedo vse o izdelku, medtem ko so nestrokovnjaki končni uporabniki izdelkov. Če želite določiti najboljši ton in slog pisanja, morate upoštevati svoje občinstvo.
2. Prepoznajte potrebe svojega občinstva
Poleg poznavanja in definiranja občinstva je ključnega pomena, da razumete njihove cilje, interese in potrebe. Dokončanje analize občinstva je ključno pri pripravi dokumenta, saj je manj verjetno, da boste pisali brez kolcanja in dobro poznali potrebe svojega občinstva.
Če želite izvesti dobro zaokroženo analizo občinstva, morate upoštevati ozadje svojega občinstva, obstoječe znanje o izdelek, izkušnje, potrebe, interese, demografske značilnosti, kulturo in komunikacijske preference ter cilji. Te informacije vam bodo pomagale pri najbolj učinkoviti in uspešni predstavitvi vaših idej.
3. Spoznajte mejo znanja svojega občinstva
Kot tehniko analize občinstva lahko uporabite ankete in vprašalnike, da ugotovite mejo znanja vašega občinstva. Od oddelka za trženje lahko pridobite tudi priljubljena mnenja in stereotipe, osebne izkušnje, možgansko nevihto in povratne informacije občinstva.
Če pravilno uporabljate zgoraj našteta orodja, boste vedeli, koliko vaša ciljna publika razume informacije, ki jih nameravate posredovati. Te informacije bodo močno določile strukturo, omejitve in obseg vašega dokumenta ter vam dale občutek smeri.
4. Naj bo vaš jezik preprost
Tehnično pisanje naj bi predstavljalo preveč zapleteno temo. To stori z uporabo preprostega vodnika za slog pisanja. Zagotoviti morate, da povprečni bralec zlahka razume vaše pisanje.
Vendar morate upoštevati, da je razumevanje vašega občinstva prav tako ključno za jezikovni slog, ki ga izberete. Na primer, strokovni žargon v dokumentu o aplikacijski programski vmesniki (API) je morda primeren za tehnike, ne pa tudi za končne uporabnike. Zato morate uporabljati lahko razumljiv jezik, ki pomaga občinstvu razumeti. Morda se boste želeli tudi naučiti kako uporabljati orodje, kot je Microsoft Editor preveriti vaše delo in zagotoviti, da je pisanje pravilno.
5. Uporabite Orise
Orisi dajejo vašim bralcem predstavo o tem, kaj lahko pričakujejo v dokumentu. Dokument brez orisov bralce prevzame, saj jih sili, da preberejo celotno besedilo, ko jih zanima le pridobitev določenega znanja.
Kot tehnični pisec vam oris dokumenta daje tudi občutek smeri pri pisanju. Drži vas na pravi poti in zagotavlja, da ne zamudite ali premalo cenite ustreznih točk. Poleg tega izboljša strukturo vašega dokumenta in služi kot povratna informacija o tem, kaj nameravate zajeti.
6. Uporabite grafiko, kjer je to potrebno
Pozornost večine bralcev seveda pritegne grafika v primerjavi z besedilom. V tehničnih dokumentih lahko primerna grafika izboljša razumevanje besedila pri bralcih, saj informacije predstavi jasno in poudarjeno.
Vendar kot tehnični pisec morate paziti, da ne uporabljate grafike za okrasitev dokumentov. Tabele, grafi, grafikoni, fotografije in ilustracije so pogosto uporabljene grafike in lahko izboljšajo celotno strukturo dokumenta in pritegnejo bralce. Kljub temu, če ste novi v Google Dokumentih, je tukaj kako ustvariti in urediti tabele v Google Dokumentih.
7. Pritegnite svoje bralce
Čeprav morda poskušate svojim bralcem posredovati tehnične informacije, je pomembno, da jih tudi vključite. Vsak tehnični dokument je osredotočen na bralca in mora biti napisan po okusu bralca in ne pisca. Intelektualna radovednost vašega bralca mora biti potešena, da bo vaš dokument uporaben.
Svojega bralca lahko aktivno vključite tako, da pišete, da izrazite, ne naredite vtisa, in preidete naravnost k bistvu. Izogibajte se okrajšavam in žargonu, uporabite veliko praznega prostora za izboljšanje vizualne predstavitve in uporabite naslove za vodenje bralca.
8. Ne sklicujte se na časovno občutljive informacije
Vedno je bolje, da se izogibate sklicevanju na časovno občutljive informacije, zlasti tiste iz primerljivega obdobja. Varneje in pametneje je uporabiti analizo, ki je prestala preizkus časa, zaradi česar je zimzelena in vedno primerna za tiste, ki bodo vaš dokument brali v prihodnosti.
Upoštevati morate tudi, da lahko pripenjanje določenih letnic, na primer »2019«, da poudarite svoje stališče, sčasoma zmanjša uporabnost vašega dokumenta, razen v posebnih primerih. To lahko preprečite z uporabo širšega časovnega okvira, kot je "V zadnjih sedmih letih," in tako svojemu delu zagotovite raven verodostojnosti.
9. Uporabite ustrezne primere
Ko pišete tehnični dokument, uporabite žive primerke, da poudarite svoje točke. Ker vaše občinstvo bere vaše pisanje, da bi pridobilo spretnosti, rešilo problem ali se naučilo nekaterih smernic, jim morate zagotoviti praktične in primerljive primere.
Ti primeri izboljšajo berljivost vašega dela in vašemu bralcu posredujejo zapletene informacije ter zagotavljajo kontekst za izdelke in procese. Tako je večja verjetnost, da bodo izdelke uporabljali namerno in varno.
10. Pred objavo pridobite oceno tretje osebe
Tehnični dokument mora vedno potekati skozi proces sodelovanja, ki vključuje pisca in recenzenta. Pregled tretje osebe pomaga ustvariti dokument, osredotočen na občinstvo, brez napak in učinkovit.
Kot prvotni avtor dokumenta ste morda napisali veliko osnutkov, preden ste ustvarili končni dokument. Kljub temu, ne glede na to, kako dober je vaš dokument, se ne zanašajte samo na svojo pamet.
Postanite poklicni tehnični pisec že danes
Če boste razumeli bistvena pravila tehničnega pisanja, boste postali bolj spretni in zelo iskani. Številne organizacije vedo, kako pomembno je, da se njihovi izdelki ali storitve dobro tržijo končnim uporabnikom, in vaš cilj kot tehničnega pisca je, da jim pomagate doseči to.
