EINFÜHRUNG EINES DITA -PILOT-PROJEKTS · EINFÜHRUNG EINES DITA -PILOT-PROJEKTS planen, starten, testen (Workshop) 14.-15. April 2016, tekom Frühjahrstagung Berlin Magda Caloian

EINFÜHRUNG EINES DITA-PILOT-PROJEKTS planen, starten, testen (Workshop)

14.-15. April 2016, tekom Frühjahrstagung Berlin Magda Caloian | Business Consultant, DITA Expert | FCT AG

1

Vorstellungsrunde

5 Min., 4er Gruppen

• Stelle

• Industriebereich

• Produktlinie

• DITA/XML-Erfahrung

think-dita.com

@thinkDITA

www.linkedin.com/in/magdacaloian

www.xing.com/profile/Magda_Caloian

© Copyright FCT AG 2016 | www.fct.de Magda Caloian (@thinkDITA), tekom Frühjahrstagung Berlin, 15.04.2016

Einführung eines DITA-Pilot-Projekts Agenda

• DITA Standard und Redaktionsprozess• DITA-Implementierung• Pilotprojekte• Einsatzmöglichkeiten• Phasen des Workshops

• Entwurf• Produktion• Bearbeitung• Nächste Schritte GitHub:

https://github.com/mgcalo/DITAPILOT-samples.git


DITA Standard„Darwin Information Typing Architecture“

• Open-Source, XML-Standard

• Informationstypen (Topics)

• Informationsarchitektur

• Vererbung

• Spezialisierung

• Quellen-Austausch (Lieferanten-Doku)

• Tool-unabhängig

• Community


DITA StandardRedaktionsprozess

Planen Recherche Erfassen Review Zusammenbauen Publizieren


DITA ImplementierungProjektphasen

Kickoff Audit Architektur Schulung Migration Einführung


PilotprojekteMuster- & Voll-Projekt

Kickoff Audit Architektur Schulung Migration Einführung

Ein Muster DITA-Projekt als Business Case Nachweis

Ein volles DITA-Projekt als Machbarkeitsnachweis

InfoModell

Topics-Matrix

AnalyseInventar

Zielgruppe

InfoModell

Publika-tionen

Tätigkeiten


Pilotprojekt EinsätzeMigration -> Audit

InfoModell

Topics-Matrix

AnalyseInventar


Pilotprojekt EinsätzeNeue Projekte -> Tätigkeitsanalyse

Zielgruppe

InfoModell

Publika-tionen

Tätigkeits-Analyse


Pilotprojekt EinsätzeMöglichkeiten

•Content Management

•DITA-Editor

•DITA-OT & PluginsCCMS

•DITA-Editor

•DITA-OT & PluginsEditor•Kommandozeile

•Ant Build-Skripte

•PluginsOT

oder:

oder:


PilotprojektPhasen des Workshops

Entwurf Produktion Bearbeitung


EntwurfsphaseZielgruppen- und Tätigkeitsanalyse

Persona

• Datenquellen• Umfrage, Tests• Support-Abteilung, Vertrieb, Marketing• Web-Analytics• Studien, etc.

• Steckbrief• Foto• Namen• Alter• Status: Job, Familie• Werdegang• Sprachen, Hobbies• Ziele, Verhalten

Nutzerzentrierter Ansatz & Kommunikation



Persona

• Datenquellen• Umfrage, Tests• Support-Abteilung, Vertrieb, Marketing• Web-Analytics• Studien, etc.

• Steckbrief• Foto• Namen• Alter• Status: Job, Familie• Werdegang• Sprachen, Hobbies• Ziele, Verhalten

Nutzerzentrierter Ansatz & Kommunikation



Zielgruppen



Tätigkeiten

• Datenquellen• Produktmanagement• Design-/ Entwicklungsabteilung• Support• Testen



Tätigkeiten und Informationsbedarf

• Datenquellen• Produktmanagement• Design-/ Entwicklungsabteilung• Support• Testen


Entwurfsphase


EntwurfsphaseInformationsmodell


ProduktionsphasePublikationen

• PDF• WebHelp



• deliveryTarget


ProduktionsphaseProjektstruktur

Adobe FrameMaker


ProduktionsphaseProjektstruktur

oXygen XML Editor


ProduktionsphaseProjektstruktur Erstellen

oXygen XML Editor Adobe FrameMaker

1. Projektdatei erstellen

2. „source“-Ordner erstellen

3. DITAMAP erstellen

4. In Map: <topicref>-Elemente mit navtitle-

Attribute laut Modell hinzufügen

5. Unter „source“: Topic-Dateien erstellen

6. In Map: für jeden <topicref> href-Attribut mit

dem Pfad zum Topic hinzufügen

7. Publikationsszenarien für Hauptmap

erstellen

Tutorial (PDF, EN): http://wp.me/a2Zrsr-5v

1. „source“-Ordner erstellen

2. DITAMAP erstellen

3. Unter „source“: Topic-Dateien erstellen

4. In Map: <topicref>-Elemente laut Modell

hinzufügen

5. Hauptmap publizieren


http://wp.me/a2Zrsr-5v

