Handbuch und Online-Hilfe aus einer Quelle

Viele Unternehmen und Redaktionsteams wollen Ihren Aufwand bei der Dokumentationserstellung verringern. Single Source Publishing ist das Zauberwort.

Die Möglichkeit Handbuch, F1-Hilfe oder Online-Hilfe aus einer Quelle zu generieren ist sehr verlockend.

Die Vorteile von Single Source Publishing liegen auf der Hand.
Aus einer Datenquelle generieren Sie auf Knopfdruck die gewünschten Ausgabeformate. Das heißt auch, Inhalte werden nur an einer Stelle erstellt und gepflegt und alle Ausgabeformate haben im Handumdrehen den aktuellsten Stand.

So helfen Ihren Kunden genau dort wo er gerade nach Antworten sucht, im ausgedruckten Handbuch, als PDF oder per F1-Hilfe direkt an der Maschine oder in der Software.

Tools für Single Source Publishing (z. B. Robohelp, Doc2Help, viele Redaktionssysteme, Help & Manual oder HTML Help Workshop) gibt es viele und je nach Anforderungskatalog kristallisiert sich das passende Tool für Ihre Redaktion heraus.

Tipps zur Auswahl finden Sie auch in unserem Blog-Artikel Tipps für die Auswahl des passenden Redaktionssystems.

Sie wollen Ihre Anleitung vom Papier in Ihre Software integrieren können?

Lassen Sie sich von uns unabhängig über die Möglichkeiten und Tools beraten.

Angebot noch heute anfordern
oder unter +49 9126 2611-10 beraten lassen

Umstellung auf Single Source Publishing

Die Umstellung auf Single Source Publishing erfordert in Ihrer Redaktion einige Anpassungen, damit das reibungslos läuft.

Erste Überlegung sollte sich darum drehen, welche Ausgabeformate und Exportfunktionen (PDF, HTML, F1-Hilfe, epub, etc.) Sie benötigen und welche Schnittstellen zu anderen Systemen (z. B. zur Maschinensteuerung) berücksichtigt werden müssen.

Anschließend muss ein klares Konzept für die Dokumentation Ihres Produktes festgelegt werden. Behalten Sie dabei immer im Hinterkopf, der Aufbau der Inhalte muss ggf. komplett umstrukturiert werden. Da die Inhalte nicht mehr linear nach Kapiteln abgearbeitet, sondern thematisch nach Topics oder Modulen aufgesplittet werden.

Folgende Punkte müssen Sie dabei berücksichtigen:

  • Inhalt nach Topics / Modulen kategorisieren
  • Identifizierung der Inhalte, die immer gleich sind und wiederverwendet werden können
  • Umgang mit Variablen, Feldern etc.
  • Zielgruppen für die Topics / Modulen identifizieren
  • Umgang mit Bildern und Dokumenten, Ablageprinzip, Formate Aktualisierungsmanagement
  • Screenshots - Erstellung, Beschreibung und Implementierung, Aktualisierungsmanagement
  • Umgang mit Fremdsprachen und Kommunikation mit dem Übersetzer definieren
  • Umgang mit Verlinkungen und Verweisen
  • Handlungen und Funktionen anhand von Use Cases erklären
  • Review- und Lektoratsprozess
  • Verwendung einheitlicher Terminologie

Binden Sie hierbei auch aktiv Ihr Redaktionsteam ein, welches durch das Tagesgeschäft einen etwas anderen, praktischeren Blick auf den Prozess hat sowie Ihr IT-Technik-Team. So können Sie in einem Schritt Probleme verhindern und Verbesserungen Ihres Teams einbinden.

Tipps zur Umsetzung

Wenn das Konzept steht, geht es an die Umsetzung. Dabei sollten Sie genügend zeitliche und personelle Ressourcen zur Verfügung stellen.

Zuerst wird die Struktur bzw. Gliederung der Topics / Module angelegt und die Layouts der einzelnen Ausgabeformate definiert und erstellt.

Anschließend beginnt Ihr Redaktionsteam die Inhalte zu befüllen.
Vorab sollte das Redaktionsteam eine umfassende Einführung / Schulung zur Handhabung des Single Source Publishing-Tools erhalten. Des Weiteren sollten Sie einen einheitlichen Schreibstil, Redaktionsprozess und Zuständigkeiten festlegen sowie die dokumentenübergreifende Terminologie definieren.

So stellen Sie sicher, dass effizient gearbeitet werden kann und alle Inhalte wie aus einem Guss erscheinen und zum gedruckten Handbuch als auch zur Online-Hilfe passen.

Wenn dann endlich alles steht, können Sie von den Vorteilen des Single Source Publishings profitieren und sparen Geld, Aufwand und doppelte Arbeit.

Sie wollen von Word weg und Single Source Publishing klingt für Sie nach einer guten Lösung?

Wir sagen Ihnen, wie Sie die Informationen zu Ihrem Produkt am besten für Ihren Kunden aufbereiten können.

Angebot noch heute anfordern
oder unter +49 9126 2611-10 beraten lassen