Zum Hauptinhalt springen

Praxisbericht Software-Doku

Dauer und Art der Zusammenarbeit

Seit 2017 erstellen wir zusammen mit STRATEC SE die Anwenderdokumentation einer Internet-of-Things-Anwendung. Zu Projektbeginn verfassten wir die Dokumentation parallel zur Neuentwicklung des Systems und 2018 überarbeiteten wir die Online-Hilfe im Rahmen zweier Updates.

Projektziele

Ziel des Projekts war die Erstellung einer umfassenden Online-Hilfe, die dem Anwender alle benötigten Bedienungsinformationen bereitstellt.

Herausforderungen

In diesem Softwaredokumentationsprojekt wurde das bisherige Konzept für eine Online-Hilfe neu ausgerichtet und gezielt optimiert. Die vorhandenen Dokumentationsvorlagen und die Usability wurden für dieses Projekt untersucht, überarbeitet und auf die Anforderungen angepasst. Zudem wurden die verschiedenen Versionen der Software in Sprints entwickelt, weshalb der Dokumentationsprozess ebenfalls agil ablief. Da die Oberflächentexte des Systems in Englisch verfasst sind, musste die Online-Hilfe in englischer Sprache formuliert und eine einheitliche Terminologie etabliert werden. Aufgrund der Internationalität des Unternehmens fand der Informationsaustausch zwischen den Abteilungen sowohl auf Englisch als auch auf Deutsch statt.

Lösungen

Um diesen Herausforderungen gerecht zu werden, haben wir:

  • eng mit der Technischen Redaktion und der Software-Entwicklung von STRATEC SE zusammengearbeitet.
  • bestehende Dokumentationsvorlagen für Adobe FrameMaker für die Softwaredokumentation optimiert.
  • vor und während der Dokumentationserstellung Usability-Analysen des Systems durchgeführt und der Software-Entwicklung Feedback gegeben.
  • die anleitenden und beschreibenden Texte der Benutzeroberfläche überarbeitet.
  • ausgehend vom IBM Style Guide und dem Standard Simplified Technical English eine Terminologie für das Dokumentationsprojekt festgelegt.

Ergebnis

Die Software-Entwicklung hat ein benutzerfreundliches, selbsterklärendes System programmiert.

Die von uns verständlich formulierte und einheitlich gestaltete kontextsensitive Online-Hilfe versorgt den Nutzer gezielt mit allen Zusatzinformationen für seinen Anwendungsfall.