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

Anneli Heimburger

Research output: Book/ReportReportProfessional

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

NameVTT Tiedotteita - Meddelanden - Research Notes
PublisherVTT
No.1489
ISSN (Print)1235-0605
ISSN (Electronic)1455-0865

Keywords

  • technical documentation
  • CD-ROM
  • hypermedia

Cite this

Heimburger, A. (1993). Teknisen dokumentaation kehittäminen hypermedia- ja CD-ROM-tekniikan avulla. Espoo: VTT Technical Research Centre of Finland. VTT Tiedotteita - Meddelanden - Research Notes, No. 1489
Heimburger, Anneli. / Teknisen dokumentaation kehittäminen hypermedia- ja CD-ROM-tekniikan avulla. Espoo : VTT Technical Research Centre of Finland, 1993. 106 p. (VTT Tiedotteita - Meddelanden - Research Notes; No. 1489).
@book{5521691462f149e3b22616297c429222,
title = "Teknisen dokumentaation kehitt{\"a}minen hypermedia- ja CD-ROM-tekniikan avulla",
abstract = "Tekniset dokumentit kuvaavat tietyn teknisen kohteen rakennetta ja toimintaa. Kohde voi olla tekninen laite, j{\"a}rjestelm{\"a} tai laitos. Teknisill{\"a} dokumenteilla on useita eri k{\"a}ytt{\"a}j{\"a}ryhmi{\"a} ja erilaisia k{\"a}ytt{\"o}ymp{\"a}rist{\"o}j{\"a}. Jokaisella ryhm{\"a}ll{\"a} on omat tietotarpeensa ja n{\"a}k{\"o}kulmansa. Teknisten dokumenttien k{\"a}yt{\"o}n osa-alueita ovat mm. suunnitteluty{\"o}, testaus, asennus ja kokoaminen, k{\"a}ytt{\"o}{\"o}notto, huolto ja kunnossapito sek{\"a} koulutus. Tekniset dokumentit sis{\"a}lt{\"a}v{\"a}t p{\"a}{\"a}asiassa teksti{\"a}, taulukoita, graafisia esityksi{\"a} ja CAD-kuvia. Dokumentin perusrakenne on hierarkkinen. Teknisill{\"a} dokumenteilla on usein my{\"o}s rikas sis{\"a}inen viittausrakenne. Viittaukset voivat olla lukujen tai kappaleiden sis{\"a}isi{\"a} tai niiden v{\"a}lisi{\"a}. Viittauksia voi olla my{\"o}s ulkopuolisiin l{\"a}hteisiin, esimerkiksi standardeihin. Elektronisessa hypermediadokumentissa k{\"a}ytt{\"a}j{\"a} voi nopeasti siirty{\"a} hypertekstilinkkien avulla asiasta toiseen. Animaation ja videon liitt{\"a}minen dokumenttiin on teknisesti t{\"a}ysin mahdollista. My{\"o}s {\"a}{\"a}nt{\"a} voidaan tallentaa elektroniseen dokumenttiin. Sovelluksen k{\"a}ytt{\"a}jien tietotarpeet m{\"a}{\"a}r{\"a}{\"a}v{\"a}t sen, kuinka eri tietoelementtej{\"a} ja miss{\"a} m{\"a}{\"a}rin eri tietotyyppej{\"a} on j{\"a}rkev{\"a}{\"a} yhdistell{\"a} ja k{\"a}ytt{\"a}{\"a}. Teknisten dokumenttien jakeluv{\"a}lineen{\"a} ovat yleistym{\"a}ss{\"a} CD-levyt. Markkinoille on tullut nk. CD-WORM (Compact Disk Write Once Read Many) j{\"a}rjestelm{\"a}, jonka avulla voidaan valmistaa yksin kappalein standardin mukaisia CD-levyj{\"a}. Julkaisu on tarkoitettu organisaatioille, jotka suunnittelevat teknisten dokumenttien jakelua ja k{\"a}ytt{\"o}{\"a} elektronisessa muodossa, ja tahoille, jotka kehitt{\"a}v{\"a}t dokumenttien hallinta- ja hakuratkaisuja, sek{\"a} yleisemmin kaikille hypermedia- ja CD-tekniikan soveltamisesta kiinnostuneille. Ensin k{\"a}sitell{\"a}{\"a}n dokumentoinnin kehitt{\"a}mist{\"a} ja teknisen dokumentin ominaisuuksia. Sitten tarkastellaan elektronista dokumenttia sek{\"a} elektronisen tiedon esitys- ja tallennusmuotoja, kuten SGML-, HyTime- ja ODAstandardeja sek{\"a} erilaisia grafiikkaformaatteja. Julkaisussa kuvataan my{\"o}s CD-tekniikkaan liittyvi{\"a} standardeja sek{\"a} esitell{\"a}{\"a}n CD-WORM-teknologia. Julkaisuun on koottu my{\"o}s joitakin esimerkkej{\"a} SGML-standardin sek{\"a} hypermedia- ja CD-tekniikan soveltamisesta dokumenttien hallinnassa.",
keywords = "technical documentation, CD-ROM, hypermedia",
author = "Anneli Heimburger",
year = "1993",
language = "Finnish",
isbn = "951-38-4423-4",
series = "VTT Tiedotteita - Meddelanden - Research Notes",
publisher = "VTT Technical Research Centre of Finland",
number = "1489",
address = "Finland",

}

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

Teknisen dokumentaation kehittäminen hypermedia- ja CD-ROM-tekniikan avulla. / Heimburger, Anneli.

Espoo : VTT Technical Research Centre of Finland, 1993. 106 p. (VTT Tiedotteita - Meddelanden - Research Notes; No. 1489).

Research output: Book/ReportReportProfessional

TY - BOOK

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

AU - Heimburger, Anneli

PY - 1993

Y1 - 1993

N2 - 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.

AB - 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.

KW - technical documentation

KW - CD-ROM

KW - hypermedia

M3 - Report

SN - 951-38-4423-4

T3 - VTT Tiedotteita - Meddelanden - Research Notes

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

PB - VTT Technical Research Centre of Finland

CY - Espoo

ER -

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