Content Strategies and the spirit of DITA

by

The mini-tracks during Content Strategies 2016/ DITA North America have shown DITA development in so many fields of content and communication:Washington Monument

  • Lightweight DITA
  • Taxonomy
  • Video
  • Translation
  • Learning and Training
  • Medical Industry
  • DITA for the Machine Industry

The spirit of DITA, as Michael Priestley reminded us in one of his presentations, is to ADAPT. The more options and tools are emerging, the more ways there are to connect and grow towards Enterprise Content Management, to consolidate, coordinate, collaborate on common content across departments.

From one track to the other, conference attendees could learn about minimal content models that “can still go crazy” (Michael Priestley), ditamaps handling decision points as a dynamic flow (Chris Nitchie), cross-format content in ditamaps (Carlos Evia), shaping the content with taxonomy (Joe Pairman), card-based content authoring and delivery (SAP), simple DITA format for translation (George Bina), augmented linguistic review (WhP).

To encourage even more teams to adopt DITA, I presented the model2dita project and was glad to see it struck a chord, just as it did last November at DITA Europe in Munich.

model2dita: Generate your DITA project structure from the information model

What is your process when you start a new documentation project in DITA? How do you decide on the content and by which magic does it turn into DITA topics and maps? To develop effective, user-oriented information, you should invest most of your time in researching your audience and in task analysis rather than clicking New > File > Map, New > File > Topic and dragging topicrefs…

New DITA writers often find it difficult to envision the transformation of the information outline to the actual DITA structure. Others don’t even have the habit of starting with an information model in the research phase of a project.

The prezi shows the importance of the modeling phase in the writing workflow, as well as some methods and tools for translating the model into a DITA project structure automatically.

Moreover, I owe a hat tip to Paul Zimmerman (CISCO) for mentioning my last year’s project, rst2dita, about markdown round-tripping in his presentation “Get to Gittin’ On: Integrating code and content management in Git“.

Touring Reston, VA and Washington, DC was remarkable. See you all again in Munich in November.

Unfolding the Techcomm Box

by

[Originally posted on the Information Energy Blog, on March 29th.]

No doubt, the “techcomm box” keeps growing as we discover new dimensions of our digitally intertwingled lives. Without aiming to outline the history of technical writing here, I’d say we went through stages like typing, layouting, help authoring, single sourcing…

Folding-box template from templatemaker.nl

…and now, as we are still struggling to implement structured, semantic writing, we are unfolding one by one the sides of the techcomm box, extending our expertise towards multiple disciplines.

  • We are consolidating our roles as content experts through user research, information typing, minimalism, and instructional design.
  • We adopt standards that make our content interchangeable and part of the linked web of data for man and machine.
  • We collaborate across departments in our organizations, integrate with other systems and publish enterprise content.
  • We learn techniques from information architecture, UX, web design, and social media, to reach our audiences and accompany them along an intelligent, omnichannel experience.

Utrecht is the perfect place to meet and talk about information modeling and design. The infomedian gathering every June gets, as its name says, the information energy flowing and encourages us to think outside the box.

Looking forward to meet you in Utrecht and to discover further dimensions we need to explore as we “Design for Knowledge”!

Join the workshop, June 8 on “Modelling intelligent content” to experiment with a few research and analysis methods and to create a sample content project.

DITA-Themen bei XML Prague 2016

by

English >>

Auf dem Programm der XML Prague Konferrenz, wo die Teilnehmer zwischen 7 Monate und 70 Jahre jung sind, stehen immer mehr DITA Themen und Werkzeuge.

Am ersten Tag fand das oXygen Users Meetup statt. George Bina und sein Team haben das neue Produkt oXygen XML Web Author, dessen Zielgruppe DITA-Reviewers und gelegentliche Autoren sind, angekündigt: https://www.oxygenxml.com/webauthor/

This slideshow requires JavaScript.

Ich habe den Web Author gleich auf dem iPhone probiert.

Außerdem, wird die Version 18 des oXygen XML Editors bald herausgegeben, in der noch weitere Möglichkeiten geben wird, DITA-Autoren bei der visuellen Redaktion, sowie DITA-Architekten bei der Implementierung von Einschränkungen und kontrollierten Werten zu unterstützen. Man kann ein bestimmtes Layout mit einem Projekt speichern oder zu einem Framework zuweisen, damit ganze Teams mit den selben Layout-Einstellungen arbeiten können. Einschränkungen (Constraints) werden bald einfach durch einer config-Datei implementiert. Darüberhinaus, könnte man eine ganze XML-Schema lokalisieren, was die Diskussion über DITA-Elemente in beliebigen Sprachen sofort anregte.

Patrik Stellmann hat sein Framework DITA-SEMIA gezeigt: https://github.com/dita-semia

DITA-SEMIA Sequence Diagramms

DITA-SEMIA: Sequential Diagrams

