Technical writing on käytäntö, jossa käsitellään asiakirjoja ja visuaalisia kuvia, suullisia tietoja ja demonstraatioita opetusmateriaaliksi. Teknisen kirjoittamisen tarkoituksena on tarjota materiaalia, joka selittää jonkin prosessin tai tekee monimutkaisesta käsitteestä helpommin ymmärrettävän tietylle yleisölle. Tehokkaan ja tehokkaan teknisen kirjoittamisen avulla kirjoittaja pystyy selittämään ja avustamaan lukijaa tiedon ymmärtämisessä ja erityistehtävien suorittamisessa. Teknisen kirjoittamisen yleismaailmallisia eettisiä periaatteita on viisi. Periaatteet ovat laadukas sisältö, yleisö ja tarkoitus, saavutettavuus, kielioppi ja kirjoitustyyli.
laatusisältö
laatusisältö on subjektiivista. MATC: n määritelmän mukaan laadukas sisältö on tuote, joka täyttää asiakkaan standardit tai ylittää projektin alkuperäisen laajuuden. Tuottaa laadukas projekti, sinun täytyy kirjoittaa tarkoitettu yleisö mielessä. Kirjoittajan on tutkittava lisää tietoa, jota tarvitaan ennen asiakirjan tai aineiston valmistumista. Kirjoittajan on tiedettävä, millä formaatilla tai alustalla tieto esitetään. Kirjoittajan on määritettävä tarkat tiedot, jotka vaihtelevat siitä, että hän tietää, mitkä määräajat ovat, ja siitä, miksi tiedot on kirjoitettava.
yleisö ja tarkoitus
kirjoittajan on ymmärrettävä sekä tarkoitus että yleisö luodakseen erinomaisen teknisen teoksen. Teknisen kirjoittamisen yleisö vaihtelee toimialan ja tietyn asiakkaan mukaan. Esimerkiksi syliraportin yleisö olisi tuotevalmistaja, joka palkkasi meidät kirjoittajiksi. ELearning – koulutusmoduulin yleisönä voi olla pankki tai kiinnitysluottaja, joka tarvitsee compliance-koulutusta. Kirjoittajan on tiedettävä, kuinka paljon lukijat tietävät ja mitä velvollisuuksia kirjoittajalta vaaditaan, kun on kyse viestinnästä lukijoille.
saavutettavuus
on olennaista, että yleisö pääsee helposti käsiksi kirjoittajan luomaan tietoon. Esteettömyys sisältää kaiken dokumentissa olevan, kuten otsikot ja alatunnisteet, tai tietokoneen iLearn-moduulit, jotka parantavat esteettömyysmuotoilua yleisemmäksi ja selkeämmäksi. Teknisen kirjoittajan on keksittävä paras tapa auttaa lukijoita navigoimaan dokumentaatiossa, jossa on merkintöjä lähdeluettelosta sivunumeroihin ja sisällysluetteloon. Kirjoittaja voisi jopa lisätä kuvia, kuten kaavioita ja lukuja, selittämään tietoa tarkemmin.
kielioppi
selkeän, ytimekkään ja suoraviivaisen kirjoittaminen kieliopin oikealla käytöllä on elintärkeää minkä tahansa teknisen teoksen kirjoittamisessa. Kirjoittajan on myös oikoluettava ja muokattava mitä tahansa kirjoitettavaa teknistä teosta korjatakseen mahdolliset virheet tai epäjohdonmukaisuudet kielioppiin, tyyliin ja asetteluun nähden. Teknisen kirjoittajan tulee aina kirjoittaa preesensissä, ellei asiakas muuta ilmaise mieltymystään. Teknisen teoksen lukijan kannattaa tehdä juuri niin kuin annatte ohjeita. Kirjoittajan tulisi aina kirjoittaa yksinkertaisiin lauseisiin, jotka sisältävät sukupuolineutraaleja substantiiveja. Yksinkertaiset lauseet auttavat lukijoita ymmärtämään selkeästi ja tehokkaasti tehtävät, joihin heidän on ryhdyttävä saavuttaakseen tavoitteensa.
kirjoitustyyli
kirjoitustyyli vaihtelee jokaisen teknisen teoksen kohdalla, koska se riippuu suuresti siitä, kuka on yleisö ja mihin skenaarioon tekninen teos on kirjoitettu. Teknisen kirjoituskappaleen sävy on oleellinen, koska se auttaa lukijaa ymmärtämään, millaista äänensävyä tehtävän suorittaminen vaatii. Sanavalinta on myös olennainen osa tyyliä, joka auttaa tarjoamaan yleisön tarpeet, koska se yhdistää takaisin siihen, kuka yleisö on. Kun viitataan tietojen osioihin tai verkkosivustoihin, on tärkeää tarjota selkeitä ja näkyviä tapoja päästä tietoihin käyttämällä työkaluja, kuten lukuja ja taulukoita.
muut tekniset Kirjoitusvinkit
tee lisätutkimuksia ja opi lisää
tietäen vähimmillään ei välttämättä saa parasta teknistä teosta, joka auttaisi kuulijaa ymmärtämään tietoa. Siinä voi olla paljon terminologiaa, jota sekä kirjoittaja että lukija eivät välttämättä ymmärrä. Nyrkkisääntönä on, että jos sinä lukijana et ymmärrä jotakin käsitettä tai termiä, määrittele se. Liian paljon tietoa voidaan aina karsia myöhemmissä arvioissa. Tätä tietoa pitäisi tutkia, jotta ymmärrettäisiin, miten se toimii sen kanssa, mitä kirjoittaja kokonaisuutena kirjoittaa. Tutki vähän isää ja selvitä, mitä muuta tietoa voitaisiin käyttää parantamaan teknistä kappaletta kirjoitetaan.
tule yleisöksi ja aliarvioi yleisö
Laita itsesi yleisön saappaisiin. Voitko selvästi ymmärtää ja noudattaa ohjeita tai tietoja, jotka olet kirjoittanut yleisölle? Jos kyllä, voit antaa lisätietoja, jos se mielestäsi tarvitsee hieman enemmän apua. Jos ei, sinun täytyy löytää osat, jotka eivät ole selkeitä ja löytää tapa antaa tietoja oikein. Teknisten kirjoittajien suuri ongelma on usein se, että he yliarvioivat yleisönsä tiedon. Yleisönä voi olla useita ihmisiä eri tietotasoilla. On täysin hyväksyttävää antaa lyhyesti tietoa, joka voidaan olettaa tai jo ilmoitettu kertaus yleisölle.
pyydä toinen ja kolmas lausunto ja vertaisarviointi
tekniset kirjoittajat ovat neuvokkaita. Suurin voimavara sinulla on aiheasiantuntijat. Muista kysyä PK-yritykseltäsi, jos he havaitsevat tietämyksessä puutteita tai virheitä. Kirjoittajat tarkistavat asiakkailtaan, onko tiedoissa aukkoja tai virheitä, jotka kirjailija saattaa sivuuttaa. Se, että esimies tai kollega tarkastelee ja antaa lausunnon, voi myös auttaa parantamaan teknistä teosta. Vertaisarviointi on sitä, kun ryhmä ihmisiä kokoontuu lukemaan, kommentoimaan ja suosittelemaan parannuksia toistensa työhön. Lisää sokeita pisteitä tulee esiin, kun useammat ihmiset tarkistaa asiakirjan, joka takaa tarkan ja ytimekkään tiedon.
tekniset kirjoittajat oppivat uutta tietoa jokaisesta projektista, jonka parissa he työskentelevät. Kirjoittajat saavat paremman käsityksen siitä, mitä asiakkaat tarvitsevat, koska he aloittavat lukijoidensa tietotason alapuolella ennen kaikkea tutkimusta ja keskusteluja aiheasiantuntijoiden kanssa. Tästä tulee yrityksille suuri valtti, koska vähemmän oletuksia avautuu tehokkaampaan koulutukseen. Yhdistelmä kirjoittajat oppimisen materiaali ja nämä eettiset periaatteet teknisen kirjoittamisen standardeja johtaa enemmän luottavainen ja tehokas työntekijöitä.