Rakenteinen dokumentaatio ja DITA Mika Laihanen mika laihanengmail

  • Slides: 54
Download presentation
Rakenteinen dokumentaatio ja DITA

Rakenteinen dokumentaatio ja DITA

Mika Laihanen mika. laihanen@gmail. com @mika_himself https: //mikahimself. com/wp/techs 6/ Käännöstiede (Englanti) 1999 Teknisen

Mika Laihanen mika. laihanen@gmail. com @mika_himself https: //mikahimself. com/wp/techs 6/ Käännöstiede (Englanti) 1999 Teknisen viestinnän ohjelma 2003 -2004 Citec Information 2004 - 2011 Basware 2011 - Technical Writer Documentation Technology Designer Systems Support Engineer Lead Documentation & Localization Specialist § Lead Information Architect § §

Rakenteinen ja modulaarinen dokumentaatio Teoriaosuus: Harjoitukset: • Materiaali jaetaan sähköpostitse ennen luentoja • Harjoituksia

Rakenteinen ja modulaarinen dokumentaatio Teoriaosuus: Harjoitukset: • Materiaali jaetaan sähköpostitse ennen luentoja • Harjoituksia ryhmissä • Keskustelua ja kysymyksiä • Satunnaisesti kotitehtäviä • Materiaali jaetaan sähköpostitse ennen luentoja • Tunneilla harjoitustehtäviä Oxygen XML Editorilla – Rakenteinen teksti – DITA

Kurssin tavoitteet o Tutustuttaa rakenteisuuden ja modulaarisuuden periaatteisiin, taustalla olevaan teknologiaan ja työkäytäntöhin teknisen

Kurssin tavoitteet o Tutustuttaa rakenteisuuden ja modulaarisuuden periaatteisiin, taustalla olevaan teknologiaan ja työkäytäntöhin teknisen kirjoittajan näkökulmasta o Antaa valmiudet toimia teknisenä kirjoittajana yrityksissä, joissa käytetään rakenteista ja/tai modulaarista dokumentointimallia

Rakenteisuuden tasot

Rakenteisuuden tasot

Muotoilematon teksti o Plain text –dokumentit o Sisältävät vain tekstisisällön ja tarpeeksi metatietoa että

Muotoilematon teksti o Plain text –dokumentit o Sisältävät vain tekstisisällön ja tarpeeksi metatietoa että teksti pystytään esittämään tekstieditorilla o Ainoita muotoiluelementtejä ovat sarkaimet, välilyönnit ja rivinvaihdot o Käyttökohteina ohjelmistojen lähdekoodi, sähköposti, merkintäkielet (XML, XHTML, SGML)

Muotoiltu teksti o Asiakirjat, jotka sisältävät tekstisisällön ja välttämättömien metatietojen lisäksi muotoilutietoja: o Fontit,

Muotoiltu teksti o Asiakirjat, jotka sisältävät tekstisisällön ja välttämättömien metatietojen lisäksi muotoilutietoja: o Fontit, fonttikoot o Rivivälit o Sisennykset o Upotettu kuvitus

Muotoiltu teksti o Useimmilla tekstinkäsittelyohjelmilla oma tiedostomuotonsa o Tiedostomuodot ovat harvoin täysin yhteensopivia muiden

Muotoiltu teksti o Useimmilla tekstinkäsittelyohjelmilla oma tiedostomuotonsa o Tiedostomuodot ovat harvoin täysin yhteensopivia muiden ohjelmistojen tai aiempien ohjelmaversioiden kanssa o Open. Officen/Libre. Officen suosion myötä avoimet standardit saaneet tukea mm. MS Wordissa

<slide> <heading> <title>Rakenteinen teksti</title> </heading> <content> <bullet-list type="squares"> <bullet>Rakenteinen teksti perustuu merkintäkielten käyttöön </bullet>

