DITA Top oder Flop - Zindel AG

DITA als Strukturierungsmethode: Top oder Flop? 

Februar 2008 V1.0 

Dieter Gust, itl AG 

http://www.itl.eu

Wer spricht da? 

Dieter Gust 

27.02.2008 DITA Top oder Flop Version 1.0 Februar 2008 

22 Jahre im Bereich Technische 

Dokumentation tätig 

Technischer Redakteur 

Dozent für technische Dokumentation 

Trainer für Publishingsysteme 

FrameMaker + Word 

(Ventura, PageMaker) 

Spezialist für PDF-Produktionen 

Information Architect: 

Desktop Publishing, 

Content Management, 

Übersetzungsprozesse 

Prokurist bei itl 

2

DITA – Top oder Flop? 

DITA ist für technische 

Dokumentation ist aus USamerikanischer 

Sicht der Hype 

schlechthin. 

DITA ist top, DITA ist der 

Weltstandard für technische 

Dokumentation 

Vorteile 

] Standard-XML-Anwendung 

(keine Neuerfindung des Rades) 

] DTD +Tools „for free!“ inklusive 

Weiterentwicklung! 

] Topic-Orientierung = ideal für 

Wiederverwendungs-Konzepte 

] Toolhersteller bieten out-of-the- 

box DITA-Lösungen 


Praktische Erfahrung des Referenten 

DITA hat eine große Zukunft, aber: 

] Die Umsetzung eines Standards ist 

nicht automatisch billig, sondern 

zunächst sogar teurer, wenn man sich 

dem Standard erst anpassen muss. 

] Nomenklatur erzeugt Emotion und 

umgekehrt: Man muss DITA mögen. 

] DITA ist 2008 als Gesamtlösung nicht 

ausgereift 

] DITA-ROI-Berechnungen definieren 

oft Einsparpotenziale für 

Prozessschritte, die mit DITA nichts 

zu tun haben. 

] Wer hauptsächlich Dokumente für 

PDF/Papier erzeugt, für den kann 

DITA zum Flop werden. 

3

Very Quick Start: DITA Darwin Information Typing Architecture (1) 

Darwin 

] based on principles of 

inheritance and specialization 

Information Typing 

] supports topic-based 

methodologies 

Architecture 

http://dita-ot.sourceforge.net/ 


] expresses design principles for 

creating and delivering 

information-typed topics 

4


DITA Topic Inhaltsmodell 

Topic Title 

Topic Metadata 

Topic Body 

Related Links 

Embedded Topics 

Topic title 


Short description of the topic – 

optional but recommended 

Prolog 

(metadata about the topic) 

Topic body 

] Sections, paragraphs, lists, 

tables, images, semantic 

elements 

Related Links 

(Embedded - nested - Topics) 

5

DITA 

Topic 


Dita Maps 



Topic Reference 



(Sub-Topic) Topic 


(Sub-Sub-Topic) 









A heading doesn’t have to have a 

topic 

Title and properties can be 

assigned in the map 

The map organizes a set of topics 

in a hierarchy 

A topic can appear multiple times 

in the hierarchy 

6


DITA Open Toolkit 


7


DITA 1.1 Elemente 

11 Topic elements (topic , title, body 

section, example, related-links …) 

2 Concept elements (concept, conbody) 

