Funktionelle Apps in der Energiebranche

Mithilfe neuester Servertechnologien ist es möglich, die Datentransferübertragung direkt in die mobile Technische Dokumentation zu integrieren. Auf diese Weise ist sie jederzeit abrufbar und macht zusätzliche Programme oder Geräte überflüssig. In der praktischen Anwendung erleichtert die Integration des aktuellen Zählerstandes die Arbeit von Technikern und Ingenieuren enorm. Die Flexibilität wird deutlich erhöht, was nicht nur die Arbeitsabläufe beschleunigt, sondern auch Kosten spart.

Lesen Sie dazu auch:

• Von der Online-Hilfe zur App
• Funktionelle Eigenschaften mobiler Online-Hilfen

Darüber hinaus verfügt WebWorks ePublisher 2012.1 über eine Vorschaufunktion, die eine Voransicht des definierten Stationerys in ePublisher Designer ermöglicht. Mithilfe dieser Preview lassen sich Änderungen und Anpassungen im CSS bereits vor der Publikation vornehmen, wodurch sich eventuelle Nacharbeiten erübrigen.

Mit den zusätzlichen Verbesserungen des Ausgabeformats WebWorks REVERB wurde die integrierte Multiscreen-Technik weiter optimiert. REVERB passt sich den verschiedenen Displays problemlos an, seien es Smartphones, Tablet- oder Desktop-PCs.

Einen Überblick über alle Neuerungen, die in WebWorks ePublisher 2012.1 enthalten sind, finden Sie hier. Um zu unseren Produktseiten zu gelangen, auf denen Sie unter anderem einige Anwendungsbeispiele finden, klicken Sie hier.

Haben Sie weitere Fragen zu den vielfältigen Möglichkeiten des WebWorks ePublisher oder speziell zu diesem Release? Dann schreiben Sie uns einfach eine E-Mail an kontakt@squidds.de oder rufen Sie uns an unter 0911 / 21 53 47-0.

Aufgrund der starken visuellen Prägung von sozialen Netzwerken und Videoplattformen, haben sich die Gewohnheiten der Nutzer inzwischen generationenübergreifend geändert. Die junge Generation legt Wert auf schnelle Abrufbarkeit, während ältere Menschen mitunter die leichte Anpassung von Schriftgrößen und ähnlichem zu schätzen wissen. In jedem Fall sind Online-Inhalte sehr gefragt:

Quelle: Temple, Krystal: What Happens in an Internet Minute?, InsideScoop

Die Verlagerung der Schwerpunktsetzung auf multimediale Elemente innerhalb der Technischen Kommunikation bedeutet jedoch nicht, dass Print- und PDF-Dokumentationen unnötig sind. Doch der Schreibstil passt sich an, sodass reine Textdokumentationen eher eine Seltenheit werden.

7. Soziale Interaktion – Kundenkontakt und Feedback von Nutzern

Social-Media-Networks oder soziale Plattformen haben die Kommunikation zwischen Anwendern und Herstellern enorm gefördert. Ob man einen Kommentar in einem Blog hinterlässt, einen Beitrag bewertet oder selbst aktiv das eigene Wissen in Foren bereitstellt: Es gelten die Prinzipien Partizipation und Dynamik. Daher ist es gleichermaßen im Sinne von Herstellern und Nutzern, Dokumentationen zu entwickeln, die direkte Rückmeldungen ermöglichen. Im Format AdobeAIR ist dies bereits berücksichtigt.

8. Die wachsende Rolle der Bericht- und Analysefunktionen

Ähnlich wie die Analyse von Webseiten im Hinblick auf die Suchmaschinenoptimierung (SEO) bei der Positionierung der Unternehmensseiten eine große Rolle spielt, ist es wichtig, zu wissen, welche Inhalte der Anwender in Dokumentationen sucht. Es ist allgemein bekannt, dass man nur diejenigen Stellen in einer Dokumentation liest oder sucht, die man tatsächlich benötigt. Online-Hilfen, wie sie z.B. mit RoboHelp publiziert werden können, bieten mit Suchfunktionen und übersichtlichen Inhaltsverzeichnissen eine hohe Nutzerfreundlichkeit. Mithilfe von Analysen lassen sich Dokumentationen erstellen, die sich in erster Linie an den Anwendern orientieren.

