Word-jumituksessa piilee valtava kehityspotentiaali

Word-jumituksessa piilee valtava kehityspotentiaali

MS Word vaikuttaa edelleen olevan suosituin dokumentointijärjestelmä ainakin suomalaisessa konepajateollisuudessa. Jännä juttu. Niin tupaten täynnä kuin insinöörejä konepajat ovat, niin dokumentoinnin parissa uusia mahdollisuuksia dokumentoinnissa hyödynnetään hirvittävän vähän. Samaan aikaan kun monella muulla toiminnan osa-alueella ratsastetaan aallon harjalla uuden teknologian kanssa, niin dokumentointi jyystää melkein kivikaudella. Kehittämispotentiaali, esim. rakenteisen dokumentaation avulla on valtava.

Osasyy lienee, että rakenteisen dokumentaation hyödyntäminen vaatii perinteisen käsityksen mukaan paljon resursseja, rahaa ja asiantuntemusta. Siksi sitä onkin pidetty lähinnä suuryritysten juttuna. Käsitys on monelta osin vanhentunut ja dokumentoinnin parissa työskenteleviä henkilöitä saattaa helpottaa tieto, että nykyisin rakenteisen dokumentaation hyödyntäminen ei edellytä teknisten termien tai syvällisemmin rakenteisen dokumentaation periaatteiden osaamista. Riittää kun valitsee oikeat työkalut oman tarpeeseen ja antaa työkalujen huolehtia rakenteisen dokumentaation periaatteiden noudattamisesta. Itse voit keskittyä hyödyistä nauttimiseen.

Rakenteisen dokumentaation perusperiaate on, että teksti jaetaan pieniin kokonaisuuksiin, joita kutsutaan elementeiksi tai moduuleiksi. Itse olen tykästynyt savolaisittain käsitteeseen pieni tekstin pätkä. Eli rakenteisessa dokumentaatiossa iso tekstimassa jaetaan pieniin tekstin pätkiin. Näitä tekstinpätkiä voidaan merkata erilaisilla tunnistetiedoilla ja tunnistetietojen perusteella valmiit julkaisut koostetaan pienistä tekstin pätkistä – mahdollisuuksien mukaan enemmän tai vähemmän automaattisesti

Kuva 1. Rakenteisen dokumentaation periaate

Keskeiset rakenteiden dokumentaation käyttämisestä tulevat hyödyt ovat:

  • Materiaalin uudelleen käyttö, mikä helpottaa päivityksiä ja säästää työtä
  • Monipuoliset julkaisumahdollisuudet, kun sama materiaali voidaan julkaista eri alustoilla ja eri tyyleillä
  • Käännöstyön väheneminen, kun koko julkaisun sijaan voidaan kääntää vain yksittäisiä moduuleja
  • Järjestelmien välisen materiaalin siirron helpottuminen, kun rakenteisen dokumentaation merkintäkieli ei ole järjestelmäsidonnaista.

 

Tehtiin näistä rakenteiden dokumentoinnin hyödyistä oikein videokin: Ihan lyhyt johdanto rakenteiseen dokumentointiin. Pääset katsomaan videon tästä linkistä.

Fentenillä me autamme dokumentoinnin porukkaa vapautumaan Word-jumituksesta kohti valtavaa kehityspotentiaalia ja fiksumpaa tekemistä. Jos kiinnostaa kuulla aiheesta lisää, niin alkuun voit vaikka katsoa tuon tekemäni videon ja sen jälkeen voit soitella tai laittaa sähköpostia minulle, niin kerron lisää. Yhteystiedot postauksen lopussa.

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

Paavo Korhonen
paavo.korhonen@fenten.fi

Paavo työskentelee Fentenillä asiantuntijana DoX-järjestelmien parissa.

-->