Transcript Effektiv dokumentation med XML och DITA

Effektiv dokumentation med
XML och DITA
Om XML och DITA-system i korthet
Svarv 3 GK-195
XML
OBS!
Innan du startar svarven
Testa svarven först
Det får endast finnas en operatör (elev) och
en instruktör vid svarven när den är igång.
Kontrollera det här innan du startar svarven:
Gör de här testerna innan du börjar arbeta vid svarven för dagen:
Stänkskydd (uppfällt)
STOREBRO
Chuckskydd (nerfällt)
Verktygstavla
Stänkskydd (nerfällt)
Chucknyckel
Huvudströmbrytare
Skärverktyg
STORE
BRO
Nödstopp
Säkerhetsinstruktion, art. nr. 2748756 Rev B
XML och DITA är ett modernt sätt att hantera stora
flöden av information. Dessa är tekniker för dig
som vill satsa på ett skalbart och robust system
som förenklar och sänker kostnader samt höjer
kvaliteten på dokumentationen.
Dokumentation - den traditionella metoden
Traditionellt skapas teknikinformation med verktyg
som Word, FrameMaker, PageMaker, InDesign eller
liknande. Men redan vid ett fåtal produkter eller
kundprojekt riskerar återanvändning, uppdateringar
och översättningar få tid och pengar att rinna iväg.
expertinfo
S:t Eriksgatan 117
113 43 STOCKHOLM
08-559 22 190
[email protected]
XML/DITA kommer in i bilden
XML-tekniken gör det möjligt att återanvända
information. DITA bygger nämligen på att information struktureras i små textblock (sk single-sourcing),
som du som skribent bara skriver en gång och
återanvänder för olika produkter och format.
I XML kan du fokusera på innehållet. Layouten byggs
in i systemet och du väljer enkelt önskat utformat för
din manual - pdf, webb eller varför inte som appar för
iPhone/Android.
DITA-tekniken är integrerad i de flesta CMS (Content
Management Systems) och texteditorer och är väl
använd i globala företag som exempelvis Xylem, Cisco
och SonyEricsson.
Av-/påspak
2012-06-12
DITA - Fördelar
• Single-sourcing - information skrivs bara en gång, och återanvänds
för olika format och för olika produkter.
• Förenklar uppdateringar - om något ska uppdateras (och det ska
det alltid) görs det bara på ett ställe och slår igenom överallt .
• Många publiceringsformat - “tryck på en knapp” för att ta fram
pdf, html, onlinehjälp, Javahjälp, iPad/Android, Word, InDesign osv.
• Översättningshantering - tillsammans med tekniker för
översättningsminnen (t ex TRADOS) kan stora besparingar att
göras - återanvända textblock översätts bara en gång.
• Öppet format - XML är ett format som är “non-proprietary”, det
vill säga open source som inte ägs av något enskilt företag.
• Många lösningsmöjligheter - XML är ett format som tillåter
användaren att använda valfri texteditor, även webbaserade.
• Skräddarsydda lösningar - behöver du integrera din dokumentation till andra system kan specialanpassningar göras.
DITA - Funktioner ett urval
• Informationstyper - DITA:s mallar för olika typer av information
(koncept, instruktion, referens m fl) hjälper skribenten att planera
och skriva pedagogiskt.
• Automatisk text - korsreferenser, index, sidnumrering, innehållsförteckning, definitioner osv är självklart automatiserade.
• Conditional text - “tänd/släck” text för olika produkter/manualer.
• Pull conref - hämta in textblock från andra filer,
varningstexter/regler exempelvis.
• Push conref - lägga till/ersätta textblock i andra dokument (som i
sig inte ändras), exempelvis för viss kund/marknad.
• Variabler - byta automatisk ut exempelvis produktnamn i en text
beroende på i vilken kund/säljbolag texten riktar sig till.
• Specialisering - utveckla egna XML-mallar eller element, helt
anpassat efter hur du vill att vissa dokument ska struktureras men helt inom DITA-standarden.