Unkomplizierte Erzeugung von Zielformaten

in der Technischen Dokumentation

Mittlerweile muss eine technische Dokumentation oftmals in viele unterschiedliche Zielformate exportiert werden. Gedruckt, als durchsuchbare Website, als PDF, und das alles natürlich in einem unternehmenskonformen Layout… Wer soll da den Überblick behalten?

 

Zielformate einfach erzeugen

PDF, Druck, Videoanleitungen, mobile Anwendungen, Augmented Reality...

PDF, Druck, Videoanleitungen, mobile Anwendungen, Augmented Reality...

Vielleicht haben Sie ja auch den Eindruck, dass die Welt immer komplexer wird. Tatsächlich trügt Ihr Eindruck nicht, wenn es um die Nutzungsgewohnheiten im Hinblick auf Technische Dokumentation geht. Vor 30 Jahren waren Kunden noch froh, wenn dem Gerät eine Bedienungsanleitung als hektographiertes Skript beigelegt war; später musste es eine professionell gedruckte Anleitung sein, dann ein PDF, danach Anleitungen in HTML 5 und das Ganze selbstverständlich auch als Datenmaterial im Webshop.

Und heute? Heute gibt es fast nichts mehr was es nicht gibt. Videoanleitungen, mobile Anwendungen, Augmented Reality ... PDF oder Druck muss aus rechtlichen Gründen aber auch weiterhin sein. Die Welt der Technischen Dokumentation wird tatsächlich immer komplexer.

Wie gut, dass es Dinge gibt, die die Technische Redaktion einfacher machen. Zum Beispiel ein XML-basiertes Redaktionssystem (CCMS) wie SCHEMA ST4.

Schon gewusst...?

Manchmal ist das Format durch die verwendete Bearbeitungssoftware bedingt, z. B. Word-, FrameMaker oder InDesign-Dateien. Manchmal bleiben die Werkzeuge gleich, aber die Versionen ändern sich. Manchmal ist das Format durch die Zielplattform gegeben, z. B. HTML für Internetanwendungen. Manchmal wird die Komplexität durch verschiedene Darstellungswerkzeuge verursacht, beispielsweise durch HTML-Code für verschiedene Browser oder für mobile Geräte.

Betrachtet man Technische Dokumentation aus dem Blickwinkel der Zielformate heraus, dann herrscht eine verwirrende Vielfalt. Allerdings liegt diesen vielen verschiedenen Formaten in fast allen Fällen XML zugrunde. Das heißt: Fast beliebige Zielformate lassen sich mit den richtigen Arbeitsschritten aus einem wohl-definierten XML-Bestand heraus erzeugen.

Was macht Zielformate in der Technischen Dokumentation so kompliziert?

Was macht Zielformate in der Technischen Dokumentation so kompliziert?

Zwei Hauptursachen machen Zielformate in der Technischen Dokumentation zu einer Herausforderung:

  • Oft reicht ein Zielformat für Technische Dokumentation nicht aus. Multi-Channel Strategien sind heute die Normalität. Das heißt, dieselbe Anleitung soll gleichzeitig auf verschiedenen Kanälen – z. B. gedruckt, digital, online und mobil – für die Nutzer und Nutzerinnen bereitstehen. Denn je nach Nutzungssituation unterscheiden sich auch die Vorlieben.
  • Auch wenn nicht die kompletten Anleitungen in mehreren Zielformaten erzeugt werden sollen, werden manchmal Varianten und Teile derselben Anleitung in weiteren Zielformaten benötigt, z. B. der Produktüberblick für den Webshop oder eine Störungstabelle für das Gefahrenhandbuch.
Die Lösung: SCHEMA ST4

Die Lösung: SCHEMA ST4

Solche Anforderungen lassen sich mit SCHEMA ST4, einem medienneutralen XML-Redaktionssystem, leicht abdecken. 

SCHEMA ST4 teilt Inhalte in einzelne Module auf, die es medienneutral als XML-Daten verwaltet. Dies hat zwei Vorteile:  

  1. Die Module lassen sich beliebig kombinieren und wiederverwenden.  
  2. Aus den medienneutralen Bausteinen können beliebige Ausgabeformate erzeugt werden.  

Dies funktioniert durch die Dokumentbeschreibungssprache XML, die allen modernen Zielformaten (z. B. Word, HTML5, InDesign etc.) zugrunde liegt. Ähnlich wie bei Layouts muss der Ausgabemechanismus für ein Zielformat nur einmal definiert werden und kann dann für beliebige Inhalte verwendet werden. 

SCHEMA ST4 bietet verschiedene Mechanismen, die die Erzeugung von Zielformaten erleichtern. Schon nach der Installation sind einige Standardformate vorhanden. Diese lassen sich in Software-Modulen zur Layout- und Online-Entwicklung weiterbearbeiten. Auch die Erstellung komplett neuer Zielformate ist möglich, insbesondere wenn diese Zielformate XML-basiert sind. Außerdem bietet SCHEMA ST4 eine Reihe von Analyse- und Reporting-Funktionen, die den Überblick über die verwendeten Zielformate erleichtern und automatische Qualitätskontrollen des Outputs ermöglichen. 

Mit unserem XML-basierten Redaktionssystem SCHEMA ST4 sind Sie für zukünftige Wünsche an Zielformate gewappnet. Sei es, dass Sie einen bestehenden Output für ein Zielformat ändern wollen; sei es, dass Zielformate in neuen Versionen vorliegen, oder sei es, dass Sie völlig neue Zielformate benötigen – durch die Trennung von Layout, Strukur und Inhalt stehen Ihnen alle Optionen offen. Durch die Datenhaltung als XML ist sichergestellt, dass auch zukünftige Zielformate aus SCHEMA ST4 heraus erzeugt werden können. Denn XML ist die Basistechnologie, die allen modernen Zielformaten zugrunde liegt.  

  • Auswahl verschiedener Ausgabeformate im Publikationsassistenten:
    ⇒ Print-Formate (Word, PDF, FrameMaker, InDesign)
    ⇒ Web-Formate (HTML, HTML Help)
    ⇒ Spezialformate (z.B. iiRDS-konformes HTML für Portale oder kundenspezifische XML-Formate, z.B. DITA für den Daten-Upload in Drittsystemen)
  • Kombination von einem Format und verschiedenen Layouts (Standard + Kundenspezifische)
  • Wiederverwendung von Layouts für Publikationen eines Formats (Einhaltung des Corporate Designs)
  • Kundenspezifische Anpassungs- und Erweiterungsmöglichkeiten der Formate in den Layout-Werkzeugen (z.B. Verwendung der CI-Farbtabelle oder funktional durch JavaScript)
  • Erzeugung neuer Formate in den Layout-Werkzeugen (in der Vergangenheit z.B. ebook, JavaHelp, EclipseHelp)
SCHEMA ST4 in 25 Minuten

SCHEMA ST4 in 25 Minuten

Warum SCHEMA ST4 auch für Ihre Redaktion die richtige Wahl ist, erklärt Ihnen unser Experte Christoph Kaemena in diesem Video:

Haben wir Ihr Interesse geweckt?

Fragen Sie jetzt nach einer Demo von SCHEMA ST4. Unsere Berater sind gerne für Sie da!