9. Spezialisierung oder Vielfalt?

Die Veränderungen in der Technischen Kommunikation wirken sich auch auf die in diesem Bereich Tätigen aus. Natürlich gibt es noch Spezialisten, die ausschließlich als Technische Redakteure oder Grafiker arbeiten. Doch der Trend geht eindeutig zur Vielfalt, sodass die Arbeitsbereiche mitunter fließend ineinander übergehen. Daher müssen sich heutige Technische Redakteure auch mit multimedialen Aspekten auseinandersetzen und diese sinnvoll anwenden. Diesen Ansprüchen an eine komplexe Technische Kommunikation wird unter anderem die Technical Communication Suite gerecht, die mit vielseitigen Funktionen und Arbeitsbereichen aufwartet.

10. Automatisierte Prozesse und effizientes kollaboratives Arbeiten

Die Möglichkeiten des Single-Source-Publishing, die oft mit der Verwendung von Content Management Systemen einhergeht, beschleunigt die Arbeitsabläufe enorm. So werden Dokumentationen nicht nur schneller erstellt, sondern können auch schneller geändert, angepasst und geliefert werden. Die einfache Erstellung von PDFs, die Möglichkeit, Kommentare einfach einzubinden etc. mithilfe verschiedener Adobe Produkte erleichtert die kollaborativen Arbeitsprozesse enorm.

Lesen Sie dazu auch den originalen Beitrag im Adobe TechComm Blog sowie folgende Beiträge:

• Anforderungen an die heutige Technische Dokumentation
• Veränderter Schreibstil in der mobilen Technischen Dokumentation

Strukturierte Dokumente bieten jede Menge Vorteile. Hier sind vor allem die Wiederverwendbarkeit von Inhalten und die damit verbundene Kostenreduktion zu nennen. Zudem ist es hinsichtlich der Lokalisierung von Dokumentationen einfacher, referenzierte und schon einmal übersetzte Inhalte mehrfach zu verwenden. In strukturierten Dokumenten gibt es  außerdem eine Trennung von Template und Formatierung, sodass ein automatisierter Workflow optimal unterstützt wird.

2. Verlagerung hin zu Single-Source-Publishing

Der Trend des Single-Source-Publishing wird von mehreren Seiten gefördert. Zu diesen zählen unter anderem Unternehmer, die ihre Dokumentationen in verschiedenen Ländern oder Kanälen sowie für verschiedene Zielgruppen bereitstellen möchten. Daher können Dokumentationen sowohl auf den Standort als auch auf die Zielgruppe Bezug nehmen.
Für die Dokumentverwaltung wäre es ein Desaster, wenn man für jede einzelne Ausgabemöglichkeit der Dokumentation separate Quelldateien benötigte. Die Verwendung von bedingten Ausdrücken und das CMS-orientierte Erstellen von Dokumentationen zielt jedoch eindeutig auf Single-Source-Publishing ab.

3. Einfache Darstellung komplexer Inhalte mithilfe von Rich-Media-Inhalten

Da viele Kunden oder Nutzer von Plattformen wie YouTube beeinflusst sind, legen sie Wert auf kompakte und immer verfügbare Anleitungen. Es mangelt den meisten Menschen, die in der von schnellen Medien geprägten Welt leben, an der nötigen Geduld oder Konzentration, um seitenlange Dokumentationen zu studieren.

Mit Video- oder Bildschirmsimulationen können jedoch auch sehr komplexe Inhalte dokumentiert werden, sei es im PDF- oder in einem Help-Format. Der Einsatz der Technical Communication Suite hat die  Verbreitung dieses Trends stark gefördert.

