Yksilähteistäminen

Wikipedia
Loikkaa: valikkoon, hakuun

Yksilähteistäminen (single sourcing) on teknisen dokumentoinnin menetelmä, joka mahdollistaa sisällön tehokkaan käytön monessa eri muodossa. Sisältö luodaan modulaarisena dokumenttina tai muuten sellaisessa muodossa, että se voidaan ohjelmallisesti julkaista eri formaateissa ilman merkittävää uudelleenkirjoitusta.[1] Yhdestä lähteestä voidaan koota esimerkiksi painettu paperiohjekirja, käytönaikainen ohje, koulutusmateriaali tai verkkosivu.

Yksilähteistäminen säästää aikaa ja rahaa vähentämällä päällekkäistä työtä. Se lisää dokumentaation käytettävyyttä ohjaamalla yrityksen dokumentoinnin standardointia ja helpottaa tekstien kääntämistä ja lokalisointia.

Sisällön luominen[muokkaa | muokkaa wikitekstiä]

Yksilähteistämisprosessin pohjana ovat modulaarinen dokumentointi ja rakenteinen kirjoittaminen. Yksilähteistämisprojekti aloitetaan kuten mikä tahansa teknisen dokumentoinnin projekti: määritellään kohderyhmä, tarvittava informaatio ja projektiin sopivimmat dokumenttityypit. Varsinainen kirjoitustyö eroaa kuitenkin perinteisestä dokumentoinnista merkittävästi. Perinteisessä dokumentoinnissa jokainen dokumentti kirjoitetaan erikseen, kun taas yksilähteistämisessä kirjoitetaan modulaarinen sisältö kerran ja siitä kootaan ohjelmallisesti erilaisia dokumentteja eri julkaisuformaatteihin. [2]

Yksilähteistäminen voidaan toteuttaa monilla erityisesti siihen kehitetyillä ohjelmistotyökaluilla. Ohjelmistoista on kuitenkin hyötyä vain, jos sisältö on luotu modulaarisesti. Yksilähteistäminen on siis metodologia, ei teknologia. [3]

Modulaarinen dokumentointi[muokkaa | muokkaa wikitekstiä]

Yksilähteistäminen perustuu modulaariseen dokumentointiin. Modulaarisen dokumentoinnin perusperiaate on jakaa informaatio pieniin osiin, jotka ovat ymmärrettäviä sinällään kontekstista irrotettuina.

Modulaarisen dokumentoinnin perusyksikkö on moduuli, lyhyt itsenäinen informaatioyksikkö, joka vastaa yleensä yhteen seuraavista kysymyksistä: [4]

  • kuka?
  • mikä?
  • milloin?
  • missä?
  • miksi?
  • miten?

Moduulien kirjoittamisessa noudatetaan valittua arkkitehtuuria, esimerkiksi tekniseen dokumentointiin, hallinnoimiseen ja julkaisemiseen tarkoitettua XML-pohjaista DITA:a.</a>.

Arkkitehtuuri mahdollistaa rakenteisen informaation käsittelyn riippumatta julkaisu- ja esitysjärjestelmistä. Rakenteinen kirjoittaminen perustuu XML- tai SGML-pohjaiseen merkintäkieleen, joka mahdollistaa informaatioelementtien nimeämisen ja erittelyn sisällön mukaisesti.[5]

Rakenteinen kirjoittaminen on tehokkainta silloin, kun sen ohjaamiseksi käytetään strukturoituja sääntöjä. Säännöt kuvataan DTD:ssä. DTD määrittelee rakenteisen tekstin moduulien elementtien ja attribuuttien sallitut ilmenemismuodot. [6] Dokumentin rakenne voidaan määritellä XML-skeemalla. </a>

Erilaisia moduulityyppejä voi olla käytössä useita riippuen valitusta informaatiomallista, DTD:stä ja sisältösuunnitelmasta. Tyypillisimmin kuvaileva tieto, ohjeistava sisältö ja referenssitiedot ovat omassa moduulityypissään. Myös muita tyyppejä voi olla käytössä.

