DoX Systems

rakenteinen dokumentointi

Ajankohtaista

Fontit, aakkostot ja niiden muunnelmat

Fontit ovat tyylien yksityiskohta, joihin liittyvät tarpeet voivat yllättää monet kirjoittajista. Suurin osa meistä ei ole graafisia suunnittelijoita, eli oletusvalinnat yleensä riittävät tarpeisiimme. Aina näin ei kuitenkaan ole. Käyn täällä läpi erinäisiä huomioita dokumenttien käyttämien fonttien … Read More

Ajankohtaista

Tyhjien linkkien paikantamisen keino

Yksi riskeistä rakenteisien järjestelmien käyttämisessä on, että joskus julkaisujen sisäisten linkkien kohteet eivät ole mukana samoissa julkaisuissa kuin kyseiset linkit. Tältä tilanteelta vältytään ehdollistamalla kyseiset linkit vastaavalla tavoin kuin niiden kohteet ja varmistamalla, että linkkien kohteet … Read More

Ajankohtaista

Valittujen työkalujen vaikutus kirjoittajiin

Tämä on puolifilosofinen pohdinta koskien työkalujen roolia osana työn tekijöiden suhdetta työhönsä, sen tuloksiin ja itseensä sen tekijöinä. Koska toimitamme kirjoittamisen työkaluja kuten rakenteisen kirjoittamisen järjestelmää DoX CMS, on esitettämäni näkökulma tämän eturistiriidan värittämä. Ensisijaisesti tämä … Read More

Ajankohtaista

CSS-muuttujat ja laskelmat dokumentaation tukena

Aiempi DocRaptor-julkaisuputken päivitys DoX CMS:ssä mahdollisti CSS-muuttujien ja laskelmien käyttämisen myös sitä kautta kasatuissa PDF-julkaisuissa. Muut näiden tyylitiedostojen toimintojen kanssa yhteensopivat julkaisumuodot ovat oletuskasaajalla tehdyt PDF:t, ja verkkojulkaisut eli HTML ja WebHelp. Tämän päivityksen vuoksi on … Read More

Ajankohtaista

Attribuuttien käyttäminen tyylitiedostoissa

Tyylitiedostojen valitsijat voi kytkeä mihin tahansa sisällön tunnisteisiin. Useimmiten tähän käytetään ID-arvoja tai luokkia kuten .dita-title. Myös muut attribuuttiarvot kuitenkin soveltuvat tähän. Koska DoX CMS:n elementtiluokat ja tagit on toteutettu elementtien attribuutteina, niitä koskevat ohjeet ovat … Read More

Ajankohtaista

Yleisluontoisten toimintojen soveltamisen edut

Muistan venäläisen luennoitsijan vitsin yliopiston kansainvälisen kommunikaation kurssilta: ’Suomessa kaikki toimii, mutta mitään ei saa tehtyä. Venäjällä mikään ei toimi, mutta mikä vain on tehtävissä.’ Tällainen tasapainottelu valmiuden ja sovellettavuuden välillä pätee myös muissa asiayhteyksissä, ja … Read More

Ajankohtaista

Sisäinen dokumentaatio DoX:issa ja DoX:ista

Aiemmin kävin läpi keinoja selvittää, kuinka edeltäjäsi käyttivät DoX CMS:ää, jos he eivät jättäneet jälkeensä sisäistä dokumentaatiota aiheesta. Kuten korostin kyseisessä artikkelissa, sisäinen dokumentaatio koskien oikeita käyttötapoja on erittäin tärkeää. Tämä pitää paikkansa kaikkien rakenteisten dokumentointijärjestelmien … Read More

Ajankohtaista

Vierailuluentoja Vaasassa ja Tampereella

DoX Systemsin yhteistyö teknisen viestintää Suomessa opettavien tahojen kanssa jatkuu. Kirjoitin aiemmin yhteistyön aloittamisesta Vaasan yliopiston kanssa. Tänä syksynä vastaavaa yhteistyötä on laajennettu myös Tampereen yliopiston teknisen kommunikaation maisteriohjelmaan. Vaasan yliopisto Kerroin Vaasan yliopistolla kokemuksistani teknisenä … Read More

Ajankohtaista

DoX CMS:n Oletustyönkierto

Rakenteinen kirjoittaminen ja sitä tukevat järjestelmät muodostavat monivaiheisen prosessin. Vaikka tämän prosessin yksityiskohdat voivat poiketa eri toimijoiden tarpeiden mukaisesti, järjestelmiin on rakennettu oletustyönkierto. Tämä oletustyönkierto on runko, jonka varaan muutokset prosessissa tehdään ja joka rajoittaa mahdollisia … Read More