<slide> <heading> <title>Rakenteinen teksti</title> </heading> <content> <bullet-list type="squares"> <bullet>Rakenteinen teksti perustuu merkintäkielten käyttöön </bullet> <bullet>Varsinaisen tekstisisällön lisäksi tiedosto sisältää tageilla merkittyjä <emph>elementtejä</emph>. Elementit määrittävät dokumentin rakenteen ja niillä merkitään erilaisia sisältöyksikköjä. </bullet> <bullet>Elementit voivat sisältää tekstiä tai toisia elementtejä, ja elementtien käsittelyä voidaan tarkentaa lisäämällä elementtiin <emph type="italic">attribuutteja</emph> </bullet-list> </content> </slide>

Rakenteinen teksti o Rakenteisessa tekstissä tekstin muotoilu on erotettu kokonaan sisällöstä o Jokaiselle elementille

Rakenteinen teksti o Rakenteisessa tekstissä tekstin muotoilu on erotettu kokonaan sisällöstä o Jokaiselle elementille voidaan rakenteista tekstiä julkaistessa määrittää sopiva muoto

Rakenteinen teksti o Rakenteista tekstiä on helppo lukea koneellisesti ja siksi se soveltuu monenlaisiin

Rakenteinen teksti o Rakenteista tekstiä on helppo lukea koneellisesti ja siksi se soveltuu monenlaisiin käyttökohteisiin: o Nettisivut, RSS-syötteet, ohjetekstit, ohjelmistojen käyttöliittymien rakenne, verkkolaskut o Jotta ihmisten olisi helppo lukea rakenteista tekstiä, teksti tulkitaan ja muunnetaan useimmiten koneellisesti johonkin muuhun muotoon, esim. PDF: ksi.

Muotoiltu teksti

Muotoiltu teksti

Ohjetekstit ja muotoiltu teksti o Ohjetekstit tuotetaan tavallisilla tekstinkäsittelyohjelmilla o Käyttöönotto helppoa ja edullista;

Ohjetekstit ja muotoiltu teksti o Ohjetekstit tuotetaan tavallisilla tekstinkäsittelyohjelmilla o Käyttöönotto helppoa ja edullista; toimistoohjelmistot asennettuna useimmissa yritystietokoneissa o Ohjelmistot ennalta tuttuja eikä peruskäyttö vaadi paljon koulutusta

Työtapoja Perusmalli: o Rajallinen määrä ohjetekstejä o Tekninen kirjoittaja vastaa ohjetekstien ulkoasusta o Ohjetekstit

Työtapoja Perusmalli: o Rajallinen määrä ohjetekstejä o Tekninen kirjoittaja vastaa ohjetekstien ulkoasusta o Ohjetekstit tallennetaan kirjoittajan kiintolevylle tai verkkolevylle Edistynyt malli: o Ulkoasu määräytyy varten varta vasten kehitettyjen tekstipohjien mukaan o Eri pohjat eri tyyppisiä ohjetekstejä varten o Tyyliopas, joka määrittelee ohjetekstien ulkoasuun liittyvät seikat o Ohjetekstit tallennetaan dokumenttienhallintajärjest elmään (Sharepoint, Documentum, M-Files)

Toimintatapojen ongelmakohtia Perusmalli: Edistynyt malli: o Kirjoittajat voivat muuttaa ulkoasua oman mielensä mukaan ->

Toimintatapojen ongelmakohtia Perusmalli: Edistynyt malli: o Kirjoittajat voivat muuttaa ulkoasua oman mielensä mukaan -> kirjava ulkoasuvalikoima o Ohjetekstiversioiden arkistointi monesti puutteellista o Ohjetekstiversioiden vertailu voi olla hankalaa o Ohjetekstien päivittäminen voi olla hankalaa, jos työtavat eivät ole yhtenäiset o Ohjetekstiversioiden vertailu voi olla hankalaa, jos työkaluissa/työtavoissa ei ole otettu versiointia huomioon

Muotoillun tekstin erityispiirteitä o Ohjeteksti on aina yksi, tiettyjä ohjelmistoja tukeva tiedosto o Ohjetekstiä