12 Reference elements (reference, refbody 

elements … 

25 Task elements (task, taskbody, prereq, 

steps, cmd 

3 Glossentry elements 

29 Body elements (p, ol, ul) 

10 Table elements 

27 Prolog elements 

5 Related links elements 

11 Miscellaneous elements (dita, 

indexterm, unknown 

6 Specialization elements 


6 Typographic elements (b,i, sub, sup 

25 Programming elements 

8 Software elements 

5 User interface elements 

4 Utilities elements (imagemap …) 

3 Indexing group elements 

10 Map elements 

2 Map group elements 

27 Bookmap content elements 

33 Bookmap metadata elements 

27 xNAL domain elements 

7 DITAVAL elements 

= 298 Elemente 

+ viele Attribute 

8

DITA Pioniere 

DITA Standard – Committee and Public Adopters 


9

DITA kann kein Flop sein: 

Aberdeen Group Report und andere Stimmen 

Aberdeen Group Report 

„Publishing Technical 

Communications to a Multi-Channel 

World“. 

] „Die Nutzung von DITA ist unter 

den branchenführenden 

Unternehmen doppelt so hoch. 

Mit DITA können 

Produktdokumentationen 

präziser verfasst, deren Nutzung 

verbessert und Inhalte 

ortsunabhängig von Firmen 

wiederverwendet werden. 

] Ein empolis-Kunde berichtete 

kürzlich, dass bei einigen 

Produktlinien ganze 78 % der 

Themen und Grafiken in mehr als 

einer Produktdokumentation 

genutzt werden. 


JoAnn Hackos of Comtech 

Services 

] "Companies often spend tens if 

not hundreds of thousands of 

dollars developing custom DTDs, 

yet they often turn out to be 

inflexible and costly to maintain," 

says consultant JoAnn Hackos of 

Comtech Services. 

] "DITA promises enormous cost 

savings because it provides a 

ready-made set of DTDs that 

offers all the advantages of a 

standard." 

10

Best Practice Autodesk 

The project 

] Autodesk is five years into an ambitious 

project to reengineer and retool all of their 

mechanisms for creating and managing 

product support content. 

New Sytem and New Processes 

] They have made the transition from 

unstructured content to XML-structured 

content, and they have established a 

centralized system for managing their 

content, managing their workflow, and 

managing their and managing their 

processes for translation and localization. 

Localization 


] AutoDesk is enjoying significant savings 

Desktop publishing and production of the 

various documents. 

] The new system replaced manual, time- 

intensive tools with automated XSL and 

XSL-FO scripts that take the DITA-encoded 

content and produce the final output 

automatically. For example, a single- 

chapter can be produced in 2 minutes 

using the automatic tools, and a full, 3000- 

page Help product can be generated in 45 

minutes. 

Reuse of the core AutoCAD documentation 

] The team is able to reuse the core platform 

content with only slight transformations. 

They are also able to share and modify 

content between the various vertical 

applications with minimal effort, thereby 

gaining further savings. 

11

Best Practice BMC 

While DITA provides a solid base, 

we still need to "make it fit" our 

BMC Software information 

models, meaning we have to 

develop numerous specializations 

for each information type. 

DITA is a solid architecture that 

offers a great head start, but it 

takes significant effort to make 

DITA work for a specific 

implementation. 


One of the most difficult parts has 

been learning how to model the 

information and then learning how 

to write the specializations in DITA 

to map the model. Learning has 

been the trickiest because we had 

to learn both modeling and how to 

code the model. 

Information modeling should 

focus solely on content, 

independent of technology. 

Information modeling takes an 

iterative approach and, thus, 

requires a significant amount of 

time. Factoring sufficient time into 

the project plan is essential. 

12

Best Practice Texas Engineering Extension Service 

The structured authoring 

environment delivers the added 

advantage of enabling TEEX to 

better leverage XML content in its 

Siberlogic CMS. For example, 

blocks of information in XML can 

be used and reused at the 

paragraph level, allowing 

curriculum developers to take 

frequently used safety processes 

and guidelines and insert them 

automatically into the appropriate 

pages. 


“This is a tremendous efficiency 

gain for our staff,” says McCallie. 

“Now, we can revise and reuse 

content easily across manuals, 

and then automatically insert it 

everywhere it needs to appear. 

The efficiencies could accelerate 

creating manuals by as much as 

25%.” 

13

Best Practice Nokia 

Business objectives 


] Reduce translation costs by 10- 

20% in the first year of 

implementation through re-use 

savings 

] Improve the consistency of the 

content delivered to customers 

through collaborative writing, 

single-sourcing and re-use 

] Reduce the cost of maintaining 

and managing DTDs and 

transformations 

14

Best Practice Symantec Corporation 

Pleasures 