ProduktionsphaseProjektstruktur Erstellen (mit Keys und DITAVALS)

oXygen XML Editor Adobe FrameMaker

1. Projektdatei erstellen2. „source“-Ordner erstellen3. DITAMAP erstellen4. Evtl. Key-Maps erstellen und in Hauptmap

referenzieren5. In Map: <topicref>-Elemente mit navtitle-

Attribute laut Modell hinzufügen6. Unter „source“: Topic-Dateien erstellen7. In Map: für jeden <topicref> href-Attribut mit

dem Pfad zum Topic hinzufügen8. Evtl. keys in key-Maps erstellen9. Publikationsszenarien für Hauptmap

erstellen10. Evtl. DITAVAL-Dateien erstellen und in

Publikationsszenarien referenzieren

1. „source“-Ordner erstellen2. Unter „source“: Topic-Dateien erstellen3. DITAMAP erstellen4. Evtl. Key-Maps erstellen und in Hauptmap

referenzieren5. In Map: : <topicref>-Elemente laut Modell

hinzufügen6. Evtl. keys in key-Maps erstellen7. Hauptmap publizieren8. Evtl. DITAVAL-Dateien erstellen und bei

Publikation eingeben


EntwurfsphaseInformationsmodell

Automatisieren:

model2dita - oXygen Framework, open-source

https://github.com/mgcalo/model2dita.git


https://github.com/mgcalo/model2dita.git

ProduktionsphasePublikationsszenarien

Adobe FrameMaker

oXygen XML Editor



• PDF• WebHelp


BearbeitungsphaseDITAMAP Struktur

• map

• title

• (topicmeta)

• mapref/ topicref

• topicref• topicref

topicreftopicref

• topicref

• topicref• topicref• Topicref

• reltable

Map-Beispiel in oXygen Editor: Map-Beispiel in FrameMaker:


BearbeitungsphaseModul-Struktur

• concept

• title• shortdesc/ abstract

• prolog

• conbody• (related-links)


BearbeitungsphaseTopic-Struktur

Was ist...?

• concept

• title

• shortdesc/ abstract

• prolog

• conbody• p• fig• ol• ul• dl

Wie kann ich ... ausführen?

+ task

+ title

+ shortdesc/ abstract

+ prolog

+ taskbody+ prereq+ context+ steps

stepcmdinfostepresult

+ result+ example+ postreq

Was benutze ich um ... ?

+ reference

+ title

+ shortdesc/ abstract

+ prolog

+ refbody+ section

titletableoluldl


Topic orientiertes Schreiben & DITABücher

Audit-Phase:

+ Michelle Carey &al.: “Developing Quality Technical Information”

+ Paula Landenburg Land: “Content Audits and Inventories”

+ Kristina Halvorson: “Content Strategy for the Web”

Anfangen mit DITA:

+ Laura Bellamy &al.: “DITA Best Practices”

+ Ann Rockley, Steve Manning, Charles Cooper: "DITA 101“

+ Tony Self: "The DITA Style Guide: Best Practices for Authors“

+ Julio Vazquez: "Practical DITA„


Topic orientiertes Schreiben & DITAOnline Ressourcen

DITA Dokumentation:

+ http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/archSpec/base/ditamarkup.html#ditamarkup

DITA Open Toolkit Dokumentation:

+ http://www.dita-ot.org/2.2/

DITA Users Group auf Yahoo:

+ https://groups.yahoo.com/neo/groups/dita-users/infoDITA

Community auf GitHub:

+ https://github.com/dita-community


http://docs.oasis-open.org/dita/dita/v1.3/os/part3-all-inclusive/archSpec/base/ditamarkup.html#ditamarkup

http://www.dita-ot.org/2.2/

https://groups.yahoo.com/neo/groups/dita-users/infoDITA

https://github.com/dita-community

BearbeitungsphaseNächste Schritte

• Sandkasten & Akzeptanz-Testen• Weitere Strukturelemente • Taxonomie & SubjectScheme Map• Wiederverwendungsstrategie• Variablen• Topic Typen

• L&T• Machinery-Task

• DITAMAP vs. Bookmap• Layout-Plugins• Workflow & Roles• Schematron & QuickFixes• LwDITA integrieren

Die Elefanten-Fabel vermeiden. Das ganze Team informieren.


FCT AG | AnsprechpartnerWir sind gerne für Sie da – sprechen Sie uns an!

Fischer Computertechnik FCT AGHauptstraße 3078315 Radolfzell am Bodensee

Fon +49 (0) 77 38 / 92 94 - 0Fax +49 (0) 77 38 / 92 94 – 92Email [email protected] Web www.fct.de

Magda CaloianBusiness Consultant, DITA Expert

Fon +49 (0) 77 38 / 92 94 - 22Fax +49 (0) 77 38 / 92 94 - 92Email [email protected] Twitter @thinkDITA


Documents

EINFÜHRUNG EINES DITA -PILOT-PROJEKTS · EINFÜHRUNG EINES DITA -PILOT-PROJEKTS planen, starten, testen (Workshop) 14.-15. April 2016, tekom Frühjahrstagung Berlin Magda Caloian