Rakenteinen dokumentointi

Kohteesta Wikipedia
Siirry navigaatioon Siirry hakuun

Rakenteinen dokumentointi on informaation jäsentelyä metakielen avulla. Digitaalisen informaation jäsentelyyn sopivia metakieliä ovat varsinkin SGML-standardiin pohjautuvat merkintäkielet.[1]

Rakenteisen dokumentoinnin tarkoituksena on helpottaa dokumenttien julkaisua ja lisätä mahdollisuuksia käyttää jo kirjoitettua materiaalia uudestaan uusissa konteksteissa.[2] Rakenteinen dokumentointi helpottaa varsinkin suurien tekstimäärien käsittelyä ja muotoilua. Yleisesti käytetyt SGML-standardiin perustuvat merkintäkielet helpottavat myös informaation siirtämistä tietojärjestelmästä toiseen.[3]

Rakenteinen dokumentointi on usein myös modulaarista, mikä tarkoittaa asiakokonaisuuksien jakamista useammaksi pienemmäksi kokonaisuudeksi. Näitä sisältökokonaisuuksia kutsutaan moduuleiksi.[4]

Rakenteisen dokumentoinnin juuret ovat kirjapainoalalla, jossa ennen tekstinkäsittelyohjelmien kehittymistä kirjoitettiin tekstin muotoilu käsin sivun yhteyteen. Näin määriteltiin muun muassa tekstin fontti, fontin koko, tekstin korostaminen (kursivointi, lihavointi tai alleviivaus) sekä sivulle tulevat sisennykset.[5] Rakenteisen dokumentoinnin perusidea on sama. Tekstin yhteyteen merkitään sen rakenne, jota sitten eri julkaisualustat tulkitsevat tyyliasetustensa mukaisesti.[6]


Rakenteista dokumentointia ei tule kuitenkaan sekoittaa esitykselliseen dokumentointiin. Rakenteisella dokumentoinnilla määritellään ainoastaan tekstin rakenne, kuten otsikot, kappalejaot ja esimerkiksi listat. Tekstin muotoilut, kuten otsikon koko, leipätekstin väri ja listan ulkoasu määritellään puolestaan esityksellisellä dokumentoinnilla.

Rakenteisen dokumentoinnin käytännöt[muokkaa | muokkaa wikitekstiä]

Rakenteisessa dokumentoinnissa tekstin osat jaetaan pieniin loogisiin kokonaisuuksiin, joita kutsutaan elementeiksi. Teksti voidaan esimerkiksi jakaa elementeillä pääotsikoksi, väliotsikoiksi ja kappaleiksi. Tekstin lopullinen ulkoasu määräytyy puolestaan sen julkaisuympäristön mukaan.[7] Esimerkiksi eritasoisille otsikkoelementeille voidaan määritellä erilaisia tyylejä, jolloin sama sisältö näyttää erilaiselta eri julkaisualustoilla. Tästä on hyötyä varsinkin, kun sama materiaali halutaan julkaista usealla eri laitteella.[8] Hyvä esimerkki tästä ovat verkkosivut, jotka ovat saatavilla myös mobiiliversioina.

Rakenteisessa dokumentoinnissa käytettävissä olevat elementit riippuvat siitä, millä merkintäkielellä dokumentin muotoilu tehdään. Yleisimmin käytössä ovat SGML-pohjaiset merkintäkielet, kuten HTML, XML, XHTML ja DITA.

Rakenteisille dokumenteille määritellään aina niiden dokumenttityyppi eli document type definition (DTD).

SGML-pohjaiset merkintäkielet[muokkaa | muokkaa wikitekstiä]

Pääartikkeli: SGML

Digitaalisessa julkaisemisessa yleisesti käytetyt merkintäkielet pohjautuvat SGML-standardiin. SGML on metakieli, jolla voi generoida uusia merkintäkieliä.[9] SGML on siis eräänlainen merkintäkielten peruskielioppi, jonka pohjalta on mahdollista luoda käyttötilanteeseen sopivia "lauseita" eli elementtejä.

HTML[muokkaa | muokkaa wikitekstiä]

Pääartikkeli: HTML

HTML on verkkojulkaisuissa yleisemmin käytetty merkintäkieli.[10] HTML-merkintäkieli ei ota kantaa tekstin sisältöön vaan keskittyy sen rakenteeseen, mikä tekee siitä joustavan ja sopivan useaan eri käyttötarkoitukseen.[11]

XML[muokkaa | muokkaa wikitekstiä]

Pääartikkeli: XML