Muotoillun tekstin erityispiirteitä o Ohjeteksti on aina yksi, tiettyjä ohjelmistoja tukeva tiedosto o Ohjetekstiä täytyy käsitellä samalla, tai yhteensopivalla, ohjelmistolla kirjoitusvaiheesta julkaisuvaiheeseen o Ulkoasumuutokset täytyy tehdä yksitellen jokaiseen tiedostoon/ohjetekstiin o o Fonttimuutokset Taulukoiden ulkoasumuutokset Otsikkotasojen muutokset Kuvituksen päivittäminen (jos kuvat upotettu ohjeteksteihin)

Muotoillun tekstin erityispiirteitä o Ohjetekstien yhteiseen sisältöön tulevat muutokset täytyy useimmiten tehdä tiedosto kerrallaan

Muotoillun tekstin erityispiirteitä o Ohjetekstien yhteiseen sisältöön tulevat muutokset täytyy useimmiten tehdä tiedosto kerrallaan o Ohjetekstien julkaisu muussa kuin alkuperäisessä muodossa vaatii monesti sisällön käsittelemistä julkaisuohjelmilla o Word -> XHTML, Word -> PDF o Julkaistavan sisällön rajaaminen ja julkaiseminen vain tietyille asiakasryhmille hankalaa

Muotoiltu teksti kirjoittajan kannalta o Yksi ohjeteksti - yksi kirjoittaja o Kirjoittaja “omistaa” ohjetekstin

Muotoiltu teksti kirjoittajan kannalta o Yksi ohjeteksti - yksi kirjoittaja o Kirjoittaja “omistaa” ohjetekstin o Ohjetekstit käyttöopas-mallisia - sisältävät paljon erilaista tietoa (taustatietoa, ohjeita, vianetsintäohjeita jne. ) o Ohjetekstit julkaistaan useimmin vain paperimuodossa, joten kirjoittajalla ei ole mahdollisuutta tehdä suoria linkkejä toisiin ohjeteksteihin. Tekstuaaliset viittaukset mahdollisia.

Harjoitus: Muotoiltu teksti Ryhmäkeskustelu: o Miten tekninen kirjoittaja voi hyötyä muotoiltua tekstiä käyttävästä dokumentointimallista?

Harjoitus: Muotoiltu teksti Ryhmäkeskustelu: o Miten tekninen kirjoittaja voi hyötyä muotoiltua tekstiä käyttävästä dokumentointimallista? o Miten muotoiltua tekstiä käyttävä dokumentointimalli voi vaikeuttaa kirjoittajan elämää?

Rakenteinen teksti

Rakenteinen teksti

Rakenteinen teksti on kuvailevaa. Se kertoo millainen ohjetekstin rakenne ja sisältö on o Rakenteinen

Rakenteinen teksti on kuvailevaa. Se kertoo millainen ohjetekstin rakenne ja sisältö on o Rakenteinen teksti ei ota kantaa ohjetekstin muotoiluun tai käsittelyyn o Rakenteinen teksti noudattaa tiukasti kullekin tekstityypille määritettyjä rakennesääntöjä.

Rakennuspalaset: Alku- ja loppumerkit o Elementtejä merkitään rakenteisessa tekstissä alku- ja loppumerkkien – tagien

Rakennuspalaset: Alku- ja loppumerkit o Elementtejä merkitään rakenteisessa tekstissä alku- ja loppumerkkien – tagien - avulla o XML: ssä käytetään kolmea merkkityyppiä: o Alkumerkki <paragraph> o Loppumerkki </paragraph> o Singleton-merkki <line-break />

Rakennuspalaset: Alku- ja loppumerkit o o Merkkien nimissä saa käyttää useimpia unicode-merkkejä Nimien tulee

Rakennuspalaset: Alku- ja loppumerkit o o Merkkien nimissä saa käyttää useimpia unicode-merkkejä Nimien tulee alkaa kirjaimella, alaviivalla, tai : -merkillä Nimi ei saa alkaa XML-merkkijonolla, eikä sisältää välilyöntejä Isot kirjaimet ovat merkityksellisiä <dot. Net> <this_year>2014</this_year> <seven. Ups>4 btls</seven. Ups> <ääkköset>åäö</ääkköset> <Auto>Lada</Auto> <. net> <this year>2014</this year> <7 -ups>4 btls</7 -ups> <-kulut>12€</-kulut> <Auto>Volga</auto>

