Inhaltsverzeichnis
Kaum eine Maschine kommt heute noch ohne Software aus. Die Steuerung, die Benutzeroberfläche, die Diagnosefunktion – Software ist längst fester Bestandteil technischer Produkte. Für Technische Redakteur:innen bedeutet das: Die Dokumentation endet nicht mehr an der Gehäusekante. Aber wie dokumentiert man Software eigentlich – und was ist der Unterschied zur klassischen Maschinendokumentation? Genau das klären wir in diesem Artikel.
Was ist Software-Dokumentation eigentlich?
Software-Dokumentation umfasst alles, was Nutzer:innen dabei hilft, eine Software zu verstehen, zu installieren und sinnvoll einzusetzen – von der technischen API-Beschreibung für Entwickler:innen bis zur Schritt-für-Schritt-Anleitung für Endanwender:innen. Texte, Illustrationen, Videos, interaktive Hilfen: All das kann Teil einer Software-Dokumentation sein.
Der Kern ist dabei immer derselbe: Software-Dokumentation überbrückt die Lücke zwischen dem, was eine Software kann, und dem, was ihre Nutzer:innen damit anfangen können. Und das zielgruppengerecht – denn was ein Entwickler braucht, ist selten das, was einen Endanwender weiterbringt.
Maschinendokumentation vs. Software-Dokumentation: Was ist anders?
Stellen Sie sich vor: Sie haben jahrelang Maschinendokumentation erstellt. Anleitungen, Sicherheitshinweise, Explosionszeichnungen – das kennen Sie. Und jetzt sollen Sie auch die neue Steuerungssoftware dokumentieren. Gleiche Aufgabe, oder? Nicht ganz. Das wissen schon viele Redaktionen, für die diese Situation bereits Realität ist.
Die Unterschiede beginnen schon bei der Recherche. Für die Maschinendokumentation fahren Sie zum Maschinenstandort, sprechen mit Ingenieur:innen und beobachten die Bedienung direkt vor Ort. Bei Software sitzen Sie mit Entwickler:innen zusammen – und brauchen im besten Fall einen eigenen Testzugang, um die Software wirklich aus Nutzerperspektive zu verstehen.
Auch die Inhalte unterscheiden sich grundlegend. Maschinendokumentation dreht sich um physische Realitäten: technische Spezifikationen, Sicherheitsanweisungen, Inbetriebnahme, Wartung. Software-Dokumentation hingegen beschreibt eine Welt, die sich ständig verändert – Installation, Benutzeroberfläche, Fehlerbehebung, Anpassungsmöglichkeiten. Und das ist der entscheidende Punkt: Eine Maschine ändert sich selten. Software schon – manchmal von Release zu Release. Ihre Dokumentation muss da mithalten. Versionierung und Änderungsverfolgung sind deshalb in der Software-Dokumentation keine Kür, sondern Pflicht.
Hinzu kommt die Frage des Formats. Maschinendokumentation liegt oft gedruckt vor – direkt an der Anlage, griffbereit für den Servicetechniker. Software-Dokumentation ist fast immer digital: Online-Hilfen, interaktive Tutorials, kontextsensitive Hinweise direkt in der Benutzeroberfläche. Ihre Nutzer:innen sitzen oder stehen vor einem Bildschirm und erwarten Antworten genau dann, wenn sie sie brauchen – nicht 50 Seiten später im Handbuch.
Was Sie bei der Software-Dokumentation beachten müssen
Software-Dokumentation ist kein normfreier Raum – auch wenn das manchmal so wirkt. Wer aus dem Maschinenbau kommt, kennt klare Vorgaben: Maschinenrichtlinie, CE-Kennzeichnung, EN ISO 12100. Bei Software ist der Rahmen weniger vertraut, aber er existiert.
Die wichtigste Orientierung bietet die Normenreihe ISO/IEC/IEEE 26511–26515, die speziell für Software-Dokumentation entwickelt wurde. Besonders relevant für Ihre tägliche Arbeit sind zwei davon: Die ISO/IEC/IEEE 26514 gibt vor, wie Dokumentationsinhalte strukturiert sein sollen und welche Mindestanforderungen gelten. Die ISO/IEC/IEEE 15289 hilft Ihnen dabei, den Überblick zu behalten – sie beschreibt, welche Informationsprodukte über den gesamten Lebenszyklus einer Software geplant, erstellt und gepflegt werden müssen.
Ergänzend gilt auch hier die IEC/IEEE 82079-1 – die allgemeine Norm für Nutzungsinformationen, die Sie aus der Maschinendokumentation kennen. Eindeutigkeit, Vollständigkeit, Verfolgbarkeit: Diese Anforderungen gelten für Software-Dokumentation genauso.
Der praktische Unterschied zum Maschinenbau: Die Software-Normen lassen mehr Spielraum bei der konkreten Umsetzung. Das klingt angenehm – bedeutet aber auch, dass Sie stärker selbst entscheiden müssen, was Ihre Dokumentation leisten soll. Eine gute Grundlage dafür ist, früh zu klären: Wer sind meine Nutzer:innen – und was brauchen sie wirklich?
Fazit: Maschine und Software dokumentieren
Software-Dokumentation ist kein Sonderfall mehr – sie ist für viele Technische Redakteur:innen längst Alltag. Und dieser Alltag wird komplexer: Produkte, die Hardware und Software verbinden, werden zur Regel, nicht zur Ausnahme. Die Frage ist nicht mehr, ob Sie Software dokumentieren, sondern wie gut Sie es tun.
Die gute Nachricht: Vieles, was Sie aus der Maschinendokumentation kennen, trägt Sie auch hier. Strukturiertes Denken, Zielgruppenorientierung, sorgfältige Terminologiearbeit – das sind keine Maschinenbau-Tugenden, sondern handwerkliche Grundlagen, die überall gelten. Was Sie ergänzen müssen, ist ein Verständnis für die Besonderheiten von Software: die Dynamik der Updates, die Vielfalt der Formate, den anderen regulatorischen Rahmen.
Wenn Sie diesen Schritt noch vor sich haben – oder gerade mittendrinstecken –, lohnt es sich, systematisch vorzugehen. Welche Normen gelten für Ihr Produkt? Welche Formate brauchen Ihre Nutzer:innen wirklich? Und wie stellen Sie sicher, dass Ihre Dokumentation mit jeder neuen Version Schritt hält? Das sind die Fragen, die den Unterschied machen.
