Neue Online-Hilfe für WERMA Signaltechnik

  • Home
  • Blog
  • Neue Online-Hilfe für WERMA Signaltechnik

Neue Online-Hilfe für WERMA Signaltechnik

, Kategorien: Dokuwerk: Success Stories Technische Dokumentation
Neue Online-Hilfe für die Systemsoftware Werma-WIN

 

Die Ausgangssituation und unsere Aufgabe

Um in produzierenden Unternehmen Prozesse effizienter zu machen, bietet WERMA Signaltechnik mit SmartMONITOR eine Lösung, die alle relevanten Daten sämtlicher Maschinen, Anlagen und manueller Arbeitsplätze auf Knopfdruck liefert. Neben der Hardware aus Funksendern und Funkempfängern spielt auch die mitgelieferte WIN-Software eine zentrale Rolle. Mithilfe der WIN-Software erhalten die Nutzer einen komfortablen Zugriff auf die erhobenen Daten, z. B. über eine Leitstand-Ansicht oder in Form von Analyse- und Reportingtools.

 

Für WERMA-WIN benötigte der Signalgerätehersteller eine Online-Hilfe, die die Installation und Bedienung der Software sowie die Konfiguration der zugehörigen Hardware beschreibt. Wir haben nicht nur das Konzept zur Online-Hilfe erstellt und umgesetzt, sondern für die Erstellung auch ein effizientes Tool ausgewählt.


Unser Vorgehen

Persönlicher Kontakt und verlässliche Planung

 

Gleich zum Projektstart konnten wir uns von den Vorteilen der Signalgeräte überzeugen. Denn WERMA setzt seine Signaltechnik am eigenen Produktionsstandort in Rietheim-Weilheim ein. Zum Recherchetermin gehörte auch eine umfassende Einführung in die Software. Erste wichtige Hinweise zur Erstellung und das weitere Vorgehen wurden im Briefing geklärt. Ein Basispaket der Hardwarekomponenten und die aktuelle Beta-Version der WERMA-WIN-Software wurden Dokuwerk ebenfalls zur Verfügung gestellt.

 

SmartMONITOR — Signalsäule und Hardware von Werma
SmartMONITOR - Signalsäule und Hardware von WERMA für die Maschinen-Daten-Erfassung über Funkverbindung

 

Schnelle Umsetzung mit MadCap Flare™


Bisher wurden alle technischen Dokumentationen in Microsoft Word erfasst und den Anwendern als PDF zum Download angeboten. Die Dokumentation zur WERMA-WIN-Software sollte zukünftig als Online-Hilfe auf der Firmenwebsite zur Verfügung gestellt werden. Die finale Lieferung aller Inhalte wurde daher im HTML-Format benötigt. Zur Prüfung der Dokumentation sollte ein Korrektur-PDF erstellt werden. Für die Erstellung der WERMA-Online-Hilfe haben wir ein effizientes und unkompliziertes Redaktionstool gewählt, mit dem die Inhalte medienneutral erfasst und sowohl für Print als auch für Webanwendungen publiziert werden können. Unsere Wahl fiel auf MadCap Flare™, ein file-basiertes Autorensystem, das diese Anforderungen erfüllt und keine spezielle IT-Infrastuktur erfordert.

 

Übersicht dank Topics


Bei der Erstellung der WERMA-Online-Hilfe haben wir besonders auf Übersichtlichkeit geachtet. Die Inhalte wurden zusammengefasst und behandeln jeweils ein in sich abgeschlossenes Thema (Topic). Der Benutzer soll die gesuchten Informationen einfach und schnell abrufen können. Ein topic-orientierter Aufbau unterstützt diesen Ansatz und spiegelt sich nun auch in der Navigation wider. Das Menü der WERMA-Online-Hilfe bildet das genaue Vorgehen von der Installation über die Inbetriebnahme bis zu den einzelnen Programmfunktionen ab. So wird der Benutzer Schritt für Schritt durch die Dokumentation geleitet.

 

Screenshot und Lupenansicht der WERMA Software-Navigation
Anwenderfreundliche Navigation: das übersichtliche Menü für schrittweises Vorgehen.

 

Gut platzierte Links im Text leiten den Benutzer zu weiterführenden Topics. Bei speziellen Fragen oder Systemstörungen helfen die Volltextsuche, das Kapitel "Fehlerdiagnose" und die FAQs. Letztere setzen sich aus Dropdown-Elementen zusammen für eine schnelle Übersicht und Auswahl der häufigsten Fragen.

 

Obwohl die Online-Hilfe nicht in die Software integriert ist, sind alle Schritte verständlich und nachvollziehbar erklärt. Dafür sorgen auch ausgewählte Screenshots. Parallel zur Inbetriebnahme kann der Nutzer die einzelnen Aktionen mühelos bis zur erfolgreichen Konfiguration der WIN-Geräte nachverfolgen.

 

Screenshots des Installationsassisten der WERMA Software
Einzelne Screenshots des Installationsassistenten ergänzen die Anleitung.

Nutzen für WERMA

Wir bei Dokuwerk nehmen die Perspektive des Benutzers ein, wenn wir technische Dokumentationen verfassen. Die Online-Hilfe zur WIN-Software bietet einen übersichtlichen Aufbau für eine schnelle Inbetriebnahme des Systems. Eine konsistente Wortwahl und ein einheitlicher Schreibstil gehören für uns ebenfalls zu einer guten und verständlichen Dokumentation. Unsere Expertise für professionelle und anwenderfreundliche Texte zeigt sich nun auch in der hohen Qualität der WERMA-Online-Hilfe.

 

Überzeugend: Effiziente Arbeitsweise und Full-Service

 

Neben der redaktionellen Unterstützung nutzte WERMA auch unsere Übersetzungsdienstleistungen. Technische Redaktion und Übersetzungsmanagement arbeiten bei Dokuwerk eng zusammen. Die Übersetzung der Online-Hilfe in die Sprachen Englisch und Französisch haben wir sehr gern übernommen. Nur zwei Monate nach Projektstart wurden die finalen Inhalte inklusive Übersetzung an WERMA geliefert. Damit haben wir WERMA als Dokumentationsspezialist überzeugt. Ein weiteres Projekt ist schon in Sicht: die Erstellung der Online-Hilfe für den StockSAVER — ein System zur Optimierung der Materialanforderung in der Produktionslogistik. Unser Signal steht dafür schon auf grün.


Unser Kunde

 

WERMA Signaltechnik GmbH + Co. KG ist ein weltweit wachsendes Unternehmen mit mehr als 330 Mitarbeitern an 7 Standorten. Auf dem Gebiet der Signaltechnik zählt das Familienunternehmen zu den Weltmarktführern. Mit modularen Signalsäulen hat das Unternehmen einen Industriestandard etabliert. Heute liefert WERMA optische und akustische Signalgeräte sowie verwandte Systeme zur Prozessoptimierung für die Industrie und Logistik.