SBM Mineral Processing trat an text‐it als Full Service Outsourcing Partner rund um die Technische Produktdokumentation mit der Aufgabenstellung heran, die in MS Word erstellten Anleitungen Tablet‐tauglich zu machen. Ein rundum spannendes Projekt mit einigen Aha-Erlebnissen.

Das österreichische Traditionsunternehmen SBM Mineral Processing GmbH ist einer der führenden Komplettanbieter von Aufbereitungs‐ und Förderanlagen für die Rohstoff‐ und Recyclingindustrie und von Betonmischanlagen für Transport‐ und Werksbeton.

Ausgangssituation

Bisher werden die Anleitungen für die Großanlagen der Firma SBM Mineral Processing ohne Redaktionssystem in MS Word erstellt und gemäß den vertraglichen Vereinbarungen ein‐ und mehrsprachig in Papierform und als PDF auf CD‐ROM an die Kunden ausgeliefert. Gedruckt werden die Anleitungen in einer Druckerei.

Änderungen an der Dokumentation werden den Kunden – je nach Umfang – als Einzelseiten zum Austauschen geschickt oder die Anleitung wird völlig neu ausgedruckt zur Verfügung gestellt. Dieses Änderungsmanagement ist fehleranfällig und mit Aufwand verbunden beziehungsweise zeitintensiv, vor allem wenn die Anlagen ins Ausland gehen.

Zukunftsmusik

Um die (implizite) Anforderung der Maschinenrichtlinie zu erfüllen, wird weiterhin ein Satz der Projektdokumentation in Papierform geliefert. Darüber hinaus soll es die Anleitung auf Wunsch auch in mobiler Form geben. Das heißt, der Kunde entscheidet bei Bestellung, ob er die Dokumentation ausschließlich auf Papier haben möchte oder zu einem attraktiven Aufpreis auch elektronisch am Tablet. Updates werden zum Download bereitgestellt – ein oder mehrsprachig – ohne Zettelwirtschaft und Ordnerchaos. Einfach, praktisch und zeitnah. Außerdem soll die E‐Doku als smarte Unterstützung für den Vertrieb dienen und den SBM Servicetechnikern die Wartung unterschiedlicher Typen weltweit erleichtern.

Wünsch Dir was – die Aufgabenstellung

Ziel von SBM Mineral Processing war es, die in MS Word erstellten Anleitungen Tablet‐tauglich zu machen. Und dies nachhaltig, sodass künftige Projekte mit möglichst geringem Mehraufwand „konvertiert“ werden können. Die Kunden sollten durch einen moderaten Preis und bessere Funktionalität auf die Papierausgabe verzichten und lieber zum Tablet greifen. Ohne Redaktionssystem eine sportliche Vorgabe!

Folgende Punkte standen auf der Wunschliste:

• Responsive Design (der Anleitung; Zeichnungen, Zulieferdoku usw. werden als PDF eingepflegt)
• Offline verfügbar — die Doku wird auch in (Außen‐)Bereichen verwendet, wo es keine oder eine nur unzureichende Internetverbindung gibt
• Suchfunktion (Volltextsuche)
• Einfache Navigation (vorwärts / rückwärts / Inhaltsverzeichnis)
• Index und Glossar (später gestrichen wegen der Suchfunktion)
• Hyperlinks (online und/oder offline abrufbar)
• Einbindung von Film (kam erst später im Projektverlauf auf)
• Möglichkeit, die Anleitung auszudrucken

Die Entscheidung für das „perfekte“ Ausgabeformat

Beim Kick‐off Meeting legten wir gemeinsam fest, in Richtung EPUB zu gehen, um die Hauptanforderungen „offline“ und „responsive“ zu erfüllen. Außerdem ist das EPUB‐Format standardisiert, offen zugänglich und kann von den meisten Geräten gelesen werden. Wichtig war auch die langfristige Verfügbarkeit. Warum dann letztendlich eine Microsoft HTML Help daraus wurde? Lesen Sie weiter!

MS‐Word via Adobe RoboHelp zu elektronischem Ausgabeformat

