Tieteellinen kirjoittaminen 5/6

1. Tieteellinen kirjoittaminen 5/6 Hiukan kielenhuoltoa -yhdyssanat, lyhenteet Esitystekniikan rityiskysymyksiä • luettelot • lainaukset • taulukot ja kuvat • algoritmit • kaavat

2. Yhteen vai erikseen? • Ks. esim. Konttinen, R., Nykysuomen käyttöopas. Gaudeamus, 1978, sivut 163-199. • kielenhuoltajat pyrkivät yksinkertaistamaan yhdyssanasääntöjä • “Pyri kirjoittamaan sanat erilleen (määritteen ja pääsanansanaliitoksi) ellei jokin sääntö vaadi niiden kirjoittamista yhteen (määriteosan ja perusosanyhdyssanaksi)”. • “suomen kieli on muutenkin pitkää” • tyhjentävää säännöstöä vaikea antaa; seuraavassa "algoritmisia" sääntöjä joilla ratkeavat yleisimmät ongelmat • Abstraktit käsitteet (tavalliset tk-asiat) yleisin syy kirjoittaa yhteen • Esimerkiksi äidinkieli, tiedonhaku, … • Taivutustesti auttaa alkuun: • "äly"+"talo"="älytalo" koska taipuu vain lopusta: " älytalossa" • "iso"+"talo"="isotalo" koska taipuu myös välistä: "isossatalossa"

3. Yhdyssanaksi ainakin jos … (1) • määriteosa on yleisnimi perusmuodossa: • "tieto"+"kanta"="tietokanta" • jos taas määrite ei ole yleisnimi tai on taipunut, niin usein sanaliitto: • "kaunis"+"saari"="kaunis saari" (mutta paikannimenä "Kaunissaari" …) • "aineiston"+"käsittely"="aineiston käsittely" • perusosa on -inen-laatusana: • "jalo"+"suku"="jalo suku": laatusana+yleisnimi • "jalo"+"sukuinen"="jalosukuinen": laatusana+laatusana • määriteosa on lyhentynyt: • "suuri"+"kone"="suurkone" (ellei sitten oikeasti "suuri kone") • "kymmenen"+"järjestelmä"="kymmenjärjestelmä" • "2000"+"luku"="2000-luvulla": numerot ovat siis lyhenteitä!

4. Yhdyssanaksi ainakin jos … (2) • sanaliitto olisi liian konkreettinen: • ammattisanana "tiedon"+"haku"="tiedonhaku" mutta yksittäisenä toimituksena "halutun tiedon haku" • tämän säännön liikakäyttö vie virastokieleen • omistusmuotoinen sanaliitto ("äidin kieli", "alueen valtaus") on konkreettisempi kuin vastaava yhdyssana ("äidinkieli", "alueenvaltaus") tai perusmuotoinen sanaliitto ("aluevaltaus") • sanaliittojäsentyisi väärin käyttöyhteydessään: • "Nopea syötteen käsittely on tärkeää." [sekä yhdyssana että sanajärjestyksen vaihtaminen mahdollinen] • "Nopean syötteenkäsittelyn menetelmät ovat tärkeitä." [käsittely nopeaa] • "Nopean syötteen käsittelyn menetelmät ovat tärkeitä." [syöte nopeaa]

5. Yhdyssanaksi ainakin jos … (3) • määriteosa on omistusmuodossa mutta pienentynyt monikosta yksiköksi: • (monien) "asiain tuntija" = (monen) "asian tuntija" = "asiantuntija" • Tämän säännön soveltaminen on selkeää vain silloin kun perusosaa vastaava verbi ("tuntea") viittaa pelkästään määritteeseen ("asiat"). • määriteosa on wanhassa omistusmuodossa: • "kansojen välinen" on "kansainvälinen" (jos kirjoitettava yhteen)

