Tehniline kirjutamine edastab lugejatele tehnilist teavet oskuse või toote kohta. Seda kasutatakse tavaliselt tehnika- ja tööaladel. Tehnilise kirjutajana kirjutate sageli dokumente, nagu kasutusjuhendid, rakendusliidese (API) dokumentatsioon ning remondi- ja tootejuhendid.
Nagu teistelgi kirjutamisniššidel, on ka tehnilisel kirjutamisel nišispetsiifilised juhised. Nende juhiste järgimine aitab teil kirjutada hästi struktureeritud dokumente ja optimeerida seda, kuidas lugejad teie tööd mõistavad. Siin on mõned reeglid, mida tuleb järgida, et saada heaks tehniliseks kirjanikuks.
1. Määratlege oma vaatajaskond
Vaatajaskonna analüüs on hea tehnilise dokumendi asendamatu tegur. Publiku tundmine aitab teil määrata, millist teavet kirjutada, kuidas peaksite seda struktureerima ja oma keele tehnilisust. Tehnilise kirjutamise jaoks on neli peamist sihtrühma: juhid, eksperdid, tehnikud ja mittespetsialistid.
Juhid on isikud, kes rahastavad toodet ja teevad seda reguleerivaid poliitilisi, administratiivseid ja majanduslikke otsuseid. Tehnikud on inimesed, kes neid tooteid ehitavad, käitavad ja parandavad. Eksperdid kavandavad, testivad ja teavad toote kohta kõike, mittespetsialistid on aga toodete lõppkasutajad. Peate arvestama oma publikuga, et määrata kindlaks parim toon ja kirjutamisstiil.
2. Tuvastage oma publiku vajadused
Lisaks vaatajaskonna tundmisele ja määratlemisele on oluline mõista ka nende eesmärke, huvisid ja vajadusi. Publiku analüüsi lõpuleviimine on dokumendi ettevalmistamisel võtmetähtsusega, kuna on vähem tõenäoline, et kirjutate ilma luksumisteta ja teate hästi oma publiku vajadusi.
Põhjaliku vaatajaskonna analüüsi tegemiseks peate arvestama oma publiku tausta ja olemasolevate teadmistega toode, kogemus, vajadused, huvid, demograafilised omadused, kultuur ja suhtluseelistused ning eesmärgid. See teave aitab teil oma ideid kõige tõhusamalt ja tõhusamalt esitada.
3. Teadke oma publiku teadmiste piire
Publiku analüüsi tehnikana võite kasutada küsitlusi ja küsimustikke, et teada saada oma publiku teadmiste piire. Samuti saate turundusosakonnast hankida populaarseid arvamusi ja stereotüüpe, isiklikke kogemusi, ajurünnakuid ja publiku tagasisidet.
Kui kasutate ülaltoodud tööriistu õigesti, saate teada, kui palju teie sihtrühm mõistab teavet, mida kavatsete edastada. See teave määrab suuresti teie dokumendi struktuuri, piirangud ja ulatuse, andes teile suunataju.
4. Hoidke oma keel lihtsana
Tehniline kirjutamine peaks esitama liiga keerulise teema. See teeb seda lihtsa kirjutamisstiili juhendi abil. Peaksite tagama, et keskmine lugeja saaks teie kirjutisest hõlpsasti aru.
Siiski peate arvestama, et teie kuulajaskonna mõistmine on ka teie valitud keelestiili võtmeks. Näiteks professionaalne kõnepruuk dokumendis, mis käsitleb rakenduste programmeerimisliidesed (API) võib sobida tehnikutele, kuid mitte lõppkasutajatele. Järelikult peate kasutama hõlpsasti arusaadavat keelt, et aidata publikul aru saada. Võib-olla soovite ka õppida kuidas kasutada sellist tööriista nagu Microsoft Editor et kontrollida oma tööd ja veenduda, et kirjutamine on õige.
5. Kasutage piirjooni
Kontuurid annavad lugejatele aimu, mida dokumendis oodata. Konspektita dokument paneb lugejad üle jõu, sest sunnib neid lugema kogu teksti, kui nad on huvitatud vaid konkreetsete teadmiste omandamisest.
Tehnilise kirjutajana annab dokumendi visandamine teile kirjutamisel ka suunataju. See hoiab teid õigel teel ja tagab, et te ei jätaks olulisi punkte märkamata ega alahinnata. Lisaks täiustab see teie dokumendi struktuuri ja annab tagasisidet selle kohta, mida kavatsete katta.
6. Vajadusel kasutage graafikat
Enamiku lugejate tähelepanu tõmbab tekstiga võrreldes loomulikult graafika. Tehnilistes dokumentides võib sobiv graafika parandada lugejate tekstist arusaamist, esitades teavet selgelt ja rõhutatult.
Tehnilise kirjutajana peaksite siiski olema ettevaatlik, et mitte kasutada dokumentide kaunistamiseks graafikat. Tabelid, graafikud, diagrammid, fotod ja illustratsioonid on tavaliselt kasutatav graafika ning need võivad parandada dokumendi üldist struktuuri ja lugejatele meeldivat. See tähendab, et kui te pole Google Docsi uus kasutaja, siis siin on see kuidas Google Docsis tabeleid luua ja redigeerida.
7. Kaasake oma lugejaid
Ehkki proovite oma lugejatele tehnilist teavet edastada, on oluline, et te ka neid kaasaksite. Iga tehniline dokument on lugejakeskne ja see peaks olema kirjutatud lugeja, mitte kirjutaja maitse järgi. Teie lugeja intellektuaalne uudishimu peab olema rahuldatud, et teie dokument oleks kasulik.
Saate oma lugejat aktiivselt kaasata, kirjutades, et väljendada, mitte muljet avaldada ja asuda otse asja juurde. Vältige lühendeid ja kõnepruuki, kasutage visuaalse esituse parandamiseks palju tühikuid ja kasutage lugeja juhendamiseks pealkirju.
8. Ärge viidake ajatundlikule teabele
Alati on parem vältida viiteid ajatundlikule teabele, eriti võrreldavale perioodile. Ohutum ja targem on kasutada ajaproovile vastu pidanud analüüsi, mis muudab selle igihaljaks ja igavesti sobivaks neile, kes sinu dokumenti edaspidi loevad.
Samuti peate arvestama, et konkreetsete aastaarvude (nt „2019“) lisamine oma mõtte rõhutamiseks võib teie dokumendi kasulikkust aja jooksul vähendada, välja arvatud erijuhtudel. Saate seda vältida, kasutades laiemat ajavahemikku, näiteks "viimase seitsme aasta jooksul", andes seega oma tööle usaldusväärsuse.
9. Kasutage asjakohaseid näiteid
Tehnilise dokumendi kirjutamisel kasutage oma punktide rõhutamiseks elavaid eksemplare. Kuna teie publik loeb teie kirjutist oskuse omandamiseks, probleemi lahendamiseks või juhiste õppimiseks, peate esitama neile praktilisi ja võrreldavaid näiteid.
Need näited parandavad teie töö loetavust ja edastavad lugejale keerukat teavet, pakkudes toodetele ja protsessidele konteksti. Nii kasutavad nad suurema tõenäosusega tooteid tahtlikult ja ohutult.
10. Enne avaldamist hankige kolmanda osapoole ülevaade
Tehniline dokument peaks alati läbima koostööprotsessi, millesse on kaasatud kirjutaja ja retsensent. Kolmanda osapoole ülevaade aitab luua vaatajaskonnale keskendunud, vigadeta ja mõjuka dokumendi.
Dokumendi algse autorina olete võib-olla kirjutanud palju mustandeid enne lõpliku dokumendi loomist. Sellegipoolest, hoolimata sellest, kui hea teie dokument välja näeb, ärge sõltuge ainult oma mõistusest.
Hakka professionaalseks tehniliseks kirjutajaks juba täna
Tehnilist kirjutamist reguleerivate oluliste reeglite mõistmine muudab teid valdavamaks ja ihaldatumaks. Paljud organisatsioonid teavad, kui oluline on, et nende tooted või teenused oleksid lõppkasutajatele hästi turundatud, ja teie kui tehnilise kirjaniku eesmärk on aidata neil seda saavutada.