4. Bereitstellung mobiler Inhalte

In Anbetracht der Tatsache, dass inzwischen z.T. mehr eBooks als traditionelle Bücher verkauft werden und die Verkaufszahlen von Tablet-PCs und Smartphones diejenigen von Notebooks und Desktop-PCs übersteigen, lässt sich der mobile Trend nicht leugnen. Daher gilt es, den Kunden mittels der Bereitstellung mobiler Inhalte entsprechend entgegenzukommen.

Das Format ePUB wird vielen Ansprüchen einer gelungenen mobilen Dokumentation gerecht, vor allem hinsichtlich der dynamischen Größenanpassung von Grafiken. Mit der Technical Communication Suite lassen sich bereits bestehende Dokumentationen leicht in das Format ePUB umwandeln.

5. Erhöhte Nachfrage nach kontextsensitiven Hilfen

Mittlerweile werden Informationen und Dokumentationen auf sehr vielfältige Weise angeboten. Daher haben sich die meisten Nutzer bereits daran gewöhnt, mit ein paar gezielten Klicks die relevanten Informationen zu bekommen und alles andere auszublenden. Kontextsensitive Hilfen sind daher ein wichtiger Aspekt in der zukunftsorientierten Technischen Dokumentation. Obwohl diese beispielsweise mit der Technical Communication Suite optimal unterstützt wird, bedarf es doch cleverer Redakteure oder Autoren, die sich in die jeweiligen Zielgruppen hineinversetzen können.

Lesen Sie dazu auch den originalen Beitrag im Adobe TechComm Blog sowie folgende Beiträge:

• Anforderungen an die heutige Technische Dokumentation
• Veränderter Schreibstil in der mobilen Technischen Dokumentation 

Skalieren von Bildern in WebWorks ePublisherPro

1. Öffnen Sie Ihre Projektdatei (Stationery).
2. Wählen Sie aus dem Menü Ansicht den Menüpunkt Stil-Designer aus.
3. Wählen Sie anschließend im Menü Projekt ein Aktives Ziel aus.
4. Unter der Auswahl in Stil-Designer wählen Sie nun Grafikstile.
5. Im Reiter Optionen geben Sie in der Zeile Skala % die gewünschte Skalierung an.
6. Nach der Auswahl sind alle Bilder, die durch den gewählten Grafikstil definiert sind, entsprechend Ihrer Angaben skaliert.

Skalieren von Bildern in FrameMaker

In FrameMaker können Sie Ihre Bilder bereits während des Imports in ein Dokument oder anschließend über die Objekteigenschaften skalieren.

1. Wählen Sie unter dem Menü Datei den Punkt Importieren ->Datei…
2. Geben Sie nun den Dateipfad zu dem zu importierenden Bild an und klicken Sie auf den Button Importieren.
3. In dem sich öffnenden Dialogfenster wählen Sie die Skalierung des Bildes aus. Zudem ist es möglich, die Grafik direkt in einen zuvor festgelegten Rahmen einzupassen.
4. Klicken Sie auf Zuweisen. Die Grafik wird nun mit der gewünschten Skalierung importiert.

1. Klicken Sie mit der rechten Maustaste in die zu skalierende Grafik.
2. Wählen Sie aus dem Kontextmenü den Punkt Objekteigenschaften aus.
3. Geben Sie die gewünschten Einstellungen ein und klicken Sie auf Zuweisen.

Skalieren von Bildern in Finalyser

Bei den beiden genannten Möglichkeiten, Bilder in FrameMaker zu skalieren, werden bei der Eingabe absoluter Werte für Höhe oder Breite die Relationen nicht beibehalten. Diese Funktion bietet Ihnen jedoch Finalyser. Mit dem Plugin Importierte Grafik können Sie Ihre Bilder nicht nur skalieren, sondern auch in einen vorgegebenen Rahmen einpassen. So gehen Sie vor:

1. Wählen Sie die zu skalierende Datei an und wählen Sie aus dem Finalyser-Menü Importierte Grafik -> Skalieren…
2. In dem sich öffnenden Fenster können Sie zwischen Höhe, Breite und Rahmen wählen.
3. Wählen Sie Höhe oder Breite, werden Sie aufgefordert, eine Höhen- oder Breitenangabe in Millimeter anzugeben. Der jeweils andere Wert passt sich automatisch an.
4. Wählen Sie die Option Rahmen, werden die Maße der ausgewählten Grafik entsprechend eines festgelegten Rahmens angepasst.

Neben grundlegenden Fragen nach Navigationsfähigkeit, Flexibilität hinsichtlich der Gestaltung oder Anpassungsfähigkeit an verschiedene Ausgabegeräte und Plattformen, sind folgende Aspekte bei der Wahl des passenden Formats für die mobile Online-Hilfe von Bedeutung:

Rich-Media-Inhalte

Die Einbindung von Videos, Audiodateien oder 3D-Animationen wird in der Technischen Dokumentation zunehmend wichtiger. Daher sollte das gewählte Hilfe-Format verschiedene Rich-Media-Inhalte unterstützen.

Social-Media-Anbindung

Um die jeweilige Online-Hilfe wirklich nutzerfreundlich zu gestalten, ist der Dialog zwischen Hersteller und Kunden unabdingbar. Kommentarfunktionen wie DISQUS erleichtern es Nutzern, gezielte Anregungen zu geben oder Kritik zu äußern. Doch auch mit Buttons, wie sie unter anderem von Facebook und Twitter angeboten werden, ist ein kontextbezogenes Feedback möglich.

Update-Möglichkeiten

Zudem ist es vor allem bei umfangreichen Online-Hilfen notwendig, eine einfache Möglichkeit zu finden, um eventuelle Updates durchzuführen. Ein sogenannter Delta-Abgleich ist dabei sicher die beste Lösung, wenn es um die Reduzierung von Datenmengen geht. Dabei wird der aktuelle Stand der Online-Hilfe mit der jeweils aktualisierten Version verglichen, sodass nur die tatsächlich geänderten Dateien für das Update geladen werden.

Offline-Nutzung

Werden die Inhalte von mobilen Online-Hilfen als App bereitgestellt, ist zum Abruf der Daten im Allgemeinen eine Internetverbindung notwendig. Um auch bei nicht vorhandener Internetanbindung die Inhalte der Online-Hilfe jederzeit nutzen zu können, empfiehlt sich das Erstellen einer Offline-App.

Weitere Informationen zu diesem Thema finden Sie auch hier:

• Mobile Dokumentation: Formate im Vergleich
• Multichannel- und Multiscreen-Publishing
• Von der Online-Hilfe zur App

Aus FrameMaker heraus lassen sich zahlreiche Formate generieren. Diese können über die Funktion Veröffentlichen (Datei->Veröffentlichen) in vorher angelegte und definierte RoboHelp-Projekte publiziert werden.

RoboHelp Projekte lassen sich flexibel via RoboHelp HTML oder RoboHelp for Word erstellen. Die Vielfalt bei der Veröffentlichung ist auf bislang neun Formate (RoboHelp 9) beschränkt. Hinsichtlich der Eingabeformate sind unter anderem XML-, FrameMaker und Word-Dateien denkbar.

Den Ansprüchen der mobilen Dokumentation versucht RoboHelp vor allem mit den Formaten ePub und AIR gerecht zu werden. Aber auch Hilfeformate wie WebHelp oder OracleHelp werden unterstützt.

Mit WebWorks ePublisher

WebWorks ePublisher ist eine Software, die es ermöglicht, aus vorhandenen Quelldaten bis zu 15 Ausgabeformate zu publizieren. Neben Formaten wie ePub, WinHelp, OracleHelp, Wiki etc. bietet ePublisher die Formate WebWorks Help und WebWorks Reverb, die sich vor allem durch eine hohe Anpassungsfähigkeit an mobile Geräte auszeichnen.

