Techninis rašymas perduoda skaitytojams techninę informaciją apie įgūdžius ar produktą. Jis dažniausiai naudojamas techninėse ir profesinėse srityse. Kaip techninis rašytojas, dažnai rašote tokius dokumentus kaip vartotojo vadovai, taikomųjų programų programavimo sąsajos (API) dokumentacija ir remonto bei gaminių vadovai.
Kaip ir kitos rašymo nišos, techninis rašymas turi nišai būdingas gaires. Vadovaudamiesi šiomis gairėmis galėsite parašyti geros struktūros dokumentus ir optimizuoti, kaip skaitytojai supras jūsų darbą. Štai keletas taisyklių, kurių reikia laikytis norint tapti geru techniniu rašytoju.
1. Apibrėžkite savo auditoriją
Auditorijos analizė yra nepakeičiamas gero techninio dokumento veiksnys. Žinodami savo auditoriją, galite nustatyti, apie kokią informaciją rašyti, kaip ją struktūrizuoti ir kokia yra kalbos techninė specifika. Yra keturios pagrindinės techninio rašymo auditorijos: vadovai, ekspertai, technikai ir ne specialistai.
Vadovai yra asmenys, kurie finansuoja produktą ir priima jį valdančius politinius, administracinius ir ekonominius sprendimus. Technikai yra žmonės, kurie kuria, eksploatuoja ir remontuoja šiuos gaminius. Ekspertai kuria, išbando ir viską apie produktą žino, o ne specialistai yra galutiniai produktų vartotojai. Turite atsižvelgti į savo auditoriją, kad nustatytumėte geriausią toną ir rašymo stilių.
2. Nustatykite savo auditorijos poreikius
Be savo auditorijos pažinimo ir apibūdinimo, labai svarbu suprasti jų tikslus, interesus ir poreikius. Rengiant dokumentus labai svarbu atlikti auditorijos analizę, nes mažiau tikėtina, kad rašysite be kliūčių ir gerai žinote savo auditorijos poreikius.
Norėdami atlikti visapusišką auditorijos analizę, turite atsižvelgti į savo auditorijos kilmę, turimas žinias produktą, patirtį, poreikius, interesus, demografines ypatybes, kultūrą ir bendravimo nuostatas ir tikslus. Ši informacija padės efektyviausiai ir efektyviausiai pateikti savo idėjas.
3. Žinokite savo auditorijos žinių ribą
Kaip auditorijos analizės metodą galite naudoti apklausas ir klausimynus, kad sužinotumėte savo auditorijos žinių ribas. Taip pat galite gauti populiarių nuomonių ir stereotipų, asmeninės patirties, minčių šturmo ir auditorijos atsiliepimų iš rinkodaros skyriaus.
Jei tinkamai naudositės aukščiau išvardintais įrankiais, žinosite, kiek jūsų tikslinė auditorija supranta informaciją, kurią ketinate perduoti. Ši informacija labai nulems jūsų dokumento struktūrą, ribas ir apimtį, suteikdama jums krypties pojūtį.
4. Laikykite savo kalbą paprasta
Techninis rašymas turėtų pateikti pernelyg sudėtingą dalyką. Tai daroma naudojant paprastą rašymo stiliaus vadovą. Turėtumėte užtikrinti, kad paprastas skaitytojas galėtų lengvai suprasti jūsų raštą.
Tačiau atminkite, kad auditorijos supratimas taip pat yra raktas į pasirinktą kalbos stilių. Pavyzdžiui, profesionalus žargonas dokumente apie programų programavimo sąsajos (API) gali tikti technikai, bet ne galutiniams vartotojams. Todėl, norėdami padėti auditorijai suprasti, turite naudoti lengvai suprantamą kalbą. Taip pat galbūt norėsite išmokti kaip naudoti tokį įrankį kaip „Microsoft Editor“. patikrinti savo darbą ir įsitikinti, kad rašymas yra teisingas.
5. Naudokite kontūrus
Konspektai suteikia skaitytojams supratimą, ko tikėtis dokumente. Dokumentas be kontūro pribloškia skaitytoją, nes verčia perskaityti visą tekstą, kai jiems įdomu tik įgyti specifinių žinių.
Kaip techninis rašytojas, dokumento išdėstymas taip pat suteikia rašymo krypties jausmą. Tai padeda jums sekti ir užtikrina, kad nepraleisite ar neįvertinsite atitinkamų taškų. Be to, tai pagerina jūsų dokumento struktūrą ir yra grįžtamasis ryšys apie tai, ką ketinate apimti.
6. Jei reikia, naudokite grafiką
Daugumos skaitytojų dėmesį natūraliai patraukia grafika, palyginti su tekstu. Techniniuose dokumentuose tinkama grafika gali pagerinti skaitytojo teksto supratimą, nes informacija pateikiama aiškiai ir aiškiai.
Tačiau, kaip techninis rašytojas, turėtumėte būti atsargūs ir nenaudoti grafikos dokumentams papuošti. Lentelės, grafikai, diagramos, nuotraukos ir iliustracijos yra dažniausiai naudojamos grafinės medžiagos, kurios gali pagerinti bendrą dokumento struktūrą ir patraukti skaitytojus. Tai reiškia, kad jei nesate naujas „Google“ dokumentų naudotojas, tai štai kaip kurti ir redaguoti lenteles „Google“ dokumentuose.
7. Įtraukite savo skaitytojus
Nors galbūt bandote perteikti techninę informaciją savo skaitytojams, svarbu, kad įtrauktumėte ir juos. Kiekvienas techninis dokumentas yra orientuotas į skaitytoją ir turi būti parašytas pagal skaitytojo, o ne rašytojo skonį. Kad jūsų dokumentas būtų naudingas, jūsų skaitytojo intelektualinis smalsumas turi būti patenkintas.
Galite aktyviai sudominti savo skaitytoją rašydami, kad išreikštumėte savo nuomonę, o ne padarytumėte įspūdį, o tiesiai prie reikalo. Venkite santrumpų ir žargono, naudokite daug tuščios vietos, kad pagerintumėte vaizdinį pateikimą, ir naudokite antraštes, kad padėtų skaitytojui.
8. Nenurodykite laiko svarbios informacijos
Visada pageidautina vengti nuorodų į laiko atžvilgiu svarbią informaciją, ypač susijusią su panašiu laikotarpiu. Saugiau ir išmintingiau naudoti analizę, kuri atlaikė laiko išbandymą, todėl ji tampa visžalia ir tinkama tiems, kurie ateityje skaitys jūsų dokumentą.
Taip pat turite atkreipti dėmesį, kad pridėjus konkrečius metus, pvz., „2019 m.“, kad pabrėžtumėte savo mintį, ilgainiui jūsų dokumento naudingumas gali sumažėti, išskyrus konkrečius atvejus. Galite to išvengti naudodami platesnį laikotarpį, pvz., „Per pastaruosius septynerius metus“, taip suteikdami savo darbui patikimumo.
9. Naudokite atitinkamus pavyzdžius
Rašydami techninį dokumentą naudokite tiesioginius egzempliorius, kad pabrėžtumėte savo mintis. Kadangi jūsų auditorija skaito jūsų raštą, kad įgytų įgūdžių, išspręstų problemą ar išmoktų tam tikrų gairių, turite pateikti jiems praktinių ir susijusių pavyzdžių.
Šie pavyzdžiai pagerina jūsų darbo skaitomumą ir pateikia sudėtingą informaciją skaitytojui, suteikdami kontekstą produktams ir procesams. Tokiu būdu jie labiau linkę naudoti produktus sąmoningai ir saugiai.
10. Prieš paskelbdami gaukite trečiosios šalies apžvalgą
Techninis dokumentas visada turi būti vykdomas bendradarbiaujant su rašytoju ir recenzentu. Trečiosios šalies apžvalga padeda sukurti į auditoriją orientuotą, be klaidų ir efektyvų dokumentą.
Būdami originalus dokumento autorius, prieš kurdami galutinį dokumentą galėjote parašyti daug juodraščių. Nepaisant to, kad ir koks geras jūsų dokumentas atrodytų, nepasikliaukite vien tik savo protu.
Tapkite profesionaliu techniniu rašytoju šiandien
Suprasdami pagrindines techninio rašymo taisykles, būsite įgudę ir labai paklausūs. Daugelis organizacijų žino, kaip svarbu, kad jų produktai ar paslaugos būtų gerai parduodami galutiniams vartotojams, ir padėti jiems tai pasiekti yra jūsų, kaip techninio rašytojo, tikslas.
