Sisältö
- Teknisen kirjoittamisen historia
- Teknisten kirjoittajien taito
- Tekniset kirjoitusesimerkit
- Ei vikoja, ei stressiä - vaiheittaiset ohjeet elämää muuttavien ohjelmistojen luomiseen tuhoamatta elämääsi
- Resurssit teknisille kirjoittajille
- johtopäätös
Lähde: Saniphoto / Dreamstime.com
Ottaa mukaan:
Olitpa tekninen kirjoittaja tai etsit sellaista, nämä ovat taidot, jotka ovat välttämättömiä työssä.
Teknisiä kirjoittajia tarvitaan missä tahansa, missä on tekniikkaa. Käsityö vaatii tietyn taitoa. Yhden on oltava levoton, tiivis - jopa persoonaton. Vaikka mikä tahansa kirjoittaminen vaatii luovuutta, tekninen kirjoittaminen vaatii sen olevan hienovarainen. Niiden, jotka ajattelevat palkata teknistä kirjoittajaa, on tiedettävä, mitä kannattaa etsiä. Kaikkien, jotka haluavat tulla yhdeksi, on tehtävä joitain kotitehtäviä.
Teknisen kirjoittamisen historia
Joseph D. Chapline hyvitetään ensimmäisenä tietokonedokumentaation teknisenä kirjoittajana. IEEE Professional Communication Society -lehden tammikuun 2008 painos (sivu 21) kertoo tarinan. Vuonna 1949 hän kirjoitti käyttöohjeet BINAC-tietokoneelle. Chaplines 2011 -kirjoittaja kertoo kuinka hän työskenteli myös Moore School of Engineerings Differential Engine -yrityksessä. Ja hän loi kattavan käsikirjan Eckert and Mauchleys ENIAC: lle. Myöhemmin Chapline palasi musiikkiin, ensimmäiseen rakkautensa, ja vietti loppuelämänsä palvelemalla urkurina ja kuoronjohtajana sekä luomalla putkiorgaaneja. Hän vertasi BINAC-käsikirjoituksen kirjoittamista Mozartin musiikilliseen sävellysprosessiin. Chapline opetti yli 200 teknisen kirjoituksen luokkaa ennen paluutaan musiikkimaailmaan.
Frederick M. OHara, Jr, väitti lyhyessä teknisen viestinnän historiassaan, että tekninen viestintä alkoi hyvissä ajoin ennen kuin herra Chapline tuli mukaan. Hän mainitsee atsteekkien, kiinalaisten, egyptiläisten ja babylonialaisten tieteelliset tiedot, mainitsee Taškentin papiston Muhammad ibn Musa Al'Khowarizmin algoritmin keksinnän 12-luvulla ja jäljittää teknisen viestinnän historiaa renessanssin ajan ja nykypäivään. Hän väittää, että tekninen kirjoittaminen johtuu paljon tieteellisestä menetelmästä, ja tarjoaa sen mukautuksen:
- Esitä ongelma.
- Kuvaile menetelmää.
- Näytä tulokset.
- Tee johtopäätökset.
Teknisten kirjoittajien taito
Society for Technical Communication -sivustolla todetaan, että tekniseen viestintään sisältyy:
- Viestintä teknisistä tai erikoistuneista aiheista
- Viestintä tekniikan avulla
- Annetaan ohjeita siitä, miten tehdä jotain
Tämä määritelmä vaikuttaa melko laajalta, mutta niin on myös teknisen kirjoittamisen ala. Tietotekniikan asiantuntijat tuntevat sen merkityksen päivittäin käytettävässä dokumentaatiossa. Mutta itse ammatti voi ulottua mihin tahansa tekniseen aiheeseen. Tässä on yhteenveto taitoista, joita tekninen kirjoittaja tarvitsee kirjoittamisen avustamisen ansiosta:
- Kirjoitustaidot
- Teknisiä taitoja
- Työkalutaidot
- Haastattelu- ja kuuntelutaidot
- Suunnittelutaitoja
- Käytettävyys ja testaustaidot
Tekninen kirjoittaja voi olla taitavampi jollakin näistä alueista, mutta jos häneltä puuttuu jokin niistä, hänen uransa saattaa kärsiä. Kirjailijan tulisi pystyä korvaamaan tietyn alueen teknisen asiantuntemuksen puute riippumattomalla tutkimuksella ja aiheen asiantuntijoiden hyvillä haastatteluilla.
Tekniset kirjoitusesimerkit
Kaikkien koulutuksen saaneiden, etenkin teknisten kirjoittajien, tulisi pystyä kuvaamaan selkeästi ja tarkasti prosessi. Kuudennen luokan opettaja määräsi kerran opiskelijoilleen kirjoittamaan vaiheittaisen kuvauksen maapähkinävoin ja hyytelövoilevyn valmistamisesta, ja myöhemmin jokaisella oppilaalla oli mahdollisuus syödä kirjoitettujen ohjeidensa mukaisesti valmistettu voileipä. Jotkut heistä olivat omituisia keittoja. Teknisten kirjoittajien on oltava varovaisia kirjoittaessaan.
Esimerkkejä teknisistä kirjoituksista ovat käyttöoppaat, ohjelmistojen asennusoppaat, palvelutasosopimukset, ohjetiedostot, valmisteet ja julkaisutiedot. Tietoliikennekokemukseni aikana olen nähnyt erinomaisen dokumentoinnin prosessien ja menettelyjen suhteen Cisco Systemsille, Nortel Networksille, Huaweille, Microsoftille ja monille muille. Hyvä tekninen kirjoittaminen on selkeää, tiivistä ja kattava. (Lisätietoja viestinnästä, katso Viestintätaitojen merkitys teknisille ammattilaisille.)
Ei vikoja, ei stressiä - vaiheittaiset ohjeet elämää muuttavien ohjelmistojen luomiseen tuhoamatta elämääsi
Et voi parantaa ohjelmointitaitojasi, kun kukaan ei välitä ohjelmiston laadusta.
Resurssit teknisille kirjoittajille
Teknisen kirjoittamisen aloittaminen auttaa tekemään kotitehtäviäsi. Yksi paikka teknisen kirjoitusuran aloittamiseen on Society for Technical Communication. Organisaatioiden verkkosivuilta löydät tietoa jäsenyydestä, koulutuksesta, konferensseista, julkaisuista ja muusta. On monia kirjoja ja luokkia, jotka haluavat kirjoittajille oppia käsityötään. Writers Write, Inc. tarjoaa online-luettelon käytettävissä olevista resursseista.
Itseopiskelu on erinomainen tapa kehittää uraasi. Kymmenen aiheesta lukeman aiheen asettaminen pyrkii tekniseen kirjoittajaan oikeaan suuntaan. Ja kun opit, etsi jokainen mahdollisuus kirjoittaa kokemusta työssä ja koulussa, erityisesti teknisistä aiheista. (Katso yksi tapa kirjoittaa taitosi harjoittamiseen: onko sinun aika aloittaa kyseisen tekniikan blogi?)
johtopäätös
Tekniselle kirjoitusuralle on monia polkuja. Jotkut ihmiset tulevat teknisestä taustasta ja huomaavat, että heidän uransa on kehittynyt viestinnän painopisteeksi. Toiset tulevat englannin tai journalismin kouluista ja yhdistävät koulutuksensa kiinnostukseen tekniikkaan. Veneen kehittäminen on yksi asia; työmahdollisuuksien löytäminen on toinen asia. Monet meistä kompastuvat uraamme sen sijaan, että suunnittelisivat niitä. Paras neuvo on oppia niin paljon kuin pystyt. Kun valmistelu kohtaa mahdollisuuden, ura, josta olet unelmoinut, tulee todellisuudeksi. Tietysti voit aina kirjoittaa oman menestysmenetelmäsi ja nähdä sen loppuun asti.