Blog

How to become a technical writer – Confessions of a former translator

A former translator, I worked the first seven years of my professional life in the translation industry, in various positions. While I learned a lot from this experience, it also left me, as a writer, frustrated. Translators are chained to their source text and writing the words of others in another language, usually focusing on what their clients want. mehr ...

tekom-Impressionen Teil 2: API-Dokumentation und die VUKA-Welt

Daniela Herbold und Ulrike Parson berichten über Leitlinien für eine optimierte API-Dokumentation sowie Lösungsansätze für eine innovative Personalführung. mehr ...

tekom-Impressionen Teil 1: Improvisationstechniken, Fluff Hunt und Videos

Auf dem Weg zur Konferenz sehe ich an der Fassade des Stuttgarter Bahnhofs ein Zitat von Hegel: „daß diese Furcht zu irren schon der Irrtum selbst ist“. Genau darum ging es in Anthonys Apodacas Vortrag am Morgen des zweiten Konferenztages. mehr ...

My first time at tekom

I got back from Stuttgart last night and it is safe to say that after three days of action-packed presentations, writing an article is not in the realm of possibilities right now as I try to connect one synapse with another. mehr ...

Eine Tasse auf Reisen #4 - die Auflösung

In welcher Stadt wurde die parson-Tasse fotografiert, haben wir Anfang September gefragt. Die Frage war knifflig. Trotzdem kamen die meisten auf die richtige Antwort: In Chicago, USA. mehr ...

Stubborn Susan und Shaky Steve. DITA-Typologie leicht gemacht

Sind Sie ein Trial-and-Error-Tom oder ein Jump-right-in-Joe? Und wissen Sie, was eine DITA-Typologie ist? Ich nicht, bisher jedenfalls. Frank Ralf hat's erfunden.

Unser Kollege Frank Ralf war bei der diesjährigen DITA Europe in München. In seinem Beitrag zum DemoJam stellte er die verschiedenen DITA-Typen vor und wie sich ihre Arbeitsweise und der daraus resultierende Erfolg (oder Nichterfolg) mit DITA in einem Diagramm abbilden lassen (y-Achse: Emotionen, x-Achse: Wissen). Erkennen Sie sich in einem der DITA-Typen wieder?

DITA TypenDITA-Typologie nach Frank Ralf

DITA Types - Dramatis Personae

Stubborn Susan
Stays put, won't write documentation at all, regardless of the format or tool. After all, you can just look at the code, can't you?

Trial-and-error Tom
Quickly gets the hang of the new DITA format, explores DITA by trial and error. If he doesn't know, he calls the support line. Often. But don't worry, he stays relaxed. The way he works keeps him happy and moves him horizontally (knowledge) over time.

Shaky Steve
Knows enough for his daily work. Is happy as long as it works; if not, he panics and his liking of DITA drops instantly. Support calls are always fire-fighting missions, so you better help him quickly. Shaky Steve moves heavily vertically (emotion) without making too much progress horizontally (knowledge).

Jump-right-in Joe
You don't ever hear from him again only to discover after two months that he has implemented a complex @conkeyref-mechnism for his DITA documentation and automatically builds release notes with Jenkins using his own DITA templates.

Grumpy Gary
But there's also a dark side of DITA. At the bottom of his heart, Grumpy Gary is convinced that topic-based documentation using XML is the right way to do. And he is very knowledge-able about everything XML. But the longer he studies DITA the more he recognizes that "all that glitters is not gold".

Enlightened Eliot
The state, all DITA users want to reach eventually.

Tags: DITA

Kommentar schreiben


  • facebook
  • linkedin
  • xing