Modulaarinen teksti on ei-hierarkkista ja epälineaarista. Moduulit voi järjestää mihin tahansa järjestykseen ja niistä voi muodostaa erilaisia loogisia kokonaisuuksia. [7]

Moduulien luominen[muokkaa | muokkaa wikitekstiä]

Modulaarinen dokumentaatio voidaan luoda joko tyhjästä tai perinteisen lineaarisen dokumentin pohjalta. Mikäli muokataan olemassaolevaa informaatiota, ensimmäiseksi jaetaan teksti moduuleihin. [8]

Tavallisesti dokumenteista voidaan tunnistaa esimerkiksi seuraavia moduuleita:

  • vaiheittaisia ohjeita
  • kuvailevia tekstejä
  • referenssitietoja
  • vianmääritysosioita
  • sanastoja
  • määritelmiä
  • esimerkkejä
  • kuvia
  • huomautuksia
  • taulukoita

Kuvat, huomautukset ja muut moduulit, jotka eivät ole ymmärrettäviä yksinään, ovat toissijaisia moduuleita ja ne linkitetään ensisijaisiin moduuleihin. Moduulityypit määritellään projektin informaatiomallissa yksityiskohtaisesti. [9]

Informaatiomalli on viitekehys, jonka avulla informaatio voidaan ryhmitellä. Tämä työkalu auttaa kirjoittajia ja käyttäjiä löytämään tarvitsemansa tiedon riippumatta lähtökohdista ja käyttötarpeista. [10]

Moduulien nimeäminen ja organisointi[muokkaa | muokkaa wikitekstiä]

Valmiit moduulit nimetään ja otsikoidaan yksilöllisesti niin, että ne voidaan tunnistaa ja ymmärtää missä tahansa kontekstissa ja millaisessa tahansa sisällysluettelossa. Loogisina tunnisteina voidaan käyttää esimerkiksi DITA-moduulien id-tunnisteita tai muita dokumentin metadata-tunnisteita.

Kun moduulit on luotu, ne järjestetään loogiseen järjestykseen master-dokumentiksi. Toissijaiset moduulit integroidaan linkittämällä ne ensisijaisiin moduuleihinsa, ja ensisijaiset moduulit ryhmitellään aihepiireittäin. [11]

Moduuleja voidaan ehdollistaa julkaisua varten. Moduulin metatietoihin voidaan määritellä tietty julkaisumuoto tai kohdeyleisö, jolloin lopullista dokumenttia luotaessa tietty moduuli joko otetaan automaattisesti mukaan tai jätetään pois.

Dokumenttien kokoaminen[muokkaa | muokkaa wikitekstiä]

Kun sisältömoduulit on luotu, niistä koostetaan erilaisia dokumentteja erilaisiin käyttötarkoituksiin. Modulaarinen sisältö voidaan julkaista useassa eri muodossa, esimerkiksi:

  • painettuina käyttöohjeina
  • käytönaikaisina ohjeina (online help)
  • koulutusmateriaalina
  • verkkosivuina

Kuhunkin julkaisuun valitaan moduulit julkaisuformaatin ja kohdeyleisön mukaan. Julkaisuformaatilla ei tarkoiteta tiettyä tiedostomuotoa, vaan erilaisia käyttötarkoituksia. Esimerkiksi käyttöohje voi olla painettuna tai PDF-tiedostona täysin samansisältöinen, mutta käytönaikainen ohje voi poiketa näistä merkittävästi. Käytönaikaisessa ohjeessa ei esimerkiksi tavallisesti ole johdantoa.

Valitut moduulit järjestetään loogisiin osioihin, jotka riippuvat kyseisestä dokumentista. Esimerkiksi painettavaan dokumenttiin voidaan luoda lukuja ja alalukuja aihepiireittäin. Osioille luodaan yksinkertainen ja looginen hierarkia, joka auttaa lukijaa navigoimaan.