6. Yhdysmerkki • Perustapaus: määriteosa päättyy samaan vokaaliin jolla perusosa alkaa • "kuorma"+"auto"="kuorma-auto" • muuten sanarajan tilalle tulisi pitkä vokaali: kuormaauto" • Vieraskielinen alkuosa tai lyhenne erotetaan yhdysmerkillä: • Windows-ympäristö, C-kieli,laudatur-tutkielma (myös laudaturtutkielma) • Moniosaista määriteosaa seuraa sanaväli ja yhdysmerkki: • Save as -painike, pro gradu –tutkielma • Välitön perusosa liittyisi vain määriteosan viimeiseen sanaan. • Poikkeus: jos määriteosana yhdyssana, niin ei sanaväliä (koska nyt ei sekaannuksen mahdollisuutta). • Itä-Suomi-projekti • Ääriarvo-ongelma

7. Lyhenteistä • Taivuttamista kannattaa välttää • "C-kielellä" mieluummin kuin "C:llä" • parempi luettavuus, lisäetuna "tyypitys" • Mutta jos kuitenkin taivutetaan niin … • kirjaimittain luettaviin taivutuspääte kaksoispisteellä • TCP/IP:tä, WWW:ssä • sanana luettavia taivutetaan suoraan • Javalla, Corbassa

8. Vieraskielisten sanojen taivutuksesta • Vieraskielisiä sanoja taivutettaessa sana luetaan alkuperäiskielellään taivutusasua valittaessa: • Nimi "Maginot" ääntyy ranskassa (suunnilleen) "Masinoo", joten "Maginot’lle" eikä "Maginotille". • Parempi on tosin muuttaa lausetta niin ettei taivutusta tarvita.

9. Termit ja määritelmät • Informatiivinen teksti jäsentelee todellisuutta • Tieteellinen teksti toimii täsmällisesti määriteltyjen ja systemaattisesti käytettyjen termien varassa • valituissa termeissä pitäydyttävä lievän toiston uhallakin • termit • käsitteiden nimityksiä viestintää varten • määritelmät • käsitteiden sisällön kuvauksia

10. Määritelmä: sisältö. Sanakirjamääritelmä ihminen, n., kaksijalkainen höyhenetön eläin. Termi: nimi.

11. Mistä termejä? • Atk-sanakirja • suomenkielinen perus- ja yleislähde • "akateeminen", huolellisuuteen ja systemaattisuuteen pyrkivä • 3000 yleisen termin englanti-suomi-vastineet sivun http://www.ttlry.fi/ kautta • http://www.tsk.fi/termitalkoot/ • suppea yleistietotekniikkatermejä selityksineen tarjova sivusto • http://www.kotus.fi/svenska/artiklar/bokenutanband/infoordlis.shtml • finsk-engelsk-svensk informatikordlista

12. Englanninkielisiä termilähteitä • Yleisten tietotekniikkatermien selityksiä • http://foldoc.doc.ic.ac.uk/foldoc/contents.html • Free On-Line Dictionary of Computing • http://whatis.com • http://www.onelook.com/ • Useita sanastoja yhdistävä metahakukone • http://en.wikipedia.org/wiki/Main_Page • Erikoistermien merkitys selviää yleensä vain hyvistä lähdeteoksista. • Esim. suomenkielinen "Tekoälyn ensyklopedia" sisältää vakiintuneita käännöksiä oman alansa keskeisille termeille. • Suomenkielisiä vastineita keksittävä itse. • Silloin alkuperäistermikin näkyviin - lukija saattaa tuntea sen jo entuudestaan, mutta toisella nimellä! • Käytä suomalaisia tutkijoita vakiintuneiden suomennosten löytämiseksi

13. Termien kääntämisestä • Tavoitteita • kuvaavuus • esim. 'sivusto' vs. 'paikka' tai 'saitti' • napakkuus, käytettävyys • 'sivustokartta', 'palvelusivusto' • vastaavuus alkukieleen • usein vain tämä huomioitu? • vrt. 'jäsentää' ja 'parseroida' tai 'parsia' (engl. parse) • Vakiintumattomien käännösten alkukielinen vastine hyvä esittää, jos ei ilmeinen: • "Käänteistekniikalla (reverse engineering) tarkoitetaan menetelmiä, joilla …"

