Tekninen kirjoittaminen välittää lukijoille teknisiä tietoja taidosta tai tuotteesta. Sitä käytetään yleisesti teknisillä ja ammatillisilla aloilla. Teknisenä kirjoittajana kirjoitat usein asiakirjoja, kuten käyttöoppaita, API-dokumentaatiota sekä korjaus- ja tuoteoppaita.
Kuten muillakin kirjoitusalalla, myös teknisellä kirjoittamisella on markkinarakokohtaisia ohjeita. Näiden ohjeiden noudattaminen auttaa sinua kirjoittamaan hyvin jäsenneltyjä asiakirjoja ja optimoimaan, miten lukijat ymmärtävät työsi. Tässä on joitain sääntöjä, joita on noudatettava tullaksesi hyväksi tekniseksi kirjoittajaksi.
1. Määrittele yleisösi
Yleisöanalyysi on välttämätön tekijä hyvässä teknisessä asiakirjassa. Yleisösi tunteminen auttaa sinua määrittämään, millaista tietoa haluat kirjoittaa, miten se tulisi jäsentää ja kuinka teknisesti kielesi on. Teknisellä kirjoittamisella on neljä pääasiallista yleisöä: johtajat, asiantuntijat, teknikot ja ei-asiantuntijat.
Johtajat ovat henkilöitä, jotka rahoittavat tuotetta ja tekevät sitä hallitsevat poliittiset, hallinnolliset ja taloudelliset päätökset. Teknikot ovat ihmisiä, jotka rakentavat, käyttävät ja korjaavat näitä tuotteita. Asiantuntijat suunnittelevat, testaavat ja tietävät kaiken tuotteesta, kun taas ei-asiantuntijat ovat tuotteiden loppukäyttäjiä. Sinun on harkittava yleisöäsi määrittääksesi parhaan sävyn ja kirjoitustyylin.
2. Tunnista yleisösi tarpeet
Sen lisäksi, että tunnet ja määrittelet yleisösi, on tärkeää, että ymmärrät heidän tavoitteensa, kiinnostuksen kohteensa ja tarpeensa. Yleisöanalyysin suorittaminen on avainasemassa asiakirjojen valmistelussa, koska et todennäköisesti kirjoita ilman hikkausta ja tiedät yleisösi tarpeet hyvin.
Jotta voit tehdä kattavan yleisöanalyysin, sinun on otettava huomioon yleisösi tausta ja olemassa oleva tieto tuote, kokemus, tarpeet, kiinnostuksen kohteet, demografiset ominaisuudet, kulttuuri ja viestintämieltymykset ja tavoitteet. Nämä tiedot auttavat sinua esittämään ideasi tehokkaimmin ja tehokkaimmin.
3. Tunne yleisösi tiedon raja
Yleisöanalyysitekniikana voit hyödyntää kyselyitä ja kyselyitä selvittääksesi yleisösi tietämyksen rajat. Voit myös hankkia suosittuja mielipiteitä ja stereotypioita, henkilökohtaisia kokemuksia, aivoriihiä ja yleisöpalautetta markkinointiosastolta.
Jos hyödynnät yllä lueteltuja työkaluja oikein, tiedät kuinka paljon kohdeyleisösi ymmärtää tiedot, joita aiot välittää. Nämä tiedot määrittävät suuresti asiakirjasi rakenteen, rajat ja laajuuden, mikä antaa sinulle suunnan tunteen.
4. Pidä kieli yksinkertaisena
Teknisen kirjoittamisen on tarkoitus esittää liian monimutkainen aihe. Se tekee tämän käyttämällä suoraviivaista kirjoitustyyliopasta. Sinun tulee varmistaa, että keskivertolukija ymmärtää kirjoituksesi helposti.
Sinun on kuitenkin huomioitava, että yleisösi ymmärtäminen on myös avain valitsemaasi kielityyliin. Esimerkiksi ammattislangia käsittelevässä asiakirjassa sovellusohjelmointirajapinnat (API) saattaa olla sopiva teknikolle, mutta ei loppukäyttäjille. Tästä syystä sinun on käytettävä helposti ymmärrettävää kieltä auttamaan yleisön ymmärtämistä. Haluat ehkä myös oppia kuinka käyttää Microsoft Editorin kaltaista työkalua tarkistaaksesi työsi ja varmistaaksesi, että kirjoitus on oikeaa.
5. Käytä ääriviivoja
Pääpiirteet antavat lukijoillesi käsityksen siitä, mitä asiakirjassa voi odottaa. Asiakirja, jossa ei ole ääriviivaa, painaa lukijaa, sillä se pakottaa heidät lukemaan koko tekstin, kun he ovat kiinnostuneita vain tietyn tiedon hankkimisesta.
Teknisenä kirjoittajana dokumentin hahmottaminen antaa sinulle myös suunnan tunteen kirjoittaessasi. Se pitää sinut oikeilla jäljillä ja varmistaa, että et menetä tai aliarvioi tärkeitä kohtia. Lisäksi se parantaa asiakirjasi rakennetta ja toimii palautteena siitä, mitä aiot käsitellä.
6. Käytä grafiikkaa tarvittaessa
Useimpien lukijoiden huomio kiinnittyy luonnollisesti grafiikkaan verrattuna tekstiin. Teknisissä asiakirjoissa sopivalla grafiikalla voidaan parantaa lukijoiden tekstin ymmärtämistä esittämällä tiedot selkeästi ja painokkaasti.
Teknisenä kirjoittajana sinun tulee kuitenkin olla varovainen, ettet käytä grafiikkaa asiakirjojen koristeluun. Taulukot, kaaviot, kaaviot, valokuvat ja piirrokset ovat yleisesti käytettyjä grafiikoita, ja ne voivat parantaa asiakirjan yleistä rakennetta ja houkutella lukijoita. Tästä huolimatta, jos olet uusi Google-dokumenttien käyttäjä, tässä kuinka luoda ja muokata taulukoita Google Docsissa.
7. Sitouta lukijasi
Vaikka saatat yrittää välittää teknisiä tietoja lukijoillesi, on tärkeää, että otat myös heidät mukaan. Jokainen tekninen asiakirja on lukijakeskeinen, ja se tulee kirjoittaa lukijan, ei kirjoittajan, maun mukaan. Lukijasi älyllisen uteliaisuuden on tyydytettävä, jotta asiakirjasi olisi hyödyllinen.
Voit aktivoida lukijasi aktiivisesti kirjoittamalla ilmaistaksesi, ei tehdäksesi vaikutuksen, ja siirtyäksesi suoraan asiaan. Vältä lyhenteitä ja ammattislangia, käytä paljon tyhjää tilaa visuaalisen esityksen parantamiseksi ja käytä otsikoita lukijan ohjaamiseen.
8. Älä viittaa aikaherkkiin tietoihin
On aina suositeltavaa välttää viittauksia aikaherkkään tietoon, erityisesti vertailukelpoisiin tietoihin. On turvallisempaa ja viisaampaa käyttää ajan kokeen kestänyt analyysi, joka tekee siitä ikivihreän ja aina sopivan niille, jotka lukevat dokumenttisi tulevaisuudessa.
Huomaa myös, että tiettyjen vuosien, kuten "2019" liittäminen pointtisi korostamiseen saattaa heikentää asiakirjasi hyödyllisyyttä ajan myötä, paitsi erityistapauksissa. Voit estää tämän käyttämällä laajempaa aikakehystä, kuten "viimeisen seitsemän vuoden aikana", mikä antaa työllesi uskottavuuden.
9. Käytä asiaankuuluvia esimerkkejä
Kun kirjoitat teknistä dokumenttia, käytä eläviä esiintymiä korostaaksesi pointtejasi. Koska yleisösi lukee kirjoitustasi saadakseen taidon, ratkaistakseen ongelman tai oppiakseen ohjeita, sinun on annettava heille käytännöllisiä ja suhteellisia esimerkkejä.
Nämä esimerkit parantavat työsi luettavuutta ja välittävät monimutkaista tietoa lukijallesi tarjoten kontekstia tuotteille ja prosesseille. Tällä tavalla he käyttävät tuotteita todennäköisemmin tarkoituksella ja turvallisesti.
10. Pyydä kolmannen osapuolen arvostelu ennen julkaisua
Teknisen asiakirjan tulee aina käydä läpi yhteistyöprosessin, jossa kirjoittaja ja arvioija ovat mukana. Kolmannen osapuolen arvostelu auttaa luomaan yleisökeskeisen, virheettömän ja vaikuttavan asiakirjan.
Asiakirjan alkuperäisenä kirjoittajana olet saattanut kirjoittaa monia luonnoksia ennen lopullisen asiakirjan luomista. Huolimatta siitä, kuinka hyvältä asiakirjasi näyttää, älä kuitenkaan ole riippuvainen vain älystäsi.
Ryhdy ammattimaiseksi tekniseksi kirjoittajaksi jo tänään
Teknistä kirjoittamista ohjaavien olennaisten sääntöjen ymmärtäminen tekee sinusta taitavamman ja halutumman. Monet organisaatiot tietävät, kuinka tärkeää on, että niiden tuotteet tai palvelut ovat hyvin markkinoituja loppukäyttäjille, ja tavoitteesi teknisenä kirjoittajana on auttaa heitä saavuttamaan tämän.