[ reuse of content, 

[ ease of restructuring deliverables, 

[ simple export to multiple delivery 

formats. 

Pitfalls 

[ complex interaction of simultaneous 

reuse possibilities (for multiple 

platforms, releases, and OEM 

deliveries), 

[ completely rethinking the structure of 

administrative topics 

[ the need to be always aware of who 

else might be using a source content 

section. 

Restructuring the legacy content for 

optimal use became impossible. One 

attempt to restructure a large chunk 

of content for optimal reuse rendered 

the structure of that content 

incomprehensible to any of our 

writers. 

http://www.cm-strategies.com/abstracts.htm#Semmelmeyer 


Lulled into complacency, we forgot to 

consider the other writers using our 

sources. One writer had an 

unpleasant surprise when a PDF 

extract (that was fine two weeks ago) 

had missing sections and content that 

no longer applied. 

Another challenge was consideration 

of all the possible uses of our source 

(for multiple platforms, releases, OEM 

deliveries, and products), which 

required months of planning around 

conditional text. 

Tracking hundreds of topics in 

various stages of completion 

expanded our use of Excel 

spreadsheets. And writing for topicbased 

reuse constantly challenged us 

to think differently than our past linear 

writing. 

15

Best Practice Medtronic (1) 


16

Best Practice Medtronic (2) 


17

10 DITA Lessons Learned From Tech Writers in the Trenches 

1. DITA Is NOT A Magic Wand (DITA 

makes some things easier but 

adds its own issues as well.) 

2. Don’t Fall In Love With Software 

3. Don’t Jump in Without a Clear 

Business Case, a Repeatable 

Strategy, and Measurable Goals 

4. While You Are At It, Get A 

Content Management System 

5. DITA Needs to be Constrained. 

DITA allows authors to do things 

your business needs and 

authoring style guides may forbid 

6. Some Writers CANNOT Write 

Reusable Content 

7. Plan for Legacy Content 

Conversion Issues 


8. Resist the Temptation to 

Specialize 

9. Hire an Expert 

10. DITA Changes Everything: 

Getting Up To Speed Requires 

Commitment, Effort, Skills, and 

Training 

When you make the move to 

DITA, there is no room for 

deviation. It is all for one and 

one for all. If you have loose 

cannons trying to do things 

differently, you ARE going to 

have problems and may have to 

make staffing changes. 

18

DITA – Was sagen TD-Dienstleister dazu (1) 

Comet 

] Comet hat als erster Service- 

Provider in Deutschland Projekte 

mit DITA umgesetzt. Diese DITA- 

Lösungen sind bereits seit zwei 

Jahren erfolgreich im Einsatz. 

Tanner 

] DITA ist die Zukunft! 

Kombinierte Vorteile von DITA 

und TANNER-Funktionsdesign 

Cap-Studio 


] DITA ist kein Allheilmittel für die 

Dokumentation. Ob XML- 

basierten Schreiben Vorteile 

bringt, muss geprüft werden. 

] DITA als Standard wirkt nur, 

wenn man möglichst wenig 

Spezialisierung benötigt. 

Anderenfalls steigt der 

Verwaltungsaufwand und die 

nicht-benötigten Teil des 

Standards können lästig werden. 

] XML-basierte 

Dokumentstrukturen können 

Widerstände bei den Autoren 

hervorrufen (Verweis auf Sarah 

O‘Keefe) 

http://www.scriptorium.com/palimpsest/2007/07/understanding-change-resistance.html 

19


Scriptorium (Sarah O-Keefe) 

"Once you start down the DITA path, 

forever will it dominate your destiny" 

] For technical writers, the transition from 

traditional desktop publishing to XML- 

based workflows requires a significant 

shift in mindset.(…) You should not 

underestimate the difficulty that this 

transition presents. 

] Just because it's free doesn't mean it's 

cheap. The default output from the DITA 

Open Toolkit ranges somewhere between 

unattractive (HTML) and fugly (PDF). If you 

care about the appearance of your final 

documents, you are going to have to do a 

lot of work to get the look and feel you 

want. 

] And although the OT offers a starting point, 

customizing it is kind of like a trip to the 

dentist. The impacted-wisdom-tooth- 

removing kind of trip. 