Rakennuspalaset: Elementit o Elementti muodostuu alkumerkistä, loppumerkistä ja niiden välissä olevasta sisällöstä o Elementti

Rakennuspalaset: Elementit o Elementti muodostuu alkumerkistä, loppumerkistä ja niiden välissä olevasta sisällöstä o Elementti voi sisältää tekstiä, muita elementtejä tai molempia o Elementti voi myös sisältää attribuutteja, jotka antavat lisätietoa elementistä ja sen sisällöstä <esimerkki> <otsikko>Esimerkkiteksti</otsikko> <kappale>Tämä on lyhyt teksti, joka sisältää <korostus tyyppi="bold"> elementtejä</korostus> ja <korostus tyyppi="kursiivi"> attribuutteja</korostus> </kappale> <kappale>Tekstin joukossa voi myös olla kuvia: <kuva tiedosto="malli. jpg"/> </kappale> </esimerkki>

Rakennuspalaset: Elementit o Elementin sisälle voi lisätä toisia elementtejä, mutta merkit, ja siten elementit,

Rakennuspalaset: Elementit o Elementin sisälle voi lisätä toisia elementtejä, mutta merkit, ja siten elementit, täytyy sulkea samassa järjestyksessä kuin ne on avattu. Ulompi elementti ei siis voi päättyä ennen sisempää. <date> <year>2013</year> <month>04</month> <day>12</day> </date> <year>2013</year> <month>4<day>12</month> </day> </date>

Rakennuspalaset: Attribuutit o Attribuutit antavat lisätietoa elementistä tai sen sisällöstä o Attribuuteilla voidaan vaikuttaa

Rakennuspalaset: Attribuutit o Attribuutit antavat lisätietoa elementistä tai sen sisällöstä o Attribuuteilla voidaan vaikuttaa elementin käsittelyyn materiaalia julkaistaessa o Yhdellä elementillä voi olla useita attribuutteja. Yhdellä attribuutilla voi olla useita arvoja. <puhelin merkki="Google"> <malli>Nexus</malli> <versio>6 P</versio> </puhelin> <merkki>Google</merkki> <malli versio="6 P">Nexus</malli> </puhelin> <lista tyyppi="numeroitu kursivoitu"> <kohta>Kohta 1</kohta> <kohta>Kohta 2</kohta> </lista>

Teknologinen tausta: SGML o Monet nykyisin käytettävät merkintäkielet perustuvat SGML: ään o SGML on

Teknologinen tausta: SGML o Monet nykyisin käytettävät merkintäkielet perustuvat SGML: ään o SGML on metakieli – sen avulla määritetään merkintäkieliä o Pääajatukset: o Kuvaileva merkintäkieli o Tiukat rakennesäännöt

Teknologinen tausta: SGML o SGML antaa käyttäjälle vapauden kehittää erilaisia merkintäkieliä. o Mm. XML

Teknologinen tausta: SGML o SGML antaa käyttäjälle vapauden kehittää erilaisia merkintäkieliä. o Mm. XML (e. Xtensible Markup Language) ja HTML (Hypertext Markup Language) perustuvat SGML: ään

SGML: Esimerkkirakenteita <!DOCTYPE maatila PUBLIC "//MIKA//Maatila DTD 1. 0//FI"> <maatila> <navetta> <elain> <suku>Kana</suku> <lukumaara>8</lukumaara>

SGML: Esimerkkirakenteita <!DOCTYPE maatila PUBLIC "//MIKA//Maatila DTD 1. 0//FI"> <maatila> <navetta> <elain> <suku>Kana</suku> <lukumaara>8</lukumaara> <rotu>Leghorn</rotu> </elain> </navetta> <kasvimaa> <kasvi> <suku>peruna</suku> <lukumaara>200</lukumaara> <lajike>Lemin punainen</lajike> </kasvimaa> </maatila> <!DOCTYPE html PUBLIC "-//W 3 C//DTD HTML 4. 0//EN"> <html> <head> <title>Otsikko</title> </head> <body> <p>Ensimmäinen tekstikappale. </p> <p>Toinen tekstikappale. </p> <ol type="a"> <li>Kohta a</li> <li>Kohta b</li> <li>Kohta c</li> </ol> </body> </html>

