Software- vs. Maschinen-Dokumentation – gleiches Ziel, aber verschieden in Erstellung und Inhalt. Wie unterscheiden sich die beiden Varianten und was ist jeweils besonders zu beachten?
Schauen wir uns die größten Unterschiede genauer an:
1. Zielgruppe und Vorgehen
Software-Dokumentation: Zur Informationsbeschaffung steht der Technische Redakteur im stetigen Austausch mit Entwicklern und Programmierern einer Software. Für eine effiziente Arbeit an der Dokumentation ist ein eigener Account notwendig, um Screenshots zu erstellen und die Software aus Sicht des Anwenders zu betrachten.
Maschinen-Dokumentation: Für die Datensammlung fährt der Technische Redakteur oft zum Maschinenstandort und spricht mit Ingenieuren oder dem Technischen Fachpersonal vor Ort. Die Bedienung von physischen Steuerelementen wird demonstriert und anhand von Fotos dokumentiert.
2. Inhalt
Software-Dokumentation: Sie enthält Informationen zur Installation, Benutzeroberfläche sowie Anleitungen zur Fehlerbehebung. Der Fokus liegt auf der Funktionsweise der Software und den Möglichkeiten ihrer Anpassung.
Maschinen-Dokumentation: Bestandteil sind technische Spezifikationen,
Sicherheitsanweisungen, Informationen zur Inbetriebnahme, Bedienung und Entsorgung der Maschine. Des Weiteren gehören Explosionszeichnungen, Stücklisten und Reparaturanleitungen dazu.
3. Updates
Software-Dokumentation: Regelmäßige Updates erfordern eine sorgfältige Versionierung und Änderungsverfolgung, da eine Software stets weiterentwickelt wird. Das erfolgt meist im Dialog mit dem Anwender.
Maschinen-Dokumentation: Updates sind hier eine Seltenheit, da Maschinen oft über Jahrzehnte im Einsatz sind und Anpassungen nur bei größeren Modifikationen oder Upgrades notwendig sind.
4. Medien und Formate
Software-Dokumentation: Diese wird häufig digital bereitgestellt in Form von Online-Wikis, PDF-Handbüchern und mit interaktiven Elementen wie Videos.
Maschinen-Dokumentation: Diese liegt meist in gedruckter Form vor, um an der Maschine zum direkten Gebrauch zur Verfügung zu stehen.
5. Regulatorische Anforderungen
Software-Dokumentation: Normen wie ISO/IEC 26514 für System- und Software-Engineering müssen berücksichtigt werden.
Maschinen-Dokumentation: Richtlinien wie die Maschinenrichtlinie oder Vorschriften zur CE-Kennzeichnung müssen eingehalten werden.
Fazit
Beide Varianten haben das gleiche Ziel, aber bedienen unterschiedliche Zielgruppen und Herausforderungen.
Bei vielen modernen Maschinen und Anlagen greifen Software und Maschine ineinander. Anhand eines Beispiels aus dem Alltag erklären wir Ihnen im letzten Beitrag, wie sich das Zusammenspiel und die Gewichtung in den letzten Jahrzehnten verändert hat.