Für die Konvertierung von MS Word verwendeten wir Adobe RoboHelp, da damit eine Bandbreite an unterschiedlichen Ausgabeformaten gegeben ist: Man kann zwischen „Responsive HTML5“, „Mobile App“, Multiscreen HTML 5“, „WebHelp“, „eBook“ u.a. wählen. Eine alternative Lösung ist die freie Software Calibre, die allerdings vorwiegend auf EPUB beschränkt ist.

Vorbereitung – Konvertierung – Serienreife

Beim Import von MS Word in RoboHelp besteht die Herausforderung darin, dass sich die Word‐Formatierung mit der „neuen“ Formatierung verträgt. Probleme bereiten hierbei vor allem Tabellen, händisch formatierte Abschnitte und Grafiken. Generell gilt: Weniger ist mehr und das saubere Arbeiten mit Absatzformaten ist Pflicht! Am effizientesten ist es, diese Anpassungen bereits im Word‐File vorzunehmen.

So auch bei diesem Projekt. Vor dem Import in RoboHelp waren einige Änderungen an der Word‐Ausgangsdatei notwendig:

• Formatvorlagen auf die wichtigsten reduzieren. EPUB ist primär für die Darstellung von Fließtext konzipiert. EPUB 3 bietet zwar schon mehr Möglichkeiten des fortgeschrittenen Online‐Layoutings, dennoch ist die optimale Lesbarkeit bei eBooks vor allem dann gegeben, wenn der Fokus auf einem übersichtlichen Layout liegt.
• Manuelle Seitenumbrüche und Soft‐/Hard‐Returns entfernen und über Formatvorlagen definieren.
• Für Tabellen eigene Formatvorlagen einrichten, die genügend Abstand zum Rand vorsehen und fehlerbehaftete Tabstopps überflüssig machen. Für die endgültige Lösung ist die Bildschirmauflösung des Ausgabegerätes wesentlich.
• Textrahmen bei Grafiken entfernen, da diese nicht übernommen werden. Texte direkt in die Grafiken einarbeiten oder in Positionen und erklärenden Tabellentext auflösen. Zweiteres ist sicher vorzuziehen, da Texte in Grafiken nicht übersetzungsgerecht sind.
• Grafiken, die direkt in Word erzeugt wurden (z.B. über die Funktion „Einfügen“ und „Formen“), werden nicht in das eBook übernommen und müssen neu erstellt werden.
• Grafiken in der benötigten Größe anlegen und darauf achten, dass sie nicht zu groß sind, um die Dateigröße der möglichst gering zu halten.
• Kontextsensitive Hilfemarkierungen von Links und Querverweisen bereits in MS Word richtig einrichten.
• Kopf‐ und Fußzeilen sowie Paginierungen löschen, da diese zwar übernommen werden können, aber bei frei wählbaren Schriftgrößen und Seitenlayouts auf dem Tablet wenig Sinn machen. Impressum, Einleitung oder Rückseite dafür umfangreicher gestalten und um die Daten aus Kopf- und Fußzeile erweitern.

Die Nachbearbeitungen in RoboHelp werden so auf ein Minimum reduziert. Für weitere Projekte mit gleich eingerichteten Ausgangsdateien kann man die Importeinstellung und CSS für die spätere Verwendung speichern.

Kommunikation – der Eckpfeiler zum mobilen Erfolg

Nicht spezifiziert bei Projektstart war das Ausgabegerät: Es sollte ein möglichst günstiges Tablet sein, um den Preis für den Kunden moderat zu halten und so den Anreiz für die mobile Version zu steigern. Außerdem sollte es im Außeneinsatz bei Staub und Sonnenlicht sowie mit schmutzigen Händen verwendbar sein. Zwei Anforderungen, die schwierig unter einen Hut zu bringen sind. Letztendlich entschied sich SBM für den moderaten Preis mit einem 8 Zoll Tablet und Betriebssystem Windows 10, da die IT der meisten Kunden Windows-basiert ist. Ob dieses Test‐Tablet die Endlösung bleibt, wird firmenintern noch evaluiert.