Teknologinen tausta: XML o World Wide Web Consortiumin (W 3 C) kehittämä merkintäkieli o

Teknologinen tausta: XML o World Wide Web Consortiumin (W 3 C) kehittämä merkintäkieli o Kehitetty tiedon rakenteen määrittämiseen sekä tiedon varastoimiseen ja välittämiseen sähköisesti o SGML: n tavoin metakieli - myös XML: n avulla voidaan määrittää uusia merkintäkieliä o XML ei sisällä valmiita elementtejä eikä rakenteita

Teknologinen tausta: XML o Yleinen tapa siirtää tietoa ohjelmistojen ja tietojärjestelmien välillä o Voidaan

Teknologinen tausta: XML o Yleinen tapa siirtää tietoa ohjelmistojen ja tietojärjestelmien välillä o Voidaan käyttää käyttöliittymien määrittelyssä o XML: stä on johdettu lukuisia merkintäkieliä o XML: stä on johdettu myös dokumentointikäyttöön useita merkintäkieliä: o DITA (Darwin Information Typing Architecture) o Doc. Book o S 1000 D

Teknologinen tausta: HTML § Hypertext Markup Language § SGML: n avulla määritelty merkintäkieli, eli

Teknologinen tausta: HTML § Hypertext Markup Language § SGML: n avulla määritelty merkintäkieli, eli SGML-sovellus § HTML: n avulla ei voida määrittää uusia merkintäkieliä § Kehitetty webbisivujen rakentamiseen ja kuvaamiseen – Osa elementeistä sisältää muotoiluohjeita § Yksi tunnetuimmista merkintäkielistä § http: //www. w 3 schools. com/html/default. asp

Harjoitus: Rakenteinen teksti o Pohdi mitä elementtejä viereinen teksti sisältää? o Voisivatko jotkin elementit

Harjoitus: Rakenteinen teksti o Pohdi mitä elementtejä viereinen teksti sisältää? o Voisivatko jotkin elementit sisältää myös attribuutteja? From: John Acronym <john. acronym@company. com> To: Arthur Pewtey <arthur@wedesign. net> Date: 16. 09 2014 Subject: Re: Proposal ----Dear Arthur, I found your latest proposal for our website refresh rather disappointing. Just a few examples: - You used none of the clipart illustrations we provided - You had changed the font from “Comic Sans” to “Helvetica” - You had removed the scrolling, flashing banner text For the next draft, we expect the following changes to be made: 1) Use the illustrations we sent. They are dead funny. 2) Change the font back to “Comic Sans”. 3) No more of this I am a designer, I know best nonsense. We want the scrolling texts back! They catch people’s attention! Best Regards, John Acronym, Senior Marketing Manager

<message> <header> <from><name>John Acronym</name><email>john. acronym@company. com</email></from> <to><name>Arthur Pewtey</name><email>arthur@wedesign. net</email></to> <date><day>14</day><month>11</month><year>2013</year></date> <subject>Re: Proposal</subject> </header> <content>

<message> <header> <from><name>John Acronym</name><email>john. acronym@company. com</email></from> <to><name>Arthur Pewtey</name><email>arthur@wedesign. net</email></to> <date><day>14</day><month>11</month><year>2013</year></date> <subject>Re: Proposal</subject> </header> <content> <para>Dear Arthur, </para> <para>I found your latest proposal for our website refresh rather disappointing. Just a few examples: <unordered. List> <item>You used none of the clipart illustrations we provided </item> <item>You had changed the font from “Comic Sans” to “Helvetica” </item> <item>You had removed the scrolling, flashing banner text </item> </unordered. List> </para> <para>For the next draft, we expect the following changes to be made: <ordered. List> <item>Use the illustrations we sent. They are <bold>dead funny</bold>. </item> <item>Change the font back to “Comic Sans”. </item> <item>No more of this <i>I am a designer, I know best </i> nonsense. We want the scrolling texts back! They catch people’s attention! </item> </ordered. List> </para> <para>Best Regards, </para> <para>John Acronym, Senior Marketing Manager </para> </content> </message>

