Blog

Check if oder check that? Oder: Have you tried turning it off and on again?

Wie oft schreiben oder lesen wir in Anleitungen, dass wir etwas prüfen sollen. Beispiel: "Check if the computer is connected to power." Klare Ansage, alles schön. Was aber, wenn dort steht: "Check that the computer is connected to power"? mehr ...

Hoher Qualitätsanspruch ohne mentale Sandburgen und Dünkel - 10 Fragen an Ines Lasch

Ines Lasch macht eine Weiterbildung zur Technischen Redakteurin und absolviert ein achtwöchiges Praktikum bei parson. Wir haben ihr zehn Fragen gestellt. mehr ...

Volontariat für Technische Redakteure. Zwei Sichten auf die berufsbegleitende Ausbildung

Anja Schiel, Volontärin, und Ulrike Parson, Vorstand der parson AG, berichten über ihre Sicht des Volontariats für die Technische Redaktion.* mehr ...

Machen Sie Ihre technische Dokumentation intelligent – der Weg vom Content Management zu Content Delivery

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen. mehr ...

So funktioniert Mentoring bei parson

Die Bewerbung ist verschickt, das Vorstellungsgespräch war erfolgreich, jetzt kommt die Zusage. Und da ist er schon, der erste Arbeitstag, an dem alles so fremd ist: Kollegen, deren Namen man sofort wieder vergisst, Ablagestrukturen, Prozesse, ERP-System. Nicht mal die Kaffeemaschine funktioniert auf Anhieb. Und wo war noch mal der Besprechungsraum? 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