14. Esitystekniikka? • tavoitteena aina sanoman perillemeno • Miten sanoma menee parhaiten perille? • hahmottamisen apuvälineet • visuaaliset (tekstin jako ja ryhmittely, otsikointi, typografia) • sanalliset (lauserakenne, sanonta, tyyli, kielen virheettömyys) • tiedon esitysmuoto • suorasanainen teksti (sisältäen kaavat, luettelot) • tekstin ulkopuoliset elementit • kuvat, taulukot, esimerkit • periaate: tieto esitellään vain kerran, lisäelementit tukevat tulkintaa • Kuviin, taulukoihin ym. silti viitattava tekstissä;ellei tarvetta tunnu olevan, tarvitaanko kyseistä elementtiäkään? • Otsikot yms eivät edistä tekstiä

15. Luettelot • harvoin tarpeen • yleensä tavoitteena suorasanainen teksti • luettelot usein merkki luonnosmaisuudesta • joskus selkeyttää • esim. käyttöohjetyylisissä dokumenteissa • jos tarvetta viitata luetelman osiin • voidaan esittää useilla tavoilla: • numeroituna listana • arabialaisin numeroin: 1., 2., 3., … • roomalaisin numeroin: (i), (ii), (iii), … • ns. ranskalaisina viivoina (engl. "bullet points") • ns. määritelmälistana ja • tekstiin upotettuna.

16. Luettelot (2) • yhtäjaksoisen tekstin osia • virkkeen osa tai jono virkkeitä • normaalit välimerkit (paitsi että ranskalainen viiva / "bullet" riittää pilkuksi) • edeltävä kaksoispiste (tai ei) lauseen muodon mukaan • loppuun piste - ei siis pitäisi enää jatkaa lausetta • luetelman osien samanmuotoisuus • ei sekaisin esim. yksittäisiä sanoja ja lauseita (samantasoisuusperiaate kuten aliotsikoinnissa) • milloin numeroitu lista? • kun järjestys oleellinen (suoritusaskeleet tms.) • kun tarve viitata luetelman osiin

17. Luetteloesimerkki Algoritmi on virheellinen, jos jokin sen suoritus • tuottaa väärän tuloksen • johtaa virheelliseen tai määrittelemätömään tilanteeseen tai • on päättymätön. Algoritmi voi olla virheellinen kolmesta syystä: • Jokin sen suoritus tuottaa väärän tuloksen. • Jokin sen suoritus johtaa virheelliseen tai määrittelemätömään tilanteeseen. • Jokin sen suoritus on päättymätön. • Lisää esimerkkejä ks. esim. Mäkelä, M., Esitystekniikka ja suullinen esitys

18. Käyttö - lainaus - varkaus Jos lainaat yhdestä lähteestä, se on varkautta. Jos lainaat monesta lähteestä, se on tutkimusta. • Kun esität toisen kirjoittajan ajatuksensinunomilla sanoillasi ja rakennuspalikkana sinun omassa ajatusrakennelmassasi, niin viittaus (heti) perään ja käyttösi on luvallinen. • Mutta jos päätätkin esittää toisen kirjoittajan ajatuksiahänen omilla sanoillaan, niin se on lainaus jonka pitää erottua selvästi omasta tekstistäsi. • Kaikki muu on toisen kirjoittajan ajatusten ja tekstin luvatonta käyttöönottoa eli (kirjallinen) varkaus! • Tietojenkäsittelytieteessä suoria lainauksia käytetään harvoin – yleensä lainataan toisilta ajatuksia omien osiksi, mutta ei kommentoida niitä (humanistien tapaan).

19. Lainat julki! • LYHYT (virke tai pari): teksti lainausmerkkien sisään ja viittaus sulkevan lainausmerkin perään. • "Jos ottaa seitsemän peräkkäistä sanaa suoraan lähteestä, on se jo lainaus!" (anon.) • suomeksi kirjoitettaessa nämä "tavalliset" lainausmerkit • PITKÄ: teksti sisennettyjen marginaalien väliin ja viittaus kavennetun alueen (tai lainausta edeltävän esittelytekstin) loppuun. • Suomentaminenkin on lainaamista - kääntäjä näkyviin viittauksen yhteyteen! • Myös lainattuun tekstiin tehdyt muutokset näkyviin! • lisäykset [hakasulkeissa] • poistot ellipsin "…" lisäyksiä • jos korostuksia, niin korostaja mainittava viittauksen kanssa

