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 ...

Technische Redaktion mit oXygen

oXygen habe ich meinem Kollegen Mark zu verdanken. Er war auf der Suche nach einem XML-Editor für Skript-Programmierung und lud sich eine Testversion von oXygen herunter. Schnell stellten wir fest, dass wir mit oXygen sehr komfortabel XML-Dokumentation in gängigen Standards wie DITA oder DocBook erstellen konnten. Wir kauften eine Floating Lizenz für den oXygen XML Editor, die wir gemeinsam verwenden wollten.

Gleichzeitig erhielten wir Anfragen von Kunden zum Einsatz von oXygen. Wir fingen an, das Programm produktiv für das Authoring einzusetzen. Mark hatte das Nachsehen – unsere Floating Lizenz war nun ständig im Authoring-Einsatz und nicht für ihn verfügbar. Zum Glück lassen sich Lizenzen nachkaufen.

Versionen

Neben der Vollversion bietet oXygen zwei eingeschränkte Versionen: XML Developer ist unter anderem für Schema-Design und XSLT-Entwicklung geeignet. XML Author enthält alle Funktionalitäten für das Schreiben XML-basierter Dokumentation. Wer ein Tool sucht, um beispielsweise standardkonforme DITA-Dateien zu schreiben, für den reicht der Author aus.

Lernkurve

Für Redakteure, die Dokumentation bisher mit Word oder unstrukturiertem FrameMaker erstellt haben, kann  die Umstellung auf oXygen aufwändiger sein. Möglicherweise müssen sie neben einem neuen Tool auch die Grundprinzipien XML-gestützter Dokumentation erlernen, u.a.

  • Trennung von Layout und Inhalt
  • Denken in Elementen und festen regelbasierten Inhaltsstrukturen anstelle von Absatzformaten
  • Varianten- und Ausgabesteuerung mit Hilfe von Attributen
  • topicorientiertes Schreiben (kein eigentliches Prinzip von XML, aber in vielen XML-Umgebungen verankert)

Redakteure, die bereits in einer XML-Umgebung arbeiten, werden sich in oXygen schnell zurecht finden. Und sie werden sich freuen, nicht erst verschiedenste Plug-ins nachrüsten oder Konfigurationsdateien anpassen zu müssen, bevor sie das erste Ergebnis erzeugen können (FrameMaker lässt grüßen).

Output auf Knopfdruck

Was mir auf Anhieb gut gefiel: Ich konnte eine vorhandene DITA-Map – erstellt in FrameMaker – in einer Standardinstallation von oXygen öffnen und eine Webhelp und eine PDF auf Knopfdruck produzieren. Natürlich entsprechen die noch keinem publizierbaren Informationsprodukt. Sie müssen an die Unternehmensvorgaben angepasst werden. Aber für einen Review taugen sie allemal.

Für Mausschubser und Tastaturjunkies

oXygen ist äußerst flexibel in der Darstellung und Handhabung. Für Autoren, die WYSIWYG-Editoren gewohnt sind, gibt es eine Author-Ansicht. In der können die XML-Tags bei Bedarf sogar vollständig ausgeblendet werden. Autoren mit eher technischer Vorbildung werden vielleicht die Text-Ansicht bevorzugen, die „nacktes“ XML  zeigt. Elemente und Attribute können hüben wie drüben je nach Vorliebe per Autovervollständigung, Kontextmenü am Mauszeiger oder per Doppelklick mit der Maus eingefügt werden. oXygen ist auf die „Mausschubser“ gleich gut vorbereitet wie auf die „Tastaturjunkies“.

Oxygen_DITA

1 – DITA Maps Manager: Ermöglicht die Bearbeitung der Map als Baumstruktur.
2 – Outline: Hierarchische Darstellung des Contents, ähnlich der Strukturansicht in FrameMaker.
3 – Editor im Author-Modus: Ob und welche XML-Tags sichtbar sind, kann eingestellt werden.
4 – Elements-Katalog: An der aktuellen Position sind ungültige Elemente grau darstellt.
5 – Transformationsszenarien: Die aktuell konfigurierten Ausgabeformate.

Perfektes Layout?

Wenn ich heute die Wahl habe, DITA-Dateien mit FrameMaker oder oXygen zu bearbeiten, würde ich immer oXygen nehmen. Der einzige Wermutstropfen ist die Anpassung des Layouts für die PDF-Ausgabe – zugleich die größte Stärke von FrameMaker. Während sich in FrameMaker Templates komfortabel mit Bordmitteln grafisch aus Baukastenelementen zusammensetzen lassen, benötigt man in oXygen Kenntnisse in XSLT, CSS und Co., um das Layout anzupassen. Auch kann man vor dem Drucken nicht manuell in Umbrüche und ähnliches eingreifen. Steht jedoch Automatisierbarkeit anstelle eines perfekten Layouts im Vordergrund, sollte dies kein Problem sein.

Kommentar schreiben


  • facebook
  • linkedin
  • xing