Gordon McLean 

DITA is not the answer 


] All of my research suggests that, rather 

than being a simple installation and 

conversion process, creating a DITA 

solution requires a lot of technical know- 

how and a not insubstantial amount of time 

and resource. We can handle the first, the 

latter is (I believe) not yet at a level which 

makes it cost-effective. 

] Ultimately, for the moment, DITA costs too 

much. 

Norman Walsh 

] topic-oriented writing vs. book-oriented 

writing 

Barbara Stuhlemmer, ClearComm 

InformationDesign 

] Converting to XML - Some Point-form Pros 

and Cons 

20


Manfred Krüger, 

DITA-Praxis – die Sicht der Anwender 

] DITA-Informationsmodell 1.1enthält 

semantische (inhaltsbezogene) 

Strukturen lediglich für die Software- 

Dokumentation. 

] Ein Autor benötigt ein umfassende 

organisatorische Regelung für die 

Bildung seines Topics und der ggf. 

neben- und untergeordneten muss 

kennen. DITA definiert hier völlige 

Freiheit. DITA ist wirklich keine gut 

den Autor führende Struktur! 

] Ohne ein formales CMS wird man in 

der Praxis der DITA-Anwendung nicht 

auskommen. 


Manfred Krüger, 

DITA-Praxis – die Sicht der Anwender 

(Forts.) 

] Die Implementierung von DITA muss 

aus organisatorischen und 

wirtschaftlichen Gründen die 

angebotene Standard-Struktur 

verschlanken, und ggf. um 

spezifische Strukturen erweitern. 

] Die anwendungsspezifische 

Anpassung der DITA-Stylesheets 

erfordert auch für erfahrene 

Spezialisten einen erheblich höheren 

Aufwand als ein von Grund neues 

Stylesheet-Design.. 

] Machen Sie sich nichts vor: Wenn Sie 

DITA in Ihrer Organisation eingeführt 

haben und meinen, es habe eigentlich 

nicht viel Geld gekostet, dann haben 

Sie etwas falsch gemacht! 

21

“Everything takes longer with DITA” 

Over coffee this week I heard the 

complaint “everything takes longer 

with DITA” from a tech writer at a 

company that recently converted from 

unstructured FrameMaker to DITA. 

Why? Well you just can’t do File 

Open, add a paragraph or two, and 

consider your update done. 

The Facts: The complaint may well be 

absolutely true – for the writer at the 

moment at the time of adding a 

paragraph. 

http://methodm.com/blog/category/dita/ 


But it is absolutely false for the total 

document cost because DITA 

enables: 

] Delivery of the content to the user in 

multiple instances (e.g. 

troubleshooting, installation, FAQ, 

etc.). 

] Customization of the document for 

presentation to different types of 

users. 

] Easy updating of the content. 

] Definition of related topics (tasks that 

must be performed in a sequence, for 

example). 

] Focusing information on what the 

customer needs at a particular 

moment (how-to information, for 

example, or reference content) 

] And, of course, lower translation 

costs and much, much, much more. 

22

Was sagt Dieter Gust zu DITA? 

DTP- und XML-Redaktionssysteme im Vergleich 

Zeitaufwand 

Papier 

DTP-Editing XML-Editing 

PDF 

Konverter 

Vorteil: Instant Printing DTP-Editing 

HTML PDF HTML 


Konverter Konverter Konverter 

Papier 

PDF 

Nachteil: DTP-Post-Processing 

Flexibilitätsverlust 

23


Besonders auf die Werkzeuge kommt es an! 


Wunsch 

Worst Case? 

Produktivität mit XML 

nach einem Jahr 

auf dem alten Stand? 

http://www.elkera.com/cms/articles/seminars_and_presentations/planning_a_single_source_publishing_application_for_business_documents/ 

24


Hatten Sie bisher keine Zeit zum Ausfüllen dieser Fenster? 


DITA wird das ändern… 

25

Topic-Orientierung / Modularisireung ist kein Selbstzweck 

Welche Granularität ist geeignet? 

Flexibilität 

für Wiederverwendung 

Verwaltungsaufwand 

