parson unterstützt G&S IT Group bei effizienter Dokumentation mit Oxygen XML Editor in DITA-XML

Die Ausgangssituation: G&S IT Group will Oxygen XML Editor und DITA-XML besser nutzen

Der Softwareanbieter G&S IT Group hat seine Technische Dokumentation auf DITA-XML und das Authoring-Tool Oxygen XML Editor umgestellt. G&S IT Group wollte das volle Potential von Oxygen XML Editor und DITA-XML nutzen und hat die Expert:innen von parson gebeten, sie dabei zu unterstützen.

Ziemlich, ziemlich viel abgedeckt, was wir im Alltag benutzen.

Vielen Dank ... für die lehrreichen Sessions und dass Sie dabei so flexibel auf unsere Fragen eingehen konnten, das hat uns sehr weitergeholfen. Es war auch sehr interessant, die eigene Arbeitsweise während der Workshops zu reflektieren.

G&S IT Group

Unsere Leistung: Individuelle Online-Workshops statt Schulungen 

In Online-Workshops konnten wir am besten auf die individuellen Bedürfnisse von G&S IT Group eingehen. Zunächst demonstrierten die Redakteur:innen von G&S IT Group ihre bisherige Vorgehensweise. Anschließend haben wir Vorschläge zur Verbesserung des Dokumentationsprozesses erarbeitet, demonstriert und mit den Redakteur:innen von G&S IT diskutiert. 

Folgende Themen wurden in den Workshops behandelt:

Oxygen XML Editor

  • Wichtige Ansichten, Funktionen und Einstellungen in Oxygen XML Editor
  • Arbeiten mit Projektdateien 
  • Ablage- und Ordnerstruktur und Benennungsregeln für Ordner und Dateien
  • Transformationsszenarien anpassen
  • PDF-Ausgabe mit CSS anpassen
Abbildung 1. Arbeiten mit Projektdateien in Oxygen

DITA-XML

  • Korrekte semantische Auszeichnungen, von Topic-Typen bis zu Elementen
  • Wiederverwendung von Inhalten
  • Filterung von Inhalten für bestimmte Zielgruppen und Best-Practices für die Filterung 
  • Erstellung und Verwaltung von Variablen, z.B. für Produktbezeichnungen
  • Beispielhafte Umstrukturierung eines der DITA-Dokumente von G&S IT Group, um wichtige DITA-Mechanismen und Best Practices zu demonstrieren. Diese DITA-Beispiele dienen G&S IT als Vorlage für zukünftiges Arbeiten.
Abbildung 2. Arbeiten in DITA-XML: Korrekte semantische Auszeichnungen

Das Ergebnis: Effizient dokumentieren mit Oxygen XML Editor

Die Technische Redaktion von G&S IT Group kann nun Oxygen XML Editor effizient für das Erstellen der Dokumentation in DITA-XML verwenden. 

Unter anderem können die Redakteur:innen Inhalte wiederverwenden, zielgruppengerecht filtern und Variablen für Produktbezeichnungen anlegen. Weiterhin sind sie in der Lage, ihre PDF-Ausgabe individuell anzupassen. 

Nächste Schritte: HTML-Ausgabe mit dem DITA Open Toolkit

Derzeit veröffentlicht G&S IT Group die Dokumentation im PDF-Format, in Zukunft soll auch eine Ausgabe in HTML erfolgen. Geplant ist auch eine Veröffentlichung außerhalb von Oxygen, und zwar direkt mit dem DITA Open Toolkit. Hierfür wird G&S IT Group ggf. wieder auf die Unterstützung von parson zurückgreifen.

Über G&S IT Group

Gestartet als kleines IT-Unternehmen, hat sich die G&S IT Group rund um die Gründer Daniel Guth und David Schmitz in den letzten 10 Jahren mit ihren Unternehmungen zu einem international agierenden Softwarehersteller entwickelt. Mit der Mission, komplexe Abläufe und Prozesse in einfache und benutzerfreundliche Anwendungen zu überführen, entwickeln inzwischen über 50 Spezialisten an unseren Softwarelösungen, welche in den unterschiedlichsten Branchen und Anwendungsgebieten eingesetzt werden. Das Hauptgeschäft liegt dabei in der Entwicklung von leistungsstarker Software für Satelliten- und Businessmanagement. Unsere Lösungen automatisieren und optimieren die Arbeitsprozesse von Unternehmen aus der ganzen Welt.