Dokumentation: dynamisch gewachsen

Der Umfang an Benutzerdokumentationen bei efcom hat sich in den vergangenen 10 Jahren verzehnfacht. Dahinter steckt die kontinuierliche (Weiter-)Entwicklung unserer Software-Features und Schnittstellen, die entsprechend auch dokumentiert werden müssen. Denn: Software-Hersteller sind in Deutschland gesetzlich dazu verpflichtet, ihre Produkte gegenüber Kund*innen zu dokumentieren. Es geht hier letztlich um Bereiche wie IT-Sicherheit, Verfügbarkeit und Datenschutz. Darüber hinaus zählt die Software-Dokumentation zur aktiv betriebenen Notfallvorsorge.

 

Wie hat alles angefangen mit der Dokumentation bei efcom? Anfangs wurde mit rudimentären Beschreibungen für einzelne Anwendungsbereiche gearbeitet. Mit zunehmender Komplexität der Software sowie steigender Kundenanzahl ist man schnell zu dem Entschluss gekommen: So kann es nicht weitegehen, wir müssen das Ganze weiter professionalisieren. Das war der Startschuss für den Aufbau unserer internen Dokumentationsabteilung, der mittlerweile drei kompetente Kolleginnen angehören. Zu ihren Aufgaben gehört nicht nur die fortwährende Aktualisierung und Erstellung der Benutzerdokumentation, sondern auch deren Übersetzung in mehrere Sprachen. „Mit der Internationalisierung unserer Produkte wurde die Übersetzung der Software sowie der dazugehörigen Dokumentation unabdinglich“, hebt Silvia Canales hervor.

 

Grundsätzlich besteht die Dokumentation bei efcom aus einer Online-Hilfe für alle Basisfunktionen und -definitionen, sowie zahlreichen Zusatzdokumentationen. Letztere umfassen detaillierte Beschreibungen von Sonder-Features und -Schnittstellen. Auf diese Weise können sich Benutzer*innen bequem und schnell selbst informieren, ohne in erster Linie den Support in Anspruch nehmen zu müssen. Letztlich ist es für Software-Unternehmen enorm wichtig, den Umfang an extern bereit gestellter Dokumentation in einem vernünftigen Rahmen zu halten – aus Gründen der Wirtschaftlichkeit, aber auch der Usability. Ein zu viel an Dokumentation kann sich schnell ins Gegenteil umkehren, wenn knappe Ressourcen zu sehr beansprucht und Nutzer*innen mit für den Alltagsbetrieb unnötigen Details „erschlagen“ werden. Ein zu wenig an Dokumentation kann wiederum – wie anfangs bereits beschrieben – gesetzliche Anforderungen unterwandern; außerdem wird sich kein Kunde auf eine unzulängliche Dokumentation einlassen.

 

Was macht eine gute Dokumentation aus? „Neben einer aussagekräftigen Hinleitung zum Thema sollte sie den Anwender befähigen, die Funktionalitäten der Anwendung sinnvoll einzurichten und im Tagesgeschäft anwenden zu können. Zudem wird auf verständliche und eindeutige Formulierungen geachtet, die wiederum zur einfachen Übersetzbarkeit beitragen,“ erläutert Isabel Palomino. Zur Erstellung dieser Art von Dokumentationen gibt es interne Richtlinien. Diese beinhalten u.a. Regelwerke, Vorlagen, Anleitungen und Checklisten, die allgemeine Gültigkeit haben und ständig aktualisiert werden. Für Übersetzungen gibt es zudem offizielle Glossare in den jeweiligen Sprachen. Letztere werden auch unseren Kund*innen in einer etwas abgespeckten Version zur Verfügung gestellt. „Wir arbeiten täglich an der Verbesserung der Dokumentation, um sie den sich stetig wandelnden Anforderungen anzupassen und die Bedürfnisse der Endanwender optimal zu berücksichtigen,“ verdeutlicht Petra Scheibel-Lang.