Die fehlende Spezifikation des Ausgabegerätes und die Bildschirmauflösung machten einige zusätzliche Arbeitsschritte notwendig, vor allem in punkto Grafiken und Tabellen sowie Anpassungen an den entsprechenden Reader. Generell festgehalten werden kann: Mit dem Reader steht und fällt ein eBook‐Projekt. Wir haben zahlreiche Reader – meist mit wenig Erfolg – getestet. Die Darstellungsmöglichkeiten lassen zu wünschen übrig. Die meisten Reader sind für Funktionalität und Fließtext konzipiert und nicht für Layout und Grafik. Wichtig ist, den geeigneten Reader möglichst früh im Projektverlauf festzulegen und das EPUB dafür auszulegen.

Während der Projektlaufzeit kam der Wunsch seitens SMB auf, Filme (z.B. Wartungsfilme) abspielen zu können. Damit war EPUB 2 gestorben und wir mussten auf EPUB 3 umsatteln. Die Video‐ Funktionalität von EPUB 3 ist noch jung. Bei Tests konnten wir Videos auf iOS‐Geräten (mittels der integrierten App iBooks) abspielen. Auch für Android gibt es entsprechende Unterstützung, keinen Erfolg konnten wir jedoch unter Windows erzielen. Letztendlich wurde das Thema Film auch aufgrund der Dateigrößen und den damit verbundenen Komprimierungsaufwänden auf andere Ausgabekanäle verschoben.

Die Qual der Wahl – so oder doch lieber anders?

Die wohl wesentlichste Erkenntnis aus dem Projekt: Bei Projekten im Bereich mobile Dokumentation sind die Faktoren Kommunikation, Zusammenarbeit und klare Absprache enorm wichtig, da es keine generell gültigen Faustregeln und keine allumfassenden Erfahrungswerte gibt. Aufgrund der vielfältigen Möglichkeiten „verzettelt“ man sich leicht. So fiel das EPUB‐Format bei diesem Projekt schlussendlich aus folgenden Überlegungen durch:

• Reader‐Problem
  EPUB‐Texte und Bilder werden auf jedem eReader anders umgebrochen. Der Einfluss des Layouters ist gering. Dafür bleibt der Text auch auf kleinen Displays lesbar, was bei PDF nicht gesichert ist bzw. den Anwender zu ständiger manueller Vergrößerung des Ausschnitts zwingt. Der Leser kann die Schriftgröße nach eigenen Bedürfnissen einstellen. Als Reader für Windows empfehlen wir den Book Bazaar Reader, da diese App auch vorlesen kann und in der Layout-Darstellung gut funktioniert. Außerdem lässt es die App bei den Texteinstellungen zu, die Quelle beizubehalten, sodass man layouttechnisch gute Erfolge erzielt.

• Verlinkung auf externe Dokumente (z.B. Zulieferdokumente)
  Im Container EPUB sind zwar die PDF‐Dateien der Links enthalten, aber bei der Konvertierung gehen die Links leider verloren. Dieses Feature funktioniert auch in EPUB 3 noch nicht so richtig und wir müssen warten, was die Zukunft bringt. Eine Möglichkeit ist, auf die PDF‐Dateien als Internet‐Link zu referenzieren. Dafür müssen die Dateien auf einer Website hinterlegt werden, auf die nur online zugegriffen werden kann.

Als Sieger geht die Microsoft HTML Help hervor

Und gerade in diesen Punkten konnte das proprietäre Format für Online‐Hilfen „Microsoft HTML Help“ überzeugen. Ähnlich wie EPUB ist das CHM‐Dateiformat ein Containerformat. Es wurde von Microsoft entwickelt und mit Windows 98 freigegeben, erlebte darauf die weiteste Verbreitung und wird bis heute genutzt. Hier funktionieren die externen Links zu den PDF‐Dateien (als Popup‐Fenster). Der Zugriff funktioniert sowohl online als auch offline. Über den Button Drucken können die Texte ausgedruckt werden. Die Volltextsuche funktioniert mit boolschen Verknüpfungen und die Navigation ist einfach und übersichtlich gestaltet. Und das Beste zum Schluss: Das komprimierte Dateiformat ist auch für E‐Books in Gebrauch und funktioniert auf einem Windows Tablet.

Zusammenfassung

Es werden noch kleinere Nacharbeiten bzw. Vorarbeiten der MS Word‐Dateien notwendig sein, damit die Konvertierung künftig reibungslos verläuft und somit reif für die Serienproduktion wird. Dann stellt die mobile Anleitung eine ernstzunehmende Konkurrenz zu den Druckanleitungen dar.