Eine fiktive 

optimale Stelle 


Redundanz 

bei Mehrfachverwendung 

Modulgröße: Datum, Wort, Satz, Absatz, Topic, Abschnitt, Kapitel 

26

DITA und der Gesamtprozess für TD: 

Wichtig: Terminologie und „Topics-im-Kontext“-Betrachtungen 

Produktentwicklung 

Redaktion 

Multithreading 

Übersetzung 

Multithreading 

Produktion 

Verwaltung 

Spezifikationen 

User-Interface-Texte 

Techn. Daten UI-Strings 

Single-Source Editing 

Sprachkontrolle 

Preflight Checks 

Übersetzungsprozess 

Kunden Review 

Finishing 

Produktion 

Datenmanagement/ 

Dokumentenmanagement 


Terminologie 

Terminologie 

Terminologie 

Terminologie 

Terminologie 

27

DITA / XML Vorteile: Termine, Kosten, Qualität? 

Es geht doch auch alles ohne DITA, oder gar ohne XML… 

Systemimplementierung: ? % ZKQ 

] DTD-Entwicklung 

] Templates für PDF/HTML 

] Topic-Editor + Struktur/MAP- 

Editor 

] Zukunftssicherheit 

] Standard (Vorteil =??) 

Datenimport ? % ZKQ 

Informationserstellung ? % ZKQ 

Wiederverwendung ? % ZKQ 

Kontrolle der Wiederverwendung 

? % ZKQ 

Z = Zeit, K = Kosten, Q = Qualität 


Dokumentzusammenstellung 

? % ZKQ 

Sprachkontrolle ? % ZKQ 

Übersetzung ? % ZKQ 

Kundenreview ? % ZKQ 

Finishing/Produktion ? % ZKQ 

Daten-/Dokumentmanagement ? 

ZKQ%? 

… 

Was meinen Sie? 

28

Jeder Hype kennt Höhen und Tiefen: Wo steht DITA? 

http://lighthouseseminars.com/gilbane_sf_06/presentations/Bill_Trippe_tutorial.pdf 


29

DTA Maturity Model, hmm? 


30

Anhang Informationshinweise 

Developing Quality Technical 

Information. A Handbook for 

Writers and Editors (IBM Press 

Series) 2nd ed, 2004 

Introduction to DITA Arbortext 

Edition 

Introduction to DITA 

Sissi Closs, Single Source 

Publishing. Topicorientierte 

Strukturierung und DITA, 2006 

Johannes Hentrich, DITA - Der 

neue Standard für Technische 

Dokumentation 


http://www.ditamap.com/ditaref/dit 

aref11-main.php 

http://dita.xml.org/ 

http://www.ditainfocenter.com/ 

http://www.ditawiki.org/ 

Content Management 

Strategies/DITA North America 

(April 2008) 

www.tekom.de 

[ Tekom DITA-Entscheidungshilfe 

Comet Single Source Forum 

31

itl München Unternehmensdaten 

Firmengründung 1982 

Unternehmensform Aktiengesellschaft 

Vorstands- Christine 

vorsitzende Wallin-Felkner 

Prokuristen Dieter Gust, 

Peter Kreitmeier 

Regine Ceglarek 

über 50 fest angestellte Mitarbeiter 

ca. 150 freie Mitarbeiter weltweit 


32

itl Dienstleistungsspektrum 


Prozess- und System- 

Consulting: 

] Word, FrameMaker, 

Acrobat, 

] XML, 

] Einführung von 

Redaktionssystemen, 

(docuglobe, TIM- 

RS,…) 

] Tools für kontrollierte 

Sprachen 

] Topic orientiertes 

Schreiben 

/Modularisierung 

] Kompaktsmeminar TD 

33

Vielen Dank für Ihre Aufmerksamkeit! 

Wir sehen Die Welt 

mit Ihren Augen! 


itl – Ihr Full Service Dienstleister 

Übersetzungsdienstleistungen 

Technische Dokumentation 

Produkt- & Prozesslösungen 

Wissenslösungen 

34

DITA Top oder Flop - Zindel AG

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?