Softwaredokumentation – was ist das eigentlich?
Einfache Frage, einfache Lösung: einfach mal Wikipedia fragen. Geht man auf die Website des Online-Lexikons findet man: “Mit Softwaredokumentation bezeichnet man die Dokumentation von Software.”
…
Hm.
Nun ja, vielleicht doch nicht ganz so einfach. Mit dieser nicht ganz zufriedenstellenden Erklärung wird es Zeit, sich das Ganze einmal näher anzusehen: was steckt wirklich hinter dem Begriff Softwaredokumentation?
Das Ziel von Softwaredokumentation ist das Aufzeichnen von digitalen Prozessen. Diese Aufzeichnungen beinhalten umfassende Informationen und können Entwicklern oder Benutzern beispielsweise erklären wie Software funktioniert, wie sie entwickelt wurde oder wie man sie bedient.
Damit wird es jedoch schon komplexer: Hinter “Softwaredokumentation” stehen verschiedene Teilbereiche von Programmier-, über Daten- bis zu Benutzerdokumentation. Diese variieren in ihren Zielgruppen (Programmierer, Kollegen, Kunden) und Formen der Dokumentation (Benutzerhandbücher, Knowledge-Bases, Schritt-für-Schritt-Anleitungen).
Grob unterscheiden kann man zwischen:
- Projektdokumenten von Entwicklern, die beschreiben wann/wie/was/womit/warum Software erstellt wurde und die detailliert auf technische Hintergründe von Software eingehen
und
- Systemdokumenten, die Funktionen und Ergebnisse von Software erläutern und Nutzern ihre Bedienung erklären.
Besonders wichtig für Unternehmen ist die Systemdokumentation für Endbenutzer, also die Erklärung der Funktionen von Software für ihre Anwender. Das Ziel dabei ist eine umfassende Benutzerunterstützung („User Assistance“): Anwender mitzunehmen, direkt bei ihren Problemen anzusetzen und ihnen nachhaltig damit zu helfen, Software anzuwenden.
Für wen dokumentieren?
Softwaredokumentation ermöglicht den Transfer von Informationen entweder zwischen Mitarbeitern innerhalb eines Unternehmens oder nach außen: Zielgruppe können einerseits beispielsweise Kunden oder Benutzer sein, die Fragen haben oder Anwendungshilfe mit Software brauchen. Durch die Dokumentationen bekommen sie schnelle und zielgerichtete Lösungen, um sich selber zu helfen und erfolgreich zu arbeiten.
Andererseits wird Benutzerdokumentation auch intern im Unternehmen eingesetzt – um neue Mitarbeiter in bestehende Systeme einzuarbeiten, neue Software ins Unternehmen einzuführen oder die Anwendung von digitalen Tools im Unternehmen allgemein zu unterstützen. Auch beispielsweise Urlaubsübergaben oder Support-Anfragen an die IT-Abteilung können über Softwaredokumentation schnell und nachhaltig abgeschlossen werden. Weiter Anwendungsfälle finden Sie auch unter https://miraminds.com/anwendungsfaelle/: Dokumentationen erleichtern den Alltag in Unternehmen oftmals signifikant und ermöglichen einen erfolgreichen Informationstransfer zwischen Personen.
Fertiggestellt, kann die Dokumentation verschiedene Formen annehmen, beispielsweise Schritt-für-Schritt-Anleitungen, Online-Hilfen oder Screencasts – aber alle haben einen Anspruch gemein: Sie müssen benutzerfreundlich sein.
Und da fangen häufig die Probleme an. Selber und ohne Hilfe Software-Dokumentationen zu erstellen ist gar nicht so einfach. Wer schon einmal selber für Kollegen oder Kunden dokumentiert hat weiß, wie aufwendig Dokumentationen per Hand sind.
Es geht noch weiter…
Aus diesem Grund machen wir an dieser Stelle noch nicht Schluss: ein Blogeintrag kommt ja selten allein und nächste Woche folgt der nächste Teil unserer Software-Dokumentations-Reihe.
Darin stellen wir Ihnen verschiedene Tools zum Dokumentieren von Software vor und welche Möglichkeiten es gibt, um Ihnen das Leben beim Dokumentieren einfacher zu machen. Welche Anbieter sind auf dem Markt? Was macht sie besonders und welches Tool eignet sich für Ihren individuellen Zweck?
Abschließend zu der Reihe stellen wir Ihnen danach im dritten Teil vor, wie Sie das Dokumentieren schließlich erfolgreich in Anspruch nehmen und was für Tipps und Kniffs es zu beachten gibt. Am Ende soll Ihrer eigenen Software-Dokumentation nichts mehr im Wege stehen und sie wie von selbst Anwender-Informationen mit anderen Teilen können.
Ps. Wenn Sie mal eine fertige Dokumentation sehen wollen schauen Sie doch bei unserem Post aus dem März vorbei! Dort dokumentieren wir die Erstellung eines SVerweises: https://miraminds.com/sverweis-mit-excel-erstellen/.
