How to Create and Deliver Intelligent Information

Ein Kunde kam auf uns mit der Aufgabenstellung zu, die in MS Word erstellten Anleitungen Tablet-tauglich zu machen. Diese spannende Herausforderung und Umsetzung nahmen wir in Angriff.

Wünsch Dir was – die Aufgabenstellungen

  • Responsive Design
    (der Betriebsanleitung mit ca. 100 Seiten;
    Zeichnungen und Zulieferdokumentation werden als PDF eingepflegt)
  • Offline verfügbar
    (Doku wird in Bereichen verwendet, wo es keine Internetverbindung gibt)
  • Suchfunktion (Volltextsuche)
  • Einfache Navigation (vorwärts / rückwärts / Inhaltsverzeichnis)
  • Index und Glossar (später gestrichen wegen der Suchfunktion)
  • Hyperlinks zu PDF-Dateien (online und/oder offline abrufbar)

 

Die wesentliche Vorgabe lautete, dass die Kosten für die „serienmäßige“ Erstellung (inklusive Tablet) der elektronischen Dokumentation in etwa den Druckkosten entsprechen sollen. 

Via Adobe RoboHelp zum elektronischem Ausgabeformat

Für die Konvertierung von MS Word in das elektronische Format entschieden wir uns für Adobe RoboHelp, da RoboHelp unterschiedliche Ausgabeformate bietet: Responsive HTML5, Mobile App, Multiscreen HTML 5, WebHelp, eBook u.a. Eine alternative Lösung ist die freie Software Calibre, die allerdings auf EPUB beschränkt ist.

Von der sinnvolle Konvertierung bis zur Serienreife

Beim Import von MS Word in RoboHelp bestand die Herausforderung darin, dass sich die Word-Formatierung mit der „neuen“ Formatierung verträgt. Generell gilt: Weniger ist mehr und das saubere Arbeiten mit Absatzformaten ist Pflicht! Am effizientesten ist es, diese Anpassungen bereits in Word vorzunehmen.

  • Formatvorlagen auf die wichtigsten reduzieren.
  • Manuelle Seitenumbrüche entfernen und über Formatvorlagen definieren.
  • Für Tabellen Formatvorlagen einrichten, die genügend Abstand zum Rand vorsehen und fehlerbehaftete Tabstopps überflüssig machen.
  • Textrahmen auf Grafiken entfernen, da diese nicht übernommen werden. Texte in (interaktive) Positionen und erklärenden Tabellentext auflösen.
  • Grafiken, die direkt in Word erzeugt wurden (über die Funktion „Einfügen“ und „Formen“), werden nicht ü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 elektronischen Ausgabe möglichst gering zu halten.
  • Bei Tabellen und Grafiken ist die Bildschirmauflösung des Ausgabegeräts wesentlich.
  • Kontextsensitive Hilfemarkierungen von Links und Querverweisen bereits richtig einrichten.
  • Kopf- und Fußzeilen sowie Paginierungen löschen, da diese zwar übernommen werden, aber bei frei wählbaren Schriftgrößen und Seitenlayouts auf dem Tablet nicht viel Sinn machen. Impressum, Einleitung oder Rückseite dafür umfangreicher gestalten und z.B. um Anlagentyp, Versionsnummer usw. erweitern.

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

Die Qual der Wahl – so oder doch lieber anders?

Die wohl wesentlichste Erkenntnis aus dem Projekt war: Bei Projekten im Bereich mobile Dokumentation sind Kommunikation, Zusammenarbeit und klare Absprache enorm wichtig, da es keine generell gültigen Faustregeln gibt. Aufgrund der vielfältigen Möglichkeiten „verzettelt“ man sich leicht. So fiel das ursprünglich angedachte EPUB-Format schlussendlich durch, weil das Layout je nach gewähltem eReader anders interpretiert wird – der Einfluss des Layouters ist gering. Außerdem funktionieren Links zu extern eingebetteten PDF-Dateien nicht. Mit EPUB 3 werden sicher neue Möglichkeiten (wie die Einbettung von Film) eröffnet. Wir warten, was hier die Zukunft bringt.


Projektsieger Microsoft HTML Help

Schlussendlich konnte das proprietäre Format „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. Über externe Links können Zeichnungen und Zulieferdokumentationen, die als PDF-Dateien eingepflegt sind, in einem Popup-Fenster geöffnet werden. Der Zugriff funktioniert sowohl online als auch offline. Die Texte können ausgedruckt werden. Die Volltextsuche funktioniert mit booleschen Verknüpfungen und die Navigation ist übersichtlich gestaltet. Und das Beste zum Schluss: Das komprimierte Dateiformat ist auch für E-Books in Gebrauch.


 

Follow me

Like it? Share it! Spread the Word...