Technical Writing Essentials

Kuvaavassa teknisessä kirjoittamisessa käytetään visuaalisen aineiston ja tekstin yhdistelmää sekä ”näyttämään” että ”kertomaan” lukijalle välitettävästä tiedosta. Kuten luovemmissa kuvauksissa, myös teknisissä kuvauksissa hyödynnetään toisinaan ”viittä aistia” ja metaforisia vertailuja (analogioita), jotta lukija voi täysin hahmottaa kuvatun asian. Useimmiten ne kuitenkin perustuvat konkreettisiin, mitattavissa oleviin kuvauksiin. Tekniset kuvaukset voivat olla monenlaisia tarkoituksesta ja yleisöstä riippuen. Kuvaukset voivat vaihdella lyhyestä lauseesta kappaleeseen, koko raportin osaan tai kokonaiseen käsikirjaan. Huonosti kirjoitetut tekniset kuvaukset voivat aiheuttaa sekaannusta, tuhlata aikaa ja johtaa jopa katastrofiin! Tekniset tuotekuvaukset ovat usein lakisääteisiä turvallisuuden ja vaatimustenmukaisuuden varmistamiseksi. Yksityiskohtien huomioiminen on ratkaisevan tärkeää.

Tuotespesifikaatiot edellyttävät yksityiskohtaisia kuvauksia suunnittelun piirteistä; ohjeet edellyttävät usein erityisiä kuvailevia yksityiskohtia, jotta lukijalle voidaan ”näyttää”, mitä pitää tehdä. Joitakin yleisiä teknisten kuvausten luokkia ovat seuraavat:

• Mekanismikuvaukset: Antavat yksityiskohtaisen yleiskatsauksen sellaisen työkalun, koneen tai muun mekaanisen laitteen fyysisistä näkökohdista, jossa on liikkuvia osia ja joka on suunniteltu suorittamaan tietty toiminto. Nämä voivat olla tuotekuvauksia myyntiä tai valmistusta varten, suunnittelumäärittelyjen dokumentointia, infografiikkaa, jne. Tässä luvussa keskitytään yksityiskohtaisesti tämäntyyppisiin kuvauksiin.
• Prosessikuvaukset: kuvaavat yksityiskohtaisesti sarjan tapahtumia (luonnon/biologisia/ekologisia, mekaanisia, sosiaalisia tai psykologisia ilmiöitä), jotka tapahtuvat tietyssä järjestyksessä tietyn lopputuloksen saavuttamiseksi. Nämä voidaan luokitella ei-opetuksellisiin prosesseihin (kuten prosessianalyysi siitä, miten polttomoottori toimii, tai luonnollisiin prosesseihin, kuten fotosynteesi) ja opetuksellisiin prosesseihin (kuten suositellut/pakolliset menettelyt ja nimenomaiset vaiheittaiset ohjeet, joita on noudatettava). (Katso yksityiskohtaista tietoa ohjeiden kirjoittamisesta kohdasta 7.7).
• Määritelmät: selventävät erityistä merkitystä, liittyvät usein tiettyyn asiayhteyteen tai ilmaisevat määriteltävien termien olennaisen luonteen. Niiden pituus voi vaihdella yksinkertaisesta selventävästä lauseesta usean sivun mittaiseen laajaan asiakirjaan. Määritelmiin sisältyy usein yksityiskohtaisia kuvauksia ja kuvamateriaalia ideoiden havainnollistamiseksi. Klikkaa alla olevaa linkkiä nähdäksesi opiskelijan PowerPoint-esityksen siitä, miten kirjoittaa tehokkaita määritelmiä teknisiä tarkoituksia varten. Tämä esitys on sisällytetty opiskelijan nimenomaisella luvalla.

Määrittelyt teknisessä kirjoittamisessa – Esimerkki opiskelijan esityksestä (.pdf)

Mekanismien kuvausten tulisi antaa selkeä käsitys kuvattavasta kohteesta, mukaan lukien

• Yleinen ulkoasu ja fysikaaliset ominaisuudet
• Kokonaisvaltainen toiminto/käyttötarkoitus
• Komponenttiosat
• Kuinka osat vaikuttavat toisiinsa muodostaen toimivan kokonaisuuden.

Lukijan pitäisi pystyä selkeästi kuvittelemaan ja siten ymmärtämään kuvatun kohteen luonne, mitä se tekee ja miten se toimii.

Lukijalle tämän selkeyden saavuttamiseksi kirjoittajan on valittava merkittävät yksityiskohdat ja järjestettävä tiedot loogisesti. Valitse yksityiskohtia, joita voidaan kuvata tarkasti ja mitattavasti, kuten

Lukijan tarpeesta riippuen kuvaus voi vaihdella yleisestä yleiskatsauksesta, joka vaatii vain muutaman lauseen, usean luvun käsikirjaan, jossa esitetään yksityiskohtaisesti mekanismien osien ja toimintojen kaikki osa-alueet teknisten ongelmatilanteiden selvittämiseksi ja korjausten suorittamiseksi. Hauska esimerkki jälkimmäisestä on Star Trek: The Next Generation: Technical Manual (kansi kuvassa 7.4.1), jossa on yksityiskohtaiset kuvaukset kaikista fiktiivisellä U.S.S. Enterprise-D:llä käytettävistä laitteista ja teknologiasta.