20. Esimerkki pitkästä lainasta omaa tekstiä lainauksen esittelyineen Esimerkiksi humanististen tieteiden kaksijakoisesta suhtautumisesta käsitteiden määrittelyyn käy seuraava näyte [FeA00, sivu 9] (käännös ja korostukset Matti Nykäsen): itse lainaus visuaalisena elementtinä [Me] elämme maailmassa jossa mikään ei ole pysyvää ja määritelmät näyttävät aina petollisilta […] Minulla ei riitä kärsivällisyyttä sanapeleihin: tahdon jokaisen tutkimuksen ainakin yrittävän sanoa jotakin varmaa. Matemaattisissa tieteissä täsmälliset määritelmät taas ovat kivijalka jonka päälle kaikki muu rakennetaan. Periaate: lukijan on tiedettävä tarkasti mikä osa tekstistä on kenenkin vastuulla!

21. Kuvat ja taulukot • elävöittävät esitystä, helpottavat selailevaa informaation hakua, korostavat keskeisiä aiheita • käyttö harkiten: vain oleelliselle informaatiolle • kiinnittävät lukijan huomion • työläitä laatia • kuvasta helpompaa nähdä yleistyksiä, taulukot tarkempia • otsikoidaan ja numeroidaan (läpi työn tai luvuittain) • otsikko kuvan alla mutta yleensä taulukon päällä • kuvien ja taulukoiden itsenäisyys: otsikon yhteydessä selityslohko, jossa • tarvittavat selitykset niille merkinnöille jotka esiintyvät vain tässä kuvassa / taulukossa • lainatun kuvan kuvatekstiin lähdeviite

22. Kuvat ja taulukot: otsikointi ja viittaaminen Kuva 3. Pascal-testien tulokset [Mit92, s. 123]. Mittermannin koetulokset esitetään kuvassa 3. Mittermann on esittänyt laajaan koeaineistoon perustuvia tuloksia (kuva 3). • kuvia ja taulukoita käsiteltävä tekstissä • vetoaminen argumentoinnin tukena, oleellisten tai kiinnostavien asioitten korostaminen • tarpeelliset lisäselitykset (otsikko yleensä vain muutamia sanoja) • mahdollisimman lähellä ennen kuvaa/taulukkoa • LaTeX:Kuva/taulukko heti sen kappaleen jälkeen jossa ensimmäinen viite jolloin automatiikka sijoittaa sen yleensä järkevästi. "Käsipeli" vielä turhauttavampaa...

23. Kuvat ja taulukot: sijainti ja sisältö • kuva/taulukko ei saisi katkaista tekstikappaletta • usein esim. seuraavassa sivun ala- tai ylälaidassa • Kuvat eivät ole yhtäjaksoisen tekstin osia! • pienet taulukot mahdollisesti, kuten kaavat - jos tarvitaan "vain tämän kerran juuri tässä kohdassa" ... • LaTeX: "kelluvat elementit" joiden paikka voi elää. • kuvien sisältö vaihtelee • kaaviot, diagrammat, teksti (algoritmit, ohjelmaesimerkit, …) • tekstin tilaajalta joskus tarkat(kin) ohjeet sisällöstä, otsikoinnista ja viittauskäytännöstä • Kuvissa oleva teksti ei pienempi kuin 50% muun tekstin koosta • esimerkkejä: ks. Mäkelä, M., Esitystekniikka ja suullinen esitys sekä luku 6 teoksessa Zobel, J., Writing for Computer Science. Springer, 1997. • funktioiden kuvaajia ja tilastollisia diagrammeja piirtää esim. julkisohjelma gnuplot

