Erfolgreich Software dokumentieren in fünf Schritten – mit Bonus

Sie wissen von Softwaredokumentation und ihren zahlreichen Einsatzmöglichkeiten? Und Sie haben einen Überblick über hilfreiche Tools zum Erstellen von Schritt-für-Schritt-Anleitungen?
Dann kann es fast schon mit der Dokumentation losgehen! Davor sollten Sie sich jedoch noch ein paar wichtigen Schritten und Tipps und Tricks bewusst werden.
Diese helfen Ihnen bei der Konzeption und Erstellung von Dokumentationen und maximieren ihren Nutzen.

Was macht eigentlich eine gute Softwaredokumentation aus?

Ganz einfach: Sie vermittelt nicht das was man sagen will, sondern das was der Nutzer wissen will.

Der Anwender steht immer im Zentrum und Benutzerfreundlichkeit ist die oberste Prämisse. Das Ziel der Dokumentationen ist die Lücke zwischen dem Vorwissen des Nutzers und der Bewältigung seiner Probleme zu überbrücken und ihn auf diese Weise erfolgreich zur Lösung anzuleiten. In der Erstellung sollten Sie mehrere Schritte durchlaufen:

Softwaredokumentationen bauen

5 Schritte zur erfolgreichen Dokumentation:

1. Analyse

2. Ziel- gruppe

3. Wahl der Form

4. Wahl des Formats

5. Wahl der Software

1. Analyse:

Zu Beginn müssen Sie sich sehr klar darüber werden welches Problem genau besteht und wie es gelöst werden soll. In welchem Ausmaß und warum bestehen die Schwierigkeiten? Wo liegen besondere Herausforderungen? Wo Stolpersteine, die immer wieder auftreten? Gibt es verschiedene Variationen des Problems?
Hilfreich kann auch eine Reproduktion des Problems sein um ein besseres Verständnis für es zu entwickeln.
Als Quelle für Ihre Analyse nutzen Sie vorhandene Daten: Sehen Sie Ihre E-mails und Nachrichten durch und beantworten Sie besonders häufige Anfragen einmal für alle.

2. Zielgruppe:

Anschließend analysieren Sie auch die Nutzerguppe, die die Dokumentation am Ende anwenden soll. Gibt es Einschränkungen bei den Nutzern? Welches Wissen besteht bereits, was muss besonders ausführlich erklärt werden? Bedenken Sie auch, dass die Dokumentation eventuell an weitere Nutzer weitergegeben wird, die vielleicht weniger Vorwissen haben als die ursprünglichen Anwender.

3. Wahl der Form:

Anschließend müssen Sie sich darüber klar werden, welche Form Ihre Dokumentation annehmen soll: Ein Referenzhandbuch, ein Benutzerhandbuch oder eine Kombination aus beiden?
Ein Referenzhandbuch erklärt die möglichen Funktionen einer Software grundlegend und erklärt verschiedene Buttons, Items, und Dialogfelder die dem Nutzer begegnen. Häufig geschieht dies in Form von kontextsensitiver Hilfe, das heißt, dass dem Nutzer Erklärungen direkt an der jeweiligen Schaltfläche auf dem Desktop angezeigt werden.
Ein Benutzerhandbuch dagegen widmet sich einem spezifischen Problem und seiner Lösung. Es erklärt die Durchführung einer Aufgabe mit der Software von Anfang bis Ende Schritt für Schritt und begleitet so den Anwender bei seiner Durchführung.

4. Wahl des Formats:

Schließlich müssen Sie auch noch entscheiden welches Format die fertige Anleitung am Ende annehmen soll: Word, Powerpoint oder Pdf-Format? Oder brauchen Sie die Bilddateien oder ein HTML-Format für Ihre Homepage? Muss die Dokumentation auf einer Website hochgeladen oder verschickt werden können?
Zudem müssen Sie sich entscheiden welches Design Sie für Ihre Dokumentation benötigen, z.B. die Nutzung der Firmenfarben.

5. Wahl der Software:

Basierend auf den Schritten 1-4 wählen Sie die passende Dokumentations-Software aus, die Ihrem Nutzen und Ihren Ansprüchen entspricht.

Zufriedene Kunden

Tipps & Tricks – Was ist zu beachten?

  • Spezifisch und präzise:
    Integrieren Sie alle möglicherweise wichtigen Informationen in die Beschreibungen und markieren Sie wichtige Daten, wie technische Informationen. Klare Anweisungen schaffen Vertrauen, Anwender wollen nicht interpretieren müssen.
  • Kein Wissen voraussetzen:
    Fangen Sie bei den einfachen Schritten an und erklären Sie auch grundlegende Funktionen. Notfalls können Nutzer immer noch Schritte überspringen – fehlende Erklärungen können nicht ausgeglichen werden.
  • Nutzernähe:
    Benutzen Sie genau DIE Tools und Software-Versionen, die auch Ihre User verwenden. So finden diese sich in Ihren Anleitungen wieder und können Schritte eins zu eins auf ihren Computer übertragen.
  • Einfachheit:
    Überfordern Sie Ihre Anwender nicht, sondern erklären Sie immer nur ein Lösungsweg zur Zeit. Für ein neues Problem erstellen Sie lieber auch eine neue Dokumentation.
  • Aufbau:
    Leiten Sie Ihre Anwender durch einen logischen und übersichtlichen Aufbau sicher durch die Dokumentation. Helfen Sie Ihnen durch Grafiken und Screenshots, sowie Nummerierungen zu verstehen. Möglich sind auch Querverweise.
  • Sprache:
    Verwenden Sie einfach zu lesende Texte und vermeiden Sie Fachbegriffe. Sprechen Sie Ihre Anwender direkt an, im allgemeinen Fall mit “Sie”.
  • Design:
    Halten Sie Ihre Dokumentation einheitlich und in einem klaren Design. Zur Identifikation kann die Nutzung Ihrer Firmenfarben und Ihres Logos nützlich sein.
  • Test:
    Gerade bei wichtigen Dokumenten kann ein Testlauf nicht schaden. Geben Sie einer nicht involvierten Person Ihre Dokumentation und testen Sie die Verständlichkeit der Anleitung. Durch das Feedback können Unklarheiten aufgedeckt und Schwachstellen durch Korrekturen ausgeglichen werden.
  • Länge:
    Wie immer gilt: Machen Sie die Dokumentation so lang wie nötig, aber so kurz wie möglich. Nur direkt problemorientierte Anleitungen mit der schnellsten, möglichen Lösung werden am Ende gerne benutzt.

Mit diesen Schritten und Tipps steht der erfolgreichen Softwaredokumentation nichts mehr im Wege. Sie können 1) einfach, 2) schnell und 3) präzise Informationen weitergeben und andere dazu befähigen, erfolgreich Software anzuwenden.

Viel Erfolg dabei! Wenn Sie noch weitere Fragen haben, freuen wir uns gerne über eine Nachricht von Ihnen an support@miraminds.com – #shareyourflow

Leave a Comment

Wegweiser mit Schildern