Melden Sie sich hier an, um auf Kommentare und die Whitepaper-Datenbank zugreifen zu können.

Kein Log-In? Dann jetzt kostenlos registrieren.

Falls Sie Ihr Passwort vergessen haben, können Sie es hier per E-Mail anfordern.

Der Zugang zur Reseller Only!-Community ist registrierten Fachhändlern, Systemhäusern und Dienstleistern vorbehalten.

Registrieren Sie sich hier, um Zugang zu diesem Bereich zu beantragen. Die Freigabe Ihres Zugangs erfolgt nach Prüfung Ihrer Anmeldung durch die Redaktion.

Ratgeber zu Software-Manuals

So erstellen Sie die perfekte Software-Bedienungsanleitung

Christa Weidner ist seit 1989 in unterschiedlichen Rollen und Positionen in der IT tätig. Das Ziel ihrer Arbeit ist es, dafür zu sorgen, dass die Mitarbeiter mit neuer Software arbeiten können und wollen. Ihre Fähigkeit, die richtigen Fragen zu stellen, schützt Entscheider, Projektleiter sowie weitere Schlüsselpositionen davor, falsche Entscheidungen zu treffen und hilft, die Potenziale der IT maximal auszunutzen. Sie unterstützt namhafte Konzerne und Unternehmen des Mittelstands unterschiedlicher Branchen. Im Juni 2016 hat die IT-Beraterin den  „Werner-Bonhoff-Preis-wider-den-§§-Dschungel 2016“ erhalten.
Das Bedienen von Software ist in den seltensten Fälle intuitiv und selbsterklärend. Software-Pakete enthalten eine Fülle an Funktionen, die den Anwender nicht selten überfordern. Eine gute Software-Dokumentation kann viele dieser Lücken schließen.

Leider haben nur wenige Projekte ein Augenmerk auf die Dokumentation, die sie bereitstellen. Sondern betrachten diese Aufgabe als lästiges Übel.
Bei den Anwendungen, welche die Geschäftsprozesse unterstützen, werden meist nur Teile der erworbenen oder gemieteten Software genutzt. Welche Prozesse, wann und in welcher Art und Weise abgebildet werden, ist von Unternehmen zu Unternehmen, von Bereich zu Bereich unterschiedlich.

Manche Software-Dokumentation hinterlässt bei den Anwendern mehr Fragezeichen als Erleichterung.
Manche Software-Dokumentation hinterlässt bei den Anwendern mehr Fragezeichen als Erleichterung.
Foto: Syda Productions - shutterstock.com

Wir alle wissen, dass ein Software-Projekt meist mit großen Zielen antritt, um dann Schritt für Schritt seinen Umfang (Scope) zu reduzieren. Was anfänglich noch logisch und strukturiert abgebildet wird, verliert mit zunehmender Komplexität und Anzahl an Prozess-Varianten an Logik. Da muss plötzlich hier eine Option aktiviert werden, die gar nicht zum Prozess passt; da tauchen inhaltlich gleiche Felder mit unterschiedlicher Benennung auf oder Feldnamen werden so benannt, dass der Anwender zweimal um die Ecke denken muss.

Wenn der Anwender 2 x um die Ecke denken muss

Da dies bei so ziemlich jeder Software-Einführung passiert, braucht es eine Lösung, die dem Anwender im Alltag hilft, sich zurecht zu finden. Wir sollten uns nicht alleine auf dessen Intuition verlassen, denn die würde viel zu oft die falsche Antwort liefern. Deshalb braucht es prozess-orientierte Bedienungsanleitungen, die Schritt für Schritt beschreiben, was zu tun ist.

Hier finden Sie sechs Tipps, die Sie beim Erstellen von anwendergerechter Dokumentation beherzigen sollten:

  • Sprechen Sie die Sprache der Anwender
    Raster, Grids, Multi-Value usw. sind Begriffe, die aus der IT kommen. Der Anwender denkt und spricht von Fenstern, Feldern, Zeilen und Auswahllisten. Sollten Sie diese IT-lastigen Begriffe dennoch verwenden wollen, sollten Sie gute und nachvollziehbare Gründe für diese Entscheidung haben. Dann sollten Sie diese Begriffe konsistent und konsequent benutzen. Ohne Ausnahme.
    Wir schreiben für unsere Anwender, nicht für uns selbst. Also müssen wir deren Sprache nutzen. Um die richtigen Begriffe finden zu wollen, hören Sie den Anwendern zu. Welche Anwendungen werden sonst noch benutzt und welche Begriffe werden dort bereits verwendet? Sie müssen das Rad nicht von vorne erfinden sondern, nutzen, wenn immer möglich schon etwas Vorhandenes. Stellen Sie ihrer Dokumentation ein Kapitel zur Begriffsklärung voran, um diese zu erläutern.

  • Schaffen Sie Vertrauen
    Stellen Sie sich vor, Sie haben sich einen neuen Fernseher gekauft. Ein tolles Gerät mit vielen Funktionen, auf die Sie ganz neugierig sind. Dem Gerät liegt eine mehrsprachige Bedienungsanleitung anbei. Sie finden die von Ihnen bevorzugte Sprache und folgen der Bedienungsanleitung gewissenhaft. Leider, ohne ans gewünschte Ziel zu kommen. Das Gerät funktioniert nicht so, wie es beschrieben ist. Sie vergeuden wertvolle Zeit, werden wütend, verlieren die Lust und fragen sich, ob das Gerät genauso schlecht ist, wie die Bedienungsanleitung dazu.