In Anbetracht der zahlreichen Formate, kann dieses Schema (PDF) eine gute Orientierungshilfe sein, um herauszufinden, welches Format für die jeweiligen Ansprüche das richtige ist.

Hinsichtlich der Eingabeformate kann man bei WebWorks ePublisher unter anderem zwischen XML-, Word und FrameMaker-Dateien wählen. Darüber hinaus ist die Publikation von DITA-Dateien mit WebWorks ePublisher ohne die mitunter umständliche Installation des DITA Open Tool Kit und zusätzlicher Plugins kein Problem, da das OTK bereits in das Programm integriert ist.

Die Projekterstellung und –verwaltung erfolgt mit WebWorks über ePublisher Pro, mit dem auch das jeweilige Stationery für die Ausgaben erstellt wird.

Weitere Informationen finden Sie hier:

• Produktseite WebWorks ePublisher
• Produktseite Adobe RoboHelp
• Multichannel- und Multiscreen-Publishing

Online-Formate: Beispiele

ePUB

Das ePUB-Format eignet sich vor allem für die Multiscreen-Darstellung von reinem Text, wie beispielsweise in Romanen oder Schulbüchern. Die Einbindung von Grafiken oder Rich-Media-Inhalten ist ebenfalls möglich, allerdings ist die Einheitlichkeit einer optimalen Darstellung beispielsweise bei umfangreichen Tabellen oder komplexen Grafiken nicht immer gewährleistet. Das Format ePUB enthält eine Volltextsuche sowie Zusatzfunktionen wie die Anpassung von Schriftgrößen, Helligkeit oder das Einfügen von Lesezeichen.

Folio

Das Format Folio wird bereits als das „neue PDF“ betrachtet und bietet gegenüber dem herkömmlichen PDF zahlreiche Vorteile. Es eignet sich insbesondere für die mobile Ausgabe von Magazinen, Schulungsunterlagen, Handbüchern etc. Ein Nachteil ergibt sich aus dem Umstand, dass man für die Quer- und Hochformatansicht jeweils ein Layout bereitstellen muss. Das heißt, Folio ist über Umwege ein Multiscreen-Format, das sich den Anforderungen an Lesbarkeit und optimale Darstellung anpassen kann.

WebWorks REVERB

Mit dem Format WebWorks REVERB ist es nicht nötig, verschiedene Versionen der Eingabedaten aufzubereiten. Die Multiscreen-Technik wird standardmäßig angewandt. Darüber hinaus bietet WebWorks REVERB neben der Anbindung an Social-Media-Komponenten eine intelligente Volltextsuche, integrierte Kontextsensitivität sowie die Möglichkeit, Output-Projekte wie beispielsweise Online-Hilfen ohne großen Aufwand in Apps umzuwandeln. Diese Apps sind sowohl im Online- als auch im Offline-Format verfügbar.

Um mehr über mobile Technische Dokumentationen zu erfahren, besuchen Sie unseren Expertenvortrag auf der tekom Frühjahrstagung 2012!

Der Begriff des Multichannel-Publishing beschreibt die Möglichkeit, Inhalte in verschiedenen Publikationskanälen zur Verfügung zu stellen. Ein mögliches Beispiel ist die Veröffentlichung einer Technischen Dokumentation sowohl im Printformat als auch in Online-Versionen.

Da es entsprechend der Vielfalt an Publikationskanälen zahlreiche Ausgabeformate gibt, geht es bei einem sinnvollen Multichannel-Publishing vor allem um die Vereinfachung der notwendigen Arbeitsabläufe. Single-Source-Publishing ist der Schlüssel dafür.

Single-Source-Publishing heißt, aus einem zentralen Quelldatenbestand verschiedene Ausgabeformate zu generieren, ohne die Inhalte erst dem jeweiligen Publikationskanal anpassen zu müssen.

