Teknisen dokumentaation kehittäminen hypermedia- ja CD-ROM-tekniikan avulla

Anneli Heimburger

Research output: Book/ReportReport

Abstract

Tekniset dokumentit kuvaavat tietyn teknisen kohteen rakennetta ja toimintaa. Kohde voi olla tekninen laite, järjestelmä tai laitos. Teknisillä dokumenteilla on useita eri käyttäjäryhmiä ja erilaisia käyttöympäristöjä. Jokaisella ryhmällä on omat tietotarpeensa ja näkökulmansa. Teknisten dokumenttien käytön osa-alueita ovat mm. suunnittelutyö, testaus, asennus ja kokoaminen, käyttöönotto, huolto ja kunnossapito sekä koulutus. Tekniset dokumentit sisältävät pääasiassa tekstiä, taulukoita, graafisia esityksiä ja CAD-kuvia. Dokumentin perusrakenne on hierarkkinen. Teknisillä dokumenteilla on usein myös rikas sisäinen viittausrakenne. Viittaukset voivat olla lukujen tai kappaleiden sisäisiä tai niiden välisiä. Viittauksia voi olla myös ulkopuolisiin lähteisiin, esimerkiksi standardeihin. Elektronisessa hypermediadokumentissa käyttäjä voi nopeasti siirtyä hypertekstilinkkien avulla asiasta toiseen. Animaation ja videon liittäminen dokumenttiin on teknisesti täysin mahdollista. Myös ääntä voidaan tallentaa elektroniseen dokumenttiin. Sovelluksen käyttäjien tietotarpeet määräävät sen, kuinka eri tietoelementtejä ja missä määrin eri tietotyyppejä on järkevää yhdistellä ja käyttää. Teknisten dokumenttien jakeluvälineenä ovat yleistymässä CD-levyt. Markkinoille on tullut nk. CD-WORM (Compact Disk Write Once Read Many) järjestelmä, jonka avulla voidaan valmistaa yksin kappalein standardin mukaisia CD-levyjä. Julkaisu on tarkoitettu organisaatioille, jotka suunnittelevat teknisten dokumenttien jakelua ja käyttöä elektronisessa muodossa, ja tahoille, jotka kehittävät dokumenttien hallinta- ja hakuratkaisuja, sekä yleisemmin kaikille hypermedia- ja CD-tekniikan soveltamisesta kiinnostuneille. Ensin käsitellään dokumentoinnin kehittämistä ja teknisen dokumentin ominaisuuksia. Sitten tarkastellaan elektronista dokumenttia sekä elektronisen tiedon esitys- ja tallennusmuotoja, kuten SGML-, HyTime- ja ODAstandardeja sekä erilaisia grafiikkaformaatteja. Julkaisussa kuvataan myös CD-tekniikkaan liittyviä standardeja sekä esitellään CD-WORM-teknologia. Julkaisuun on koottu myös joitakin esimerkkejä SGML-standardin sekä hypermedia- ja CD-tekniikan soveltamisesta dokumenttien hallinnassa.
Original languageFinnish
Place of PublicationEspoo
PublisherVTT Technical Research Centre of Finland
Number of pages106
ISBN (Print)951-38-4423-4
Publication statusPublished - 1993
MoE publication typeNot Eligible

Publication series

SeriesVTT Tiedotteita - Meddelanden - Research Notes
Number1489
ISSN1235-0605

Keywords

  • technical documentation
  • CD-ROM
  • hypermedia

Cite this

Heimburger, A. (1993). Teknisen dokumentaation kehittäminen hypermedia- ja CD-ROM-tekniikan avulla. VTT Technical Research Centre of Finland. VTT Tiedotteita - Meddelanden - Research Notes, No. 1489