Ennen kuin aloitat kuvauksen laatimisen, sinun on pohdittava tarkoitustasi ja yleisöäsi: Miksi yleisösi tarvitsee tätä kuvausta? Mihin he käyttävät sitä? Kuvaatko erilaisia aurinkopaneelityyppejä keskivertokuluttajille auttaaksesi heitä valitsemaan heidän tarpeisiinsa parhaiten sopivan aurinkopaneelin? Annatko kaavioita teknikoille ja asentajille?

Kun tarkoituksesi ja kohderyhmäsi ovat selkeästi mielessäsi, laadi kuvaus, joka sisältää seuraavat elementit:

1. Määrittely: Mikä se on ja mikä on sen päätarkoitus?
2. Yleiskatsaus: Kuvaa mekanismin yleisilme (”iso kuva”).
3. Komponentit: Kuvaile tärkeimmät komponenttiosat merkityissä osioissa; harkitse tässä tietojen järjestystä huolellisesti. Luo looginen yhteys kunkin kuvatun komponentin välille.
4. Selitys: Miten osat toimivat yhdessä suorittaakseen tehtävänsä? Mitkä keskeiset periaatteet ohjaavat sen toimintaa? Harkitse, kuinka paljon yksityiskohtia tässä kohtaa tarvitaan kohdeyleisön kannalta.
5. Visuaalisuus: sisällytä grafiikkaa, joka havainnollistaa selkeästi mekanismia ja/tai sen osia. Näytä laite kokonaisuutena; harkitse erityisten yksityiskohtien esittämistä laajennetuissa näkymissä, leikkauskuvissa tai merkityissä kaavioissa. Voit jopa upottaa tai linkittää videoita, joissa laite näytetään toiminnassa.
6. Johtopäätökset: Tarkoituksesta riippuen voit tarkastella tuotteen historiaa, saatavuutta, valmistusta, kustannuksia, varoituksia jne.
7. Viitteet: Lähteet, joita olet käyttänyt kuvauksessasi, tai käytettävissä olevat lisätietolähteet (jos ne ovat merkityksellisiä).

Voit harkita jonkin mallin, kuten alla olevan teknisen kuvauksen mallin, käyttämistä pitäen mielessä, että vaikka mallit voivat olla hyödyllisiä oppaita, ne eivät tarjoa suurta joustavuutta eivätkä välttämättä sovellu kaikkiin tilanteisiin.

Esimerkkikuvaukset

Tarkastele kuviossa 7.4.2 esitettyä kuvausta ”Ylöspäin menevästä viisikosta” (klikkaa kuvaa saadaksesi suuremman version). Kuka kohdeyleisö voisi olla?

Vertaile kuvion 7 kuvausta.4.2 NASA:n verkkosivuilla annettuihin tietoihin Mars Curiosity Roverista.

Huomaa erot kuvausten yksityiskohtaisuudessa, sanastossa ja yleisessä tarkoituksessa. Jos käyttäisit NASA:n sivuston tietoja teknisen kuvauksen mallin täyttämiseen, saattaisit päätyä seuraavanlaiseen kaavioon. Tavoitteet

Saatat huomata, että jotkin näistä elementeistä eivät ole välttämättömiä; pohdi tässäkin tapauksessa, mitä kohdeyleisösi jo tietää. Yritä löytää tasapaino sen välillä, ettet tarpeettomasti toteaisi itsestäänselvyyksiä tai olettaisi virheellisesti, että lukijoillasi on tietoa, jota heiltä puuttuu.

Kuvauksesi yksityiskohtia ja sen osia tarkentaessasi ota huomioon seuraavat seikat:

• Organisaatio: Käytä loogista periaatetta kuvauksen järjestämiseen
  • Ylhäältä alas (tai alusta ylöspäin)
  • Vasemmalta oikealle (tai oikealta vasemmalle)
  • Sisältä ulos (tai ulkoa sisälle)
  • Tärkeimmästä vähiten tärkeisiin ominaisuuksiin
  • Keskuskomponentti oheiskomponentteihin
  • Materiaaliominaisuudet yms.
• Kieli: Käytä täsmällisiä, tarkkoja ja konkreettisia termejä – vältä epämääräisiä tai liian yleisiä termejä
  • Käytä oikeaa terminologiaa – määrittele termit niin kuin yleisösi kannalta on tarpeellista
  • Käytä analogiaa kuvaamaan tuntematonta asiaa tutun asian avulla
  • Käytä objektiivista kieltä – ei ”mainospuhetta” tai subjektiivisia termejä
  • Käytä preesensia, aktiivisia verbejä kuvaamaan, miltä laite näyttää ja mitä se tekee
  • Käytä sanoja, jotka luovat lukijan mieleen eläviä ja konkreettisia kuvia.

Valitse tavallinen, jokapäiväinen esine (kuten jokin kuvassa 7.4.3 esitetyistä esineistä) ja laadi tekninen kuvaus esineeseen perehtymättömälle yleisölle. Aloita kuvittelemalla kohderyhmä ja tarkoitus ja yritä sitten täyttää teknisen kuvauksen malli yksityiskohtaisilla tiedoilla. Laadi mallin tietojen avulla lyhyt, 1-2 kappaleen pituinen kuvaus ja lisää siihen asianmukaisesti otsikoitu kuvamateriaali.