Die Vorteile des Multichannel-Publishing liegen auf der  Hand:

• Mehrfachverwendung von Inhalten
• Kostenreduktion
• geringerer Bearbeitungsaufwand
• hohe Reichweite durch die Nutzung zahlreicher Publikationskanäle
• u.v.m.

Um von Single-Source-Publishing zu profitieren, benötigt man eine passende Software-Lösung, die möglichst viele verschiedene Outputformate generieren kann. Für Nutzer der Technical Communication Suite steht dabei sicher zunächst RoboHelp im Vordergrund – mit RoboHelp (Version 9) lassen sich neun verschiedene Formate generieren.

Mit WebWorks ePublisher kann man sogar 15 unterschiedliche Formate erzeugen, wodurch das Multichannel-Publishing enorm erleichtert wird:

Multiscreen

Spricht man von Multiscreen-Lösungen oder Multiscreen-Publishing ist damit die Ausgabe digitaler Inhalte auf verschiedenen Geräten gemeint. Hier kommt den mobilen Geräten wie Smartphones und Tablets eine inzwischen enorme Bedeutung zu. Daher geht es beim Publizieren zunehmend darum, Formate zu nutzen, die unabhängig vom jeweiligen Ausgabegerät und der Größe des Displays eine optimale Ansicht und Anwenderfreundlichkeit bieten.

Dynamische Formate, die sich für die Ausgabe auf mobilen Geräten eignen, sind unter anderem:

• ePub
• WebWorks Reverb
• Adobe AIR
• HTML

Je nachdem, welche Art von Content man publizieren möchte, ist es sinnvoll, sich mit den Vor- und Nachteilen einzelner Formate zu befassen. So eignet sich ePub beispielsweise sehr gut für die Darstellung von Romanen oder anderen überwiegend textlichen Büchern. Für die Technische Dokumentation, in der eine Volltextsuche, Kontextsensitivität, die Einbindung von Grafiken und Multimedia-Inhalten sowie die Anbindung an soziale Netzwerke wichtige Aspekte sind, liegt man hingegen mit den Formaten REVERB oder AIR richtig.

Die Funktionen des Finalyser TERM CHECK lassen sich nach der Installation in Adobe InDesign unter Zusatzprogramme aufrufen. Hier hat man die Wahl zwischen Term mining, Term checking und Options.

Die Auswahlmöglichkeiten entsprechen denen in FrameMaker und Word, wodurch eine einfache programmübergreifende Handhabung des Plugins gesichert ist:

Term mining ermöglicht das automatische Auslesen verwendeter Wörter in eine XML-Datenbank. In dieser werden die ausgelesenen Terme (Undefineds) seitens eines Terminologen oder Redakteurs den Kategorien Dont’s, Terms, Abbreviations und Stop Words zugeordnet.

• Dont’s sind Begriffe, die in den bearbeiteten Texten nicht vorkommen dürfen.
• Terms sind Begriffe, deren Verwendung korrekt ist.
• Abbreviations sind im Text enthaltene Abkürzungen (z.B. Dateiendungen wie fm oder doc)
• Stop words sind Wörter, die hinsichtlich der terminologischen Korrektheit eines Textes keine Rolle spielen (z.B. Artikel wie der, die das)
• Undefineds sind ausgelesene Terme, die noch keiner der genannten Kategorien zugeordnet wurden.

Term checking prüft das jeweils aktive Dokument auf die verwendeten Terme und gleicht sie mit den Definitionen in der Datenbank ab.

In Options können Sie Datenbanken anlegen und verwalten. Zudem ist es hier möglich, Farbeinstellungen anzugeben, mit denen selbst bei umfangreichen Dokumenten eine hohe Übersichtlichkeit gewährleistet wird.

Weitere Informationen finden Sie auch auf folgenden Seiten:

• Finalyser TERM CHECK jetzt auch für MS Word
• Finalyser TERM CHECK – Übersicht der Grundfunktionen
• Produktseite Finalyser TERM CHECK