24. Määritelmät, esimerkit, lauseet Määritelmä 1.Teoreeman kaltainen (engl. theorem-like) osio on tekstin sisällä oleva, paikkaansa sidottu, ympäristöstään visuaalisesti erottuva, myöhempää viittaamista varten otsikoitu ja numeroitu tekstikappale. Tavallinen esitystapa on lihavoida numeroitu otsikko, korostaa sisältö, sekä jättää tilaa ylle ja alle. (Huomaa määriteltävän käsitteen korostus ja alkukielinen asu!) Esimerkki 2.Määritelmät, esimerkit ja matemaattiset tulokset (lauseet ja apulauseet) ovat teoreeman kaltaisia osioita. Lause 3.Teoreeman kaltaiset osiot ovat hyödyllisiä. Todistus.Muuten matemaatikot eivät käyttäisi niitä koko ajan. M.O.T. Muita todistuksen loppumerkkejä ovat Q.E.D. ja "laatikko".

25. Algoritmit Miten yhdistää inhimillinen luettavuus ja tietokoneellinen tarkkuus? Selittämällä! Erilaisia esitystapoja, mm. • numeroitu askelluettelo • "Jos K on epätyhjä, palaa askeleeseen 2" • pseudokoodi • sopii kuvan sisällöksi • voi johtaa liian detaljoituun esitystasoon • spesifien ohjelmointikielten piirteitä tulisi välttää • "kirjallinen" (literate) ohjelmointi (“ohjelman suoritus ihmiselle eikä koneelle”), • vuokaaviot • ei suositeltavia - varsinkin rekursion esittäminen vaikeaa Yhdessä tekstissä ei montaa eri formalismia samalle asialle! Esimerkkejä ks. Zobel, s. 107-109

26. Kaavat • aina virkkeen osia • oltava luettavissa sujuvasti • yksinkertaiset tekstiriveillä • tärkeät tai monimutkaiset omalla rivillään sisennettynä • lauseen predikaattia ei kuitenkaan liene hyvä matematisoida (epä)yhtälömerkiksi: "Koska n>1 pätee, niin …" • viittausta varten numero (suluissa) oikeaan laitaan • kaavoissa esiintyvät muuttujat syytä erottaa muusta tekstistä systemaattisesti, esim. kursivoimalla • LaTeX:math italics, $x+y$, \[T = n_k t_k + n_r t_r \] Suoritusajalle saadaan näin lausekeT = nk tk + nr tr . (3)Tämä kaava on selkeämpi kuin kaava (2), sillä …

27. Kaavat: yleisiä ohjeita • Muuttujien "tyypitys”(auttaa sekä lukemista että ymmärtämistä) EI: S:ään kerätään saavutettavat solmut. VAAN: Joukkoon S kerätään saavutettavat solmut. • Ei kaavoja (numeroita, numerovälejä,...) lauseen alkuun tai peräkkäin (muuten lause- ym. rajat vaikeita hahmottaa) EI: Jokainen xi, 0≤ i ≤ n+1, on positiivinen. VAAN: Alkio xion positiivinen kaikilla i = 0, …, n+1. • Formaali esitys (kaavat, algoritmit, …) käyttöön - mutta vasta sitten kun "luonnollisen kielen" keinot eivät enää riitä takaamaan esitykselle yksikäsitteistä tulkintaa! • "olkoon s=(a+b)/2" vastaan "olkoon s lukujen a ja b keskiarvo"

28. Kirjasintyyleistä • Kirjasintyylit tärkeä selkeyttämiskeino • Liika kirjavuus sekavoittaa • pitkälle pääsee yhdellä peruskirjasimella tai -perheellä (esim. Times (New) Roman –kirjasintai Computer Modern -perhe) varioituna • lihavoinnilla (otsikot) • kursivoinnilla (termien määrittelyesiintymät, erityiset painotukset) • Times-perhe luotu sanomalehteen: tiivistä tekstiä lyhyeen lukemiseen. Muulloin jokin muu ns. Serif-perhe parempi? • Ns. Sans Serif –perheet hyviä SUURILLE pinnoille joissa kirjainten "kiemurat" häiritsevät: julisteisiin, kalvoille (kuten Arial tässä),… • normaalia pistekokoa (11-12 pt) syytä varioida niukasti • otsikot, ala- ja yläindeksit • tekstiin sisältyvät komennot, syötteet ym. selkeä erottaa tasavälisellä kirjasimella (esim. Courier; LaTeX-komennot \texttt ja \mathtt)