Wir erstellen Softwareanleitungen und Online-Help-Systeme für die verschiedensten Applikationen. Auf aussagekräftige Screenshots und die konsistente Verwendung der Softwarebegriffe legen wir besonderen Wert.
Alma Gnani
Technische Dokumentation
Im Vergleich zu klassischen Betriebsanleitungen ist bei Softwareanleitungen der Einsatz von Screenshots oft eine der grössten Herausforderungen. Aufgrund der ständigen Weiterentwicklung der Software sind Screenshots nach dem Einfügen in die Dokumentation teilweise schon veraltet. Andererseits sind rein textbasierte Beschreibungen mühsam zu lesen und schwer verständlich. Wir versuchen hier einen gangbaren Mittelweg zu finden. Zusätzlich zeichnen wir über Screenrecording-Tools kurze Sequenzen der Softwarebedienung auf und fügen diese Videos als animierte Screenshots in die Dokumentation ein. Das erhöht das Verständnis und sorgt für angenehme Abwechslung in den Beschreibungen.
Screenshots zu erstellen bedeutet einen erheblichen Arbeitsaufwand, der sich mit jeder zusätzlichen Sprache verdoppelt. Oft ist es auch schwierig, alle Software-Zustände über die Simulationssoftware richtig darzustellen. Bei der Publikationen vieler Sprachen reduzieren wir deshalb den Aufwand durch Anreichern der englischen Screenshots mit Positionsnummern und Bildlegenden.
Die Softwareanleitung kann als Online-Help in die Steuerungsoberfläche Ihrer Maschine integriert werden. Durch das Verknüpfen von Topic-IDs wird beim Drücken eines Help-Buttons oder der F1-Taste automatisch das zugehörige Thema in der Online-Help aufgerufen (kontextsensitive Integration). Das ist ein echter Mehrwert für das Bedienpersonal und erleichtert die Problembehebung erheblich.