Teknisen dokumentoinnin peruskäsitteet

Teknisen dokumentoinnin peruskäsitteet

Tekninen kirjoittaminen

Tekninen kirjoittaminen on teknisen viestinnän suurin osa-alue. Sen tuloksena syntyy eri ammattialojen käyttämää, muodoltaan hyvin rakenteellista ja tyyliltään asiakielistä teknistä kommunikaatiota eli dokumentaatiota. Teknisen dokumentaation muoto ja sisältö riippuvat dokumentoitavan kohteen ja dokumentaation kohdeyleisön tarpeista.

Teknistä dokumentaatiota tuottaa tekninen kirjoittaja.Teknistä kommunikaatiota hyödynnetään monilla eri aloilla, mm. tietokoneiden laitteistojen ja ohjelmistojen tuotannon, lääketieteen, kuluttajaelektroniikan, metsätalouden ja rahatalouden yhteydessä. Teknisen kirjoittamisen tuotoksina syntyy käyttöoppaiden ja asennusohjeiden lisäksi muun muassa teknisiä esitys- ja koulutusmateriaaleja, tiedotteita, raportteja, referenssejä ja artikkeleita.

Rakenteinen dokumentointi

Rakenteinen dokumentointi on modulaarista (katso ‘modulaarinen dokumentointi’). Rakenteisessa dokumentaatiossa tekstin rakenne ja muotoilu on erotettu toisistaan ja siinä jäsennetään informaatiota metakielen avulla. Jäsentelyyn sopivia metakieliä ovat varsinkin SGML-standardiin pohjautuvat merkintäkielet. Rakenteisen dokumentoinnin tarkoituksena on helpottaa dokumenttien julkaisua ja lisätä jo luodun materiaalin uudelleenkäyttömahdollisuuksia eri konteksteissa (katso ‘yksilähteistäminen’), ja se helpottaa varsinkin suurien tekstimäärien käsittelyä ja muotoilua.

Modulaarinen dokumentointi

Modulaarisessa dokumentoinnissa tieto jaetaan pieniin osiin, jotka ovat ymmärrettäviä kontekstista irrotettuina. Perusyksikkönä on moduuli, joka on lyhyt, itsenäinen informaationyksikkö, joka yleensä sisältää yhden asiakokonaisuuden eli käytännössä vastaa yhteen kysymykseen (esimerkiksi ‘mitä’, ‘miksi’ tai ‘miten’). Koska moduulit voidaan järjestää mihin järjestykseen tahansa, on modulaarinen dokumentointi siis epä-hierarkista ja epälineaarista.

Modulaarinen dokumentointi on rakenteista (katso ‘rakenteinen dokumentointi’) ja siinä noudatetaan valittua arkkitehtuuria, esim. XML-pohjaista DITA:a. Tämä arkkitehtuuri mahdollistaa rakenteisen tiedon käsittelyn julkaisu- ja esitysjärjestelmistä riippumatta ja perustuu merkintäkieleen, joka mahdollistaa tietoelementtien nimeämisen ja erittelemisen (ehdollistamisen) sisällön mukaan.

Yksilähteistäminen

Yksilähteistäminen eli single-sourcing mahdollistaa sisällön uudelleenkäytön monessa eri muodossa. Sisältö luodaan sellaiseen muotoon, että sitä voidaan käyttää ohjelmallisesti erilaisissa julkaisuissa ilman merkittävää uudelleenkirjoitusta. Yksilähteistämisen pohjana on modulaarinen dokumentointi ja rakenteinen kirjoittaminen (katso ‘modulaarinen dokumentointi’ ja ‘rakenteinen dokumentointi’). Kyseessä ei kuitenkaan ole teknologia vaan metodologia.

Yksilähteistäminen säästää aikaa ja kustannuksia vähentämällä päällekkäistä työtä, se parantaa dokumentaation käytettävyyttä vaikuttamalla dokumentaation standardointiin ja se helpottaa kääntämistä ja lokalisointia.

Monikanavajulkaisu

Monikanavajulkaisu (cross-media publishing) tarkoittaa saman viestin lähettämistä tai sisältöjen ja palveluiden tarjoamista eri välineillä eri kanavissa. Julkaistava sisältö ei välttämättä ole aivan identtistä eri kanavissa, vaan valintaa voidaan tehdä esimerkiksi kohderyhmän tai välineen luontevimman esitystavan mukaan.

Monikanavajulkaisussa tieto on usein tallennettu tietokantaan yleisesti luettavaan muotoon, mistä se jaellaan eri kanaviin, esimerkiksi sähköisenä tiedostona verkkosivuille tai painettuna esitteenä postitse lähetettynä. Sisällön tallentamisessa ei puututa lainkaan esittämistapaan tai ulkoasuun, vaan ulkoasu valitaan käytettävän kanavan ja sisällön perusteella. Sisällön tuottajat merkitsevät tärkeitä elementtejä kuten otsikoita ja kuvia, joiden perusteella sisältöä voidaan jakaa ja jäsentää eri välineille. Julkaistaviin dokumentteihin sisällytetään myös itse sisältöä kuvaavaa metatietoa, jonka avulla käyttäjille voidaan tarjota heitä kiinnostavaa tai tarkoitukseen sopivaa materiaalia.

Syvässä monikanavajulkaisuissa kanavat jakautuvat alikanaviin. Alikanava valitaan esimerkiksi tuotetun sisällön, käyttäjätietojen tai käytettävän päätelaitteen perusteella, esimerkiksi tiettyyn lukulaitteeseen tai puhelinmalliin sopivaksi.

Lähteitä:

Tilaa DoX-Blogi sähköpostiisi


Antamalla tietosi, hyväksyt, että Fenten voi olla sinuun yhteydessä sähköpostilla. Jos et jaksa odotella seuraava blogia, ota yhteyttä!
Rekisteriseloste

Satu Sevon-Nielsen
Satu.Sevon-Nielsen@dox.fi

Satu työskentelee DoX Systemsillä dokumentoinnin asiantuntijana.

-->