Parallel, in dem BaseX Meetup, hat Eliot Kimber sein Projekt DFST (DITA for Small Teams: http://www.dita-for-small-teams.org/) via Skype vorgetragen.

Maximilian Gärber hat das neue Argon-Author Plugin für DITA Content Management in oXygen und BaseX vorgestellt: argon-author.com Beta-Testers können sich schon anmelden und Argon-Author im BaseX-Sandbox versuchen. Mein kleiner Beitrag dazu, außer die Patentante zu spielen ;), ist das mitgelieferte Demo-DITA-Projekt über Trello.

This slideshow requires JavaScript.

XML Prague läuft drei Tage jeden Februar, voller spannenden Vorträge und Workshops aus der XML/XSLT/CSS/FO-Welt: http://www.xmlprague.cz/

DITA sessions at XML Prague 2016

by

Deutsch >>

The geeky things you hear at an XML conference with participants between 7 months and 70 years young…

“Convincing W3C into marrying XSL-FO and CSS would be like a shotgun wedding.”

“I fixed a bug just with my iPhone today.”

“You might have a super hammer, but not everything is a nail.”

“There is DITA light and DITA not light.”

Now, for the serious business – the number of sessions about DITA practice and tools at XML Prague keeps growing every year.

On day 1, during the oXygen Users Meetup: George Bina and his team launched their new product oXygen XML Web Author, especially crafted for DITA reviewers and occasional authors: https://www.oxygenxml.com/webauthor/

This slideshow requires JavaScript.

I couldn’t resist trying it out on my iPhone.

Version 18 of the oXygen XML Editor is also coming soon, and brings further features to support DITA authors with visual editing, as well as DITA architects through easier implementation of constraints and controlled values. You can save a certain layout within a project or a framework, so that entire teams would work with the same layout settings. You’ll soon be able to set constraints by just editing a config file. Moreover, you could easily localize an entire XML schema, and this idea immediately triggered discussions about having DITA elements in any language.

Patrik Stellmann has shown his DITA-SEMIA framework in oXygen: https://github.com/dita-semia

DITA-SEMIA Sequence Diagramms

DITA-SEMIA: Sequential Diagrams

On a parallel track, in the BaseX Meetup, Eliot Kimber presented his DFST project (DITA for Small Teams: http://www.dita-for-small-teams.org/) via Skype.

Maximilian Gärber demonstrated the new Argon-Author plugin for DITA Content Management in oXygen on a BaseX database: argon-author.com You can log in as beta-tester and try out Argon-Author in the BaseX sandbox. My humble contribution, besides naming the baby 😉 ,  is the sample DITA project about Trello, included with the plugin.

This slideshow requires JavaScript.

XML Prague runs for three days full of interesting presentations, demos, and workshops from the XML/XSLT/CSS/FO world every February: http://www.xmlprague.cz/

Redakteure beteiligen und richtig schulen

by

English >>

Es gab eine interessante Discussion auf dem Blog von Larry Kunz über Schulungsbedarf und Geschäftsziele während und nach einer DITA-Implementierung. Ich habe meinen Kommentar schon auf Larrys Seite hinzugefügt, ich trage aber auch hier die Übersetzung ein.

Vielen Dank an Larry, dass er nochmal die Aufmerksamkeit von Projekt- und Abteilungsmanagern auf die Notwendigkeit erregt, die Redakteure frühzeitig zu beteiligen und ihnen so viel Schulung anzubieten wie nötig, damit sie ihre Geschäftsziele erreichen. Diese Botschaft wird nicht oft genug ausgerichtet, obwohl späte Beteiligung und mangelhafte Schulung zu den Hauptgründen fehlerhaften Implementierungsprojekten gehören, egal ob es um CCMS geht, oder um andere Systeme, wie WCMS, CRM, ERP, u.s.w.

In seinen Kommentaren zum selben Artikel erwähnt Mark Baker, dass wir solche Content Systeme brauchen, die zu einer noch unvorhersehbarer Zukunft passen würden. Ich kann Marks Ideen zwar verfolgen, jedoch furchte ich, seine Vision würde nur schwer passen, wenn man sich für Redaktionssysteme einsetzt, die die Komplexität der Redaktionsaufgaben gleichzeitig verstecken sollten.

Meiner Meinung nach, sollte man die Expertise der technischen Redakteuren nicht unterschätzen und sie nicht auf Storytelling (spielt Jemand Trendwort-Bingo?) verringern.

Technische Redakteure und Redakteurinnen, die ihre Rolle ernst nehmen, sollte man anregen, endlich mal über ihre Komfortzone hinaus zu tretten, um neue Methoden für die Modellierung und für die Erfassung von Inhalten anzuwenden.

Ob Markup oder Markdown, das soll in der Zukunft keine Frage mehr stellen… Ideallerweise würden Autoren beide anwenden können, auch abwechselnd wenn es die Geschäftsziele so anfordern.

Also, ich stimme Larry zu – Redakteure beteiligen und richtig schulen!

Artikel von Larry Kunz: We’re in DITA – Now what?