Rakenteisen tekstin käyttöönotto

Rakenteisen tekstin käyttöönotto

Millaiseen käyttöön rakenteinen teksti soveltuu? o Yrityksille ja organisaatioille, jotka käsittelevät suuria dokumenttimääriä o

Millaiseen käyttöön rakenteinen teksti soveltuu? o Yrityksille ja organisaatioille, jotka käsittelevät suuria dokumenttimääriä o Yrityksille, jotka julkaisevat materiaalia monissa eri muodoissa (web, painetut ohjeet, PDF) o Yrityksille, joiden ohjeista täytyy voida hakea tietoa mahdollisimman tehokkaasti o Yrityksille, joilla on useita samankaltaisia tuotteita

Tarveanalyysi o Rakenteiseen tekstiin siirtyminen on työlästä ja kallista o Olemassa olevien tekstien muuntaminen

Tarveanalyysi o Rakenteiseen tekstiin siirtyminen on työlästä ja kallista o Olemassa olevien tekstien muuntaminen rakenteiseen muotoon o Kirjoittajien kouluttaminen o Työkalujen valinta, hankinta, ja ylläpito o Rinnakkaisten järjestelmien käyttö siirtymäaikana

Tarveanalyysi o Saavutetaanko rakenteisen tekstin avulla riittävästi kustannussäästöjä? o Nopeutuuko tai helpottuuko kirjoittajien työ?

Tarveanalyysi o Saavutetaanko rakenteisen tekstin avulla riittävästi kustannussäästöjä? o Nopeutuuko tai helpottuuko kirjoittajien työ? o Nopeutuuko dokumenttien julkaisu ja levittäminen?

Dokumenttianalyysi o Prosessi, jossa pyritään tunnistamaan millaisista rakenteista organisaation ohjetekstit koostuvat ja millaisia rakenteita

Dokumenttianalyysi o Prosessi, jossa pyritään tunnistamaan millaisista rakenteista organisaation ohjetekstit koostuvat ja millaisia rakenteita organisaatio tarvitsee pystyäkseen viestimään tehokkaasti ja onnistuneesti o Tehdään useimmiten työryhmissä ja useassa vaiheessa o Ostettavissa myös palveluna o Prosessin päämääränä on toimivan DTD: n laatiminen o Toimivan DTD: n avulla voidaan tuottaa organisaation tarvitsemaa dokumentaatiota niin, että tuotetut tekstit ovat yhteneväisiä ulkoasultaan ja rakenteiltaan

DTD o Document Type Definition o DTD on uuden merkintäkielen perusta o DTD: n

DTD o Document Type Definition o DTD on uuden merkintäkielen perusta o DTD: n avulla määritetään mm. : o o o Mitä elementtejä dokumentissa voi käyttää Missä kohtaa dokumentin rakennetta elementtejä voi käyttää Mitä elementtejä dokumentissa täytyy käyttää Mitä elementtejä elementit voivat sisältää Mitä attribuutteja elementit voivat sisältää o Ollakseen käytettävä DTD: n ei tulisi sisältää liikaa elementtejä o Elementtien määrää voi rajata esim. attribuuttien avulla

DTD Elementti Sallittu sisältö Document Title, Paragraph, List Title Teksti Paragraph Bold, Italic, Undelined,

DTD Elementti Sallittu sisältö Document Title, Paragraph, List Title Teksti Paragraph Bold, Italic, Undelined, teksti List. Item List, Paragraph, teksti Bold Teksti Italic Teksti Underlined Teksti

Harjoitus: DTD o Suunnittele yksinkertainen DTD, joka kuvaa edellisessä tehtävässä olleen sähköpostiviestin rakennetta. o

