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.
Index IT on kehittänyt sisällönhallintajärjestelmä Indoxin, josta voit lukea lisää täältä. Otetaan esimerkiksi koneen X käyttöohjeiden luominen rakenteisessa muodossa Indoxissa. Mikäli yrityksellä on jo sisältöä tuotettuna esimerkiksi Word-ohjelmistolla, lue täältä miten voit konveroitda Word-tiedoston Indoxiin Word2DITA-työkalulla.
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 koneen X käyttöohje on rakenteisessa muodossa! Saavutetut hyödyt pähkinänkuoressa:
- Mikäli yritys alkaa valmistamaan konetta Y, voidaan sisältö käyttää helposti uudelleen, esim. takuuehdot voidaan liittää kahvinkeittimen Y ditamappiin. 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.