Siirry suoraan sisältöön

Miten teen huolto- ja käyttöohjeet Indoxilla?

Useissa yrityksissä on teknisen kirjoittamisen ammattilaisia teknisiä kirjoittajia huolehtimassa dokumentaatiosta. Vastuu dokumentaatiosta voi olla myös hajautettu eri asiantuntijoille. Rakenteinen dokumentointi, tekninen dokumentaatio, tekninen dokumentointi kaikille näille on yhteistä se, että kirjoittamista varten tarvitaan hyvät työkalut.

Huolto- tai käyttöohjeet voidaan tehdä esimerkiksi Microsoft Wordilla, mutta sisällönhallinta muodostuu hankalaksi jo tavanomaisten vaatimusten edessä. Sisältö kannattaa muuttaa rakenteiseksi, mikäli jo kaksi neljästä vaatimuksesta täyttyy:

  1. Dokumentista tarvitaan eri kieliversiota
  2. Sama sisältö toistuu useasti, esim. takuuehdot
  3. Tarvitaan useita julkaisumuotoja (Word, PDF tai HTML)
  4. Palvelussa tai tuotteessa on variaatioita, esim. kahvinkeittimen saa maidonvaahdottimella tai ilman.

Otetaan esimerkiksi kahvinkeittimen Y käyttöohjeiden luominen rakenteisessa muodossa.

1. Ohjekirjan tekeminen aloitetaan luomalla tarvittavat osakokonaisuudet, eli topicit esim. johdanto, koneen käyttö, koneen puhdistus ja takuuehdot.

2. Liitetään em. topicit samaan mappiin, joka kokoaa julkaisuun haluttavat osiot ja niiden sisällön, kuten tekstit, taulukot, kuvat ja listat.

3. Julkaistaan halutussa muodossa, esim. PDF, word tai html.


Nyt kahvinkeittimen Y käyttöohje on rakenteisen dokumentin muodossa! Saavutetut hyödyt pähkinänkuoressa:

  • Mikäli yritys alkaa valmistamaan kahvinkeitintä X, voidaan sisältö käyttää helposti uudelleen, esim. takuuehdot voidaan liittää kahvinkeittimen X mappiin. Jos takuuehdot muuttuvat, ne muuttuvat molemmissa ohjeissa kerralla.
  • Ohjeissa voidaan käyttää samoja kuvia ja muutettavat kuvat muuttuvat kaikissa ohjeissa kerralla. Kuva kertoo lisäksi missä kaikissa paikoissa sitä on käytetty.
  • Ohjeiden muutoksia voidaan kontrolloida erilaisilla työnkuluilla, kuten hyväksymistyönkululla.
  • Yritys haluaa tarjota ohjeet verkossa myös html-muodossa, nyt samaa aineistoa voidaan käyttää helposti esim. Oxygen Webhelpissä.
  • Yritys laajentuu Japanin markkinoille, uuden kieliversion lisääminen on helppoa.
  • Julkaisun ulkoasua voidaan muokata esim. lisätä PDF:n yläosaan yrityksen logo.