Ein Verkaufsprospekt für Ihre Lösung.

Haben Sie jedoch eine Anleitung, die jeden Schritt nachvollziehbar beschreibt und die Anwendung funktioniert in der angegebenen Art und Weise, dann schafft das Vertrauen und erspart Ihnen Ärger, Fragen und fehlerhafte Daten. Geben Sie sich ruhig ein bisschen Mühe, die Dokumentation ansprechend zu gestalten. Das erhöht die Chance, dass die Anwender diese tatsächlich in die Hand nehmen. Dann ist die Dokumentation ein Verkaufsprospekt für Ihre Lösung.

  • Nutzen Sie die Dokumentation während des Trainings
    Das Erstellen einer guten Anwender-Dokumentation bedeutet Aufwand. Nutzen Sie diese Dokumentation deshalb so oft es geht. Zusätzliche Schulungsunterlagen, die nur in den Trainings verwendet werden, ergeben keinen Sinn. Lassen Sie die Anwender bereits in den Trainings die Dokumentation nutzen. Verweisen Sie immer wieder darauf.

    Eine logische Reihenfolge der Inhalte kann 1:1 die Reihenfolge sein, in der die Inhalte vermittelt werden. Nutzen Sie die Dokumentation, damit sich die Teilnehmer während der Trainings Inhalte selbst erarbeiten. Das schafft Vertrauen in die Dokumentation aber auch in das Ego des Teilnehmers: "Ist doch gar nicht so schwer. Steht ja alles hier drin."

  • Präzision, Wahrheit und Klarheit
    Manchmal ist es nicht so optimal, wie die Software im Alltag reagiert oder womit sie gefüttert werden will. Manche Arbeitsschritte oder Funktionen sind, gerade anfänglich, vielleicht sehr langsam.
    Geben Sie den Anwendern dazu klare und präzise Anleitungen. Sie sollen ganz genau wissen, welche Option sie wann auswählen müssen. Sie wollen nicht interpretieren.

    Könnte, sollte, würde, eventuell, wahrscheinlich - können Sie aus dem Wortschatz streichen.

    Präzision ist gefragt, Struktur und die ganze Wahrheit, auch wenn sie sich nicht schön anhört. Wir schreiben nicht den Roman Vom Winde verweht sondern eine Bedienungsanleitung, die keinen Spielraum für Interpretation lässt. Und, wenn es tatsächlich so ist, dann schreiben wir auch fünf Mal hintereinander: Klicken Sie.

Besipiel für eine Schritt für Schritt-Anleitung (Microsoft AX)
Besipiel für eine Schritt für Schritt-Anleitung (Microsoft AX)
Foto: Christa Weidner

Der Nutzen muss auch für den Anwender überwiegen

  • Fasse Dich kurz
    Jedes Wort, das wir schreiben, muss vom Anwender gelesen werden. Es verlängert auch das Korrekturlesen und das Überarbeiten. Prüfen Sie jede Silbe und Wort darauf, ob es notwendig ist und eine zusätzliche Information enthält. Wenn nicht: weg damit. Schreiben Sie kurze Sätze. Denken Sie daran, dass auch für den Anwender der Nutzen überwiegen muss.

  • Mach den Dummy-Test
    Machen Sie den Dummy-Test: Eine Dokumentation ist gut, wenn ein beliebiger Anwender ohne Vorkenntnisse und Training, anhand der dokumentierten Anleitung die Software bedienen und die Prozesse umsetzen kann. Wenn Ihre Dokumentation das schafft, dann ist sie wirklich gut.

Nutzen Sie das Format, das Ihre Anwender bevorzugen

Wenn die Autoren und Redakteure Ihrer Software-Dokumentation diese Tipps konsequent befolgen und erfüllen, dann haben Sie vermutlich eine bereits außergewöhnlich gute Dokumentation, die für Ihr Projekt von hohem Nutzen ist. Mit einer solchen Dokumentation lässt sich die Trainingsdauer verkürzen, es gibt weniger Anfragen beim Support und auch die Prozess- und Datenqualität wird sie positiv überraschen.
Übrigens, wenn wir von Dokumentation sprechen, dann kann diese auch Online, zumBeispiel wiki-basiert, in Ihrem Intranet bereitgestellt werden. Nutzen Sie das Format, das ihre Anwender bevorzugen. (bw)