Intuitiv bedienbare Software benötigt keine Dokumentation? Wieso das nicht stimmt und in welchen Fällen sie sogar vorgeschrieben ist, zeige ich im heutigen Beitrag.
Es gibt immer mehr elektronische Systeme, die in Geräten und Fertigungslinien eingesetzt werden.
Auch wenn deren Software in manchen Fällen sehr intuitiv zu bedienen ist, wird so gut wie immer eine Dokumentation für die Software mitgeliefert. Diese soll alle Bereiche des Lebenszyklus abdecken und bei der Entwicklung, Installation, Anwendung und Wartung unterstützen.
Neben den Handbüchern für den Anwender betrifft das Thema auch Application Programming Interface (API)-Dokumentationen für die Entwickler und Release-Notes, damit die einzelnen Versionen unterschieden werden können.
Wenn es sich um wenige einfache Funktionen handelt, wird die Dokumentation oftmals gar nicht beachtet. Es gibt jedoch spezielle Anwendungsfälle, also komplexe Programme mit vielen Parametereinstellungen wie z. B. Adobe InDesign, das wir auch bei midok® verwenden.
Damit der Anwender alle Funktionen verstehen und nutzen kann, bedarf es eines detaillierten Handbuchs. Auch eigenständige Fehlerbehebungen sollen durch entsprechende Erklärungen ermöglicht werden. Deshalb kann das Ergebnis durchaus so umfangreich werden, dass die Größe einem Roman wie Harry Potter Konkurrenz macht.
Rechtliche Gründe zur Erstellung von Softwaredokumentation
Des Weiteren gibt es einige rechtliche Gründe, wieso entsprechende Dokumentationen erstellt werden:
➡️ Vertragsbedingungen: Viele Entwicklungsverträge verlangen spezifische Dokumentationen, um sicherzustellen, dass alle vertraglichen Verpflichtungen erfüllt und mögliche rechtliche Konsequenzen vermieden werden.
➡️ Compliance-Standards: Für Anwendungen mit sensiblen Daten sind detaillierte Dokumentationen unerlässlich, um Standards wie die DSGVO zu erfüllen.
➡️ Regulatorische Anforderungen: In Branchen wie Gesundheitswesen und Finanzen sind umfassende Dokumentationen gesetzlich vorgeschrieben, um Sicherheit zu gewährleisten.
Die unterschiedlichen Formate der Softwaredokumentation
Dabei gibt es unterschiedliche Formate der Darstellung. Die Anleitung kann klassisch als Buch gedruckt, im Video erklärt oder auch online als Fragenkatalog oder Forum aufbereitet sein.
Manche Programme bieten eine kontextbezogene Hilfe direkt in der Software. Hier werden dem Nutzer die benötigten Informationen durch sogenanntes „Hovern“ angezeigt. Der Anwender fährt hierfür mit der Maus über ein bestimmtes Icon und ein entsprechendes Textfeld ploppt auf.
Egal in welchem Format und Umfang, eine verständlich erstellte Software-Dokumentation erhöht deutlich die Benutzerfreundlichkeit und Produktivität.
Was aber sind jetzt die genauen inhaltlichen Unterschiede zu einer Maschinen-Dokumentation? Darauf gehen wir nächste Woche ein und zeigen, auf was es im jeweiligen Bereich besonders ankommt.