Moduulien linkittäminen[muokkaa | muokkaa wikitekstiä]

Modulaarisen sisällön linkitys auttaa lukijaa löytämään tiedon mahdollisimman nopeasti. Tavallisesti lukijat silmäilevät teknistä tekstiä sen sijaan, että lukisivat alusta loppuun.

Jotta navigointi onnistuisi helposti, käytetään runsasta tekstin sisäistä linkitystä, sisällysluetteloita, asiasanahakemistoja ja muita viittaussuhteita. [12]

Riippumatta julkaisumuodosta kaikissa dokumenteissa on sisällysluettelo, joka esittää dokumentin rakenteen listaamalla kaikki ensisijaiset moduulit.

Aakkosellisten hakemistojen avulla käyttäjä voi hakea tietoa nopeasti. Sähköisissä dokumenteissa hakemistoista voidaan hakusanoja linkittää suoraan kyseiseen moduuliin. Lisäksi käytetään kontekstisensitiivisiä opasteita, eli opastetekstejä, jotka tarjoavat parhaillaan tehtävään toimintoon liittyvää informaatiota. Painetuissa dokumenteissa käytetään muita viittauskeinoja, kuten sivu- tai kappalenumerointia.

Dokumenttien luominen[muokkaa | muokkaa wikitekstiä]

Lopullinen julkaistava dokumentti luodaan ohjelmallisesti. Käytettävä ohjelmisto ja informaatioarkkitehtuuri määrittelevät dokumentin lopullisen ulkoasun.

Ohjelma järjestää valitut moduulit automaattisesti ennalta määrättyjen periaatteiden mukaan muuttamatta sisältöä. Useimmista ohjelmista voidaan julkaista useita eri dokumentti- ja tiedostomuotoja.

Kritiikki[muokkaa | muokkaa wikitekstiä]

Siirtyminen yksilähteistämiseen ja uuden sisällönhallintajärjestelmän käyttöönotto vaativat usein merkittävän taloudellisen panostuksen ja sen käyttöönotto voi kestää pitkään. Siksi sitä käyttävät pääasiassa monikansalliset suuryritykset, kuten IBM.

Kriitikoiden mukaan yksilähteistäminen toimii vain tietyissä ääritapauksissa ja on liian kallis ottaa käyttöön. Moduulien uudelleenkäyttö onnistuu harvoin ilman muokkausta, kirjoittajat harvoin todellisuudessa käyttävät toisten luomia tekstejä, tekstiä pitää yksinkertaistaa liikaa lokalisointia ajatellen ja teksti vanhenee liian nopeasti jotta sitä voitaisiin uudelleenkäyttää tehokkaasti. Lisäksi erilaisiin muotoihin julkaiseminen onnistuu nykyohjelmistoilla muutenkin. [13]

Lähteet[muokkaa | muokkaa wikitekstiä]

  1. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s.1-3
  2. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 23
  3. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 1
  4. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 12
  5. Hackos, JoAnn T: Content Management for Dynamic Web Delivery. New York: John Wiley & Sons, Inc., 2002. s. 68
  6. Hackos, JoAnn T: Content Management for Dynamic Web Delivery. New York: John Wiley & Sons, Inc., 2002. 68-69
  7. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 6
  8. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 26
  9. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 30
  10. Hackos, JoAnn T: Content Management for Dynamic Web Delivery. New York: John Wiley & Sons, Inc., 2002. s. 124
  11. Hackos, JoAnn T: Content Management for Dynamic Web Delivery. New York: John Wiley & Sons, Inc., 2002. s. 93-94
  12. Ament, Kurt: Single Sourcing: Building Modular Documentation. New York: William Andrew Publishing, 2003. s. 54
  13. Hiatt, Michael: The Myth of Single-Source Authoring. http://mashstream.com/mashups/the-myth-of-single-source-authoring/ Viitattu 26.11.2012.