XML on sekä itsenäinen merkintäkieli että standardi, jonka pohjalta voi kehittää uusia merkintäkieliä. XML on HTML-kielen tapaan yksinkertaistettu versio SGML-standardista mutta mahdollistaa HTML-kieltä monimutkaisempia rakenteita ja julkaisumuotoja.[12]

XHTML[muokkaa | muokkaa wikitekstiä]

Pääartikkeli: XHTML

XHTML on XML-versio HTML-kielestä. Tämä tarkoittaa, että XHTML on uudelleen määritelty versio HTML-kielestä, johon on sovellettu XML-kielen standardeja.[13]

DITA[muokkaa | muokkaa wikitekstiä]

Pääartikkeli: DITA

Varsinkin teknisessä viestinnässä suosittu DITA on XML-pohjainen merkintäkieli. DITA on suunniteltu varta vasten käyttöohjeiden ja muiden vastaavien ohjaavien tekstien rakenteiseen dokumentointiin.[14]

Esimerkki rakenteisesta dokumentoinnista[muokkaa | muokkaa wikitekstiä]

Alla esimerkkinä Kalevalan ensimmäisen runon kaksi ensimmäistä säkeistöä rakenteisen dokumentoinnin periaatteella esitettynä. (Käytetyt elementit eivät ole käytössä edellä mainituissa merkintäkielissä, vaan ne on luotu esimerkkiä varten.)

<span><runo></span>
<br/>
<br/>
<span><otsikko>Ensimmäinen runo</otsikko></span>
<br/>
<br/>
<säkeistö>
<br/>
<säe>Mieleni minun tekevi, aivoni ajattelevi</säe>
<br/>
<säe>lähteäni laulamahan, saa'ani sanelemahan,</säe>
<br/>
<säe>sukuvirttä suoltamahan, lajivirttä laulamahan.</säe>
<br/>
<säe>Sanat suussani sulavat, puhe'et putoelevat,</säe>
<br/>
<säe>kielelleni kerkiävät, hampahilleni hajoovat.</säe>
<br/>  
</säkeistö>
<br/>
<säkeistö>
<br/>
<säe>Veli kulta, veikkoseni, kaunis kasvinkumppalini!</säe>
<br/>
<säe>Lähe nyt kanssa laulamahan, saa kera sanelemahan</säe>
<br/>
<säe>yhtehen yhyttyämme, kahta'alta käytyämme!</säe>
<br/>
<säe>Harvoin yhtehen yhymme, saamme toinen toisihimme</säe>
 <br/>
<säe>näillä raukoilla rajoilla, poloisilla Pohjan mailla.</säe>
<br/>
</säkeistö>
<br/>
</runo>

Rakenteisen dokumentoinnin edut ja haitat[muokkaa | muokkaa wikitekstiä]

Rakenteisen dokumentoinnin etuja ovat sen uudelleenkäytettävyys ja erilaiset julkaisumahdollisuudet. Joustavuutensa ja muokattavuutensa ansiosta myös rakenteisten dokumenttien päivittäminen on helppoa. Lisäksi se voi vähentää käännöskustannuksia, sillä käännettäväksi voidaan lähettää kokonaisen tekstin sijaan yksittäisiä moduuleja, jossain tapauksissa jopa yksittäisiä elementtejä.[15] Rakenteinen dokumentointi helpottaa myös tiedonsiirtoa eri tietojärjestelmien välillä, sillä SGML- ja XML-kieliin pohjautuvat merkintäkielet eivät ole ohjelmisto- tai järjestelmäsidonnaisia.[16]

Toisaalta rakenteisen dokumentoinnin käyttöönotto on työläs prosessi, sillä jo olemassa olevan materiaalin muuttaminen rakenteisiksi dokumenteiksi vaati paljon manuaalista työtä. Lisäksi se saattaa joissakin tapauksissa aiheuttaa koulutus- ja/tai ylläpitokustannuksia.[17]

Rakenteinen dokumentointi Suomessa[muokkaa | muokkaa wikitekstiä]

Rakenteinen dokumentointi on yleinen käytäntö myös Suomessa, ja esimerkiksi teknisen viestinnän alalla SGML- ja XML-kielien käyttö on niin tavallista, että näiden osaamista voidaan jo pitää osana teknisen viestijän perustaitoja.[18] Ensimmäistä kertaa rakenteinen dokumentointi sai Suomessa laajempaa huomiota Eduskunnan kirjaston järjestämässä SGML-seminaarissa joulukuussa 1994.[19][20]

Rakenteista dokumentointia Suomessa on edistänyt myös Opetusministeriön rahoittama RAJU -projekti ("Rakenteinen Julkaiseminen yliopistoissa"). Projekti toteutettiin Vaasan yliopiston, Jyväskylän yliopiston ja Teknillisen korkeakoulun yhteistyönä.[21] Jyväskylän yliopistossa projekti oli osa yliopiston laajempaa DigiPub-tutkimusprojektia.[22]

Lähteet[muokkaa | muokkaa wikitekstiä]

  1. Oulun yliopisto, Rakenteinen julkaiseminen yliopistossa. Viitattu 23.11.2012. http://herkules.oulu.fi/isbn9514252438/isbn9514252438.pdf
  2. Seppälä, Markus. 2008. Rakenteisen dokumentoinnin tuottaminen Sandvik Mining And Construction OY:lle. Tutkintotyö. Tampereen ammattikorkeakoulu. Viitattu 23.12.2012. https://publications.theseus.fi/browse?value=Sepp%C3%A4l%C3%A4%2C+Markus&type=author
  3. Oulun yliopisto, Rakenteinen julkaiseminen yliopistossa. Viitattu 23.11.2012. http://herkules.oulu.fi/isbn9514252438/isbn9514252438.pdf
  4. Seppälä, Markus. 2008. Rakenteisen dokumentoinnin tuottaminen Sandvik Mining And Construction OY:lle. Tutkintotyö. Tampereen ammattikorkeakoulu. Viitattu 23.12.2012. https://publications.theseus.fi/browse?value=Sepp%C3%A4l%C3%A4%2C+Markus&type=author
  5. Jyväskylän yliopisto, Rakenteisten dokumenttien käsittely. Viitattu 23.11.2012. http://www.cs.jyu.fi/gelpo/sgmlspl/luku4.html
  6. Håkon Wium Lie, Janne Saarela. "Multi-purpose publishing using HTML, XML and CSS". Viitattu 23.11.2012 http://www.w3.org/People/Janne/porject/paper.html
  7. Håkon Wium Lie, Janne Saarela. "Multi-purpose publishing using HTML, XML and CSS". Viitattu 23.11.2012. http://www.w3.org/People/Janne/porject/paper.html
  8. Håkon Wium Lie, Janne Saarela. "Multi-purpose publishing using HTML, XML and CSS". Viitattu 23.11.2012. http://www.w3.org/People/Janne/porject/paper.html
  9. http://www.isgmlug.org/ Viitattu 23.11.2012.
  10. http://www.isgmlug.org/ Viitattu 23.11.2012.
  11. http://www.w3.org/TR/REC-html32 Viitattu 23.11.2012.
  12. http://www.isgmlug.org/ Viitattu 23.11.2012.
  13. http://www.w3.org/TR/xhtml-media-types/#intro Viitattu 23.11.2012
  14. Day, Don. Priestly, Michael. Schell, David. 28.9.2005. "Introduction to the Darwin Information Typing Architecture". Viitattu 23.11.2012. http://www.ibm.com/developerworks/xml/library/x-dita1/
  15. Seppälä, Markus. 2008. Rakenteisen dokumentoinnin tuottaminen Sandvik Mining And Construction OY:lle. Tutkintotyö. Tampereen ammattikorkeakoulu. Viitattu 23.12.2012. https://publications.theseus.fi/browse?value=Sepp%C3%A4l%C3%A4%2C+Markus&type=author
  16. Jyväskylän yliopisto, Rakenteisten dokumenttien käsittely. Viitattu 23.11.2012. http://www.cs.jyu.fi/gelpo/sgmlspl/luku4.html
  17. Seppälä, Markus. 2008. Rakenteisen dokumentoinnin tuottaminen Sandvik Mining And Construction OY:lle. Tutkintotyö. Tampereen ammattikorkeakoulu. Viitattu 23.12.2012. https://publications.theseus.fi/browse?value=Sepp%C3%A4l%C3%A4%2C+Markus&type=author
  18. Technical Communication - international. Today and in the Future. tekom Schriften zur Technischen Kommunikation. Band 9, sivu 83. Julkaissut Jörg Hennig ja Marita Tjarks-Sobhani.
  19. Oulun yliopisto, Rakenteinen julkaiseminen yliopistossa. Viitattu 23.11.2012. http://herkules.oulu.fi/isbn9514252438/isbn9514252438.pdf
  20. Eduskunnan kirjaston julkaisusarja. Viitattu 23.11.2012. http://lib.eduskunta.fi/Resource.phx/kirjasto/organisaatio/julkaisut/julkaisusarja.htx
  21. Oulun yliopisto, Rakenteinen julkaiseminen yliopistossa. Viitattu 23.11.2012. http://herkules.oulu.fi/isbn9514252438/isbn9514252438.pdf
  22. Jyväskylän yliopisto, DigiPub. Viitattu 23.11.2012 http://www.cs.jyu.fi/gelpo/index.html