Harjoitus: DTD o Suunnittele yksinkertainen DTD, joka kuvaa edellisessä tehtävässä olleen sähköpostiviestin rakennetta. o Mitkä elementit ovat pakollisia, mitkä valinnaisia?

Elementti Sallittu sisältö message Head, content head From, to, date, subject from name, address

Elementti Sallittu sisältö message Head, content head From, to, date, subject from name, address to name, address date day, month, year subject teksti name teksti email teksti day numero month numero year numero content para, ordered. List, unordered. List para bold, i, teksti unordered. List Item item para, bold, i, teksti bold Teksti i teksti Lihavoidut elementit ovat pakollisia

Materiaalin muuntaminen rakenteiseksi o Parhaassa tapauksessa prosessi voidaan tehdä koneellisesti o Siirryttäessä muotoillusta rakenteiseen

Materiaalin muuntaminen rakenteiseksi o Parhaassa tapauksessa prosessi voidaan tehdä koneellisesti o Siirryttäessä muotoillusta rakenteiseen tekstiin, prosessi voi vaatia hyvin paljon tekstin manuaalista kopioimista o Joskus prosessia voi nopeuttaa siirtymällä formaatista toiseen jonkun väliformaatin kautta (MS Word -> RTF -> XML)

Ohjelmistojen valinta ja ympäristön perustaminen o Rakenteista tekstiä voidaan hallinoida monella tapaa: o o

Ohjelmistojen valinta ja ympäristön perustaminen o Rakenteista tekstiä voidaan hallinoida monella tapaa: o o Rakenteista tekstiä varten suunniteltu sisällönhallintajärjestelmä Ohjelmistokehitykseen suunnattu versionhallintajärjestelmä Verkkolevy Maksullinen palvelu vs. avoin järjestelmä o Julkaisujärjestelmä o Maksullinen järjestelmä vs. avoin järjestelmä o Kirjoitusympäristö o Tietokantaan kiinteästi liittyvä tai erillinen työkalu

Käyttäjien kouluttaminen o Rakenteisessa ympäristössä kirjoittaminen voi valituista työkaluista riippuen poiketa erittäin paljon muotoiltuun

Käyttäjien kouluttaminen o Rakenteisessa ympäristössä kirjoittaminen voi valituista työkaluista riippuen poiketa erittäin paljon muotoiltuun tekstiin perustuvasta ympäristöstä muutosvastarinta o Työkalukoulutuksen lisäksi tärkeää esittää uudesta ympäristöstä saatavat hyödyt o Kirjoitustyökalut kehittyneet huimasti käyttäjäystävällisempään suuntaan

Mitä samaa kuin muotoillun tekstin käytössä? o Rakenteinen ohjeteksti voi noudattaa perinteistä dokumentointimallia: o

Mitä samaa kuin muotoillun tekstin käytössä? o Rakenteinen ohjeteksti voi noudattaa perinteistä dokumentointimallia: o Yksi ohjeteksti– yksi tiedosto o Yksi ohjeteksti– yksi kirjoittaja o Kirjoitusprosessi voi olla varsin samankaltainen: o Materiaalin hankinta > Tekstien laatiminen > Tekstien katselmointi > Katselmointikorjaukset > Hyväksyminen > Julkaisu

Miten eroaa muotoillun tekstin käytöstä? o Ohjeteksteihin on helpompi lisätä tiedoston ulkopuolista materiaalia ja

Miten eroaa muotoillun tekstin käytöstä? o Ohjeteksteihin on helpompi lisätä tiedoston ulkopuolista materiaalia ja sisällön rajaaminen on helpompaa o Ohjetekstejä on helpompi käsitellä koneellisesti o Julkaisu eri muodoissa suoraviivaisempaa o Suurtenkin ulkoasumuutosten tekeminen nopeaa o Kirjoitettaessa modulaarisia ohjetekstejä yhdellä ohjetekstillä on tyypillisesti monta kirjoittajaa o Ohjetekstejä ei välttämättä katselmoida kokonaisuuksina

Miten eroaa muotoillun tekstin käytöstä? o Hypertekstimuotoisten ohjetekstien välille on helppo tehdä linkkejä o

Miten eroaa muotoillun tekstin käytöstä? o Hypertekstimuotoisten ohjetekstien välille on helppo tehdä linkkejä o Käyttäjän ei tarvitse lukea ohjetekstejä lineaarisesti o Käyttäjä löytää tarvitsemansa tiedon nopeammin o Dokumenttityypit saattavat muuttua kaikkiyhdessä-paketissa –mallista erikoistuneimmiksi ohjeteksteiksi

Rakenteinen teksti kirjoittajan kannalta o Rakenteiseen tekstiin siirtyminen voi olla työlästä, jos kirjoittajat ovat

Rakenteinen teksti kirjoittajan kannalta o Rakenteiseen tekstiin siirtyminen voi olla työlästä, jos kirjoittajat ovat tottuneet perinteiseen kirjoitusmalliin: o o Uudet kirjoitustyökalut Uusia tapoja tehdä virheitä Uudet työskentelytavat Joitakin ”virheitä” ei pysty korjaamaan itse o Sisällönhallintajärjestelmät o Versionhallinta, rinnakkaiset julkaisut ja dokumenttiversiot o Tiedonhaku yleensä helpompaa

Rakenteinen teksti: Edut o Tekstin koneellinen käsittely ja tietokantahaut helpottuvat o Useiden julkaisuformaattien käyttö

Rakenteinen teksti: Edut o Tekstin koneellinen käsittely ja tietokantahaut helpottuvat o Useiden julkaisuformaattien käyttö helpottuu ja julkaisujen laatiminen nopeutuu o Kirjoittajat voivat keskittyä sisältöön o Kun järjestelmä määrittää ulkoasun ja rakenteen, dokumenttien ulkoasu pysyy standardinmukaisena o Sisällöntuottaminen ei ole riippuvainen mistään tietystä käyttöjärjestelmäversiosta tai ohjelmistosta

Rakenteinen teksti: Haasteet o Rakenteiseen tekstiin siirtyminen on kallis ja aikaavievä prosessi o Järjestelmän

Rakenteinen teksti: Haasteet o Rakenteiseen tekstiin siirtyminen on kallis ja aikaavievä prosessi o Järjestelmän perustaminen ja ylläpito on vaativaa, sekä vaatii merkittävän taloudellisen panostuksen, jos työ ostetaan organisaation ulkopuolelta o Rakenteiseen kirjoitusympäristöön siirtyminen voi vaatia paljon koulutusta

Yhteenveto Rakenteinen teksti kuvailee tekstin sisältöä ja rakennetta Rakenne-elementtejä merkitään alku- ja loppumerkkien avulla

Yhteenveto Rakenteinen teksti kuvailee tekstin sisältöä ja rakennetta Rakenne-elementtejä merkitään alku- ja loppumerkkien avulla DTD on rakenteisen dokumentin kielioppi Rakenteisuus helpottaa tekstin koneellista käsittelyä → kustannussäästöt o Rakenteisuus mahdollistaa useiden julkaisuformaattien käytön o Siirtyminen WYSIWYG-dokumentaatiosta rakenteiseen voi olla hyvin kallista ja aikaavievää o o

Harjoitus o Tarkastele seuraavaa ohjesivua: https: //mikahimself. com/wp/wpcontent/uploads/2014/09/lecture-1 -homework. png Pohdi mitä elementtejä sivun

Harjoitus o Tarkastele seuraavaa ohjesivua: https: //mikahimself. com/wp/wpcontent/uploads/2014/09/lecture-1 -homework. png Pohdi mitä elementtejä sivun sisällön esittämiseen tarvitaan? Mieti, mitä osia sivun sisällöstä voitaisiin tuottaa ainakin osittain koneellisesti tai automaattisesti o Laadi lista tarvittavista elementeistä o Palautus: mika. laihanen@gmail. com [otsikkoon teksti TECHS 6 – Harjoitus 1]