Ob Software oder Maschine – die richtige Dokumentation ist wichtig für die Kundenzufriedenheit und damit auch für den Erfolg des Produkts.
Da immer mehr Software und Elektronik in den Produkten integriert ist, wächst auch die Bedeutung der entsprechenden Dokumentation.
Es müssen alle Funktionen genauestens erklärt werden, damit der Nutzer jederzeit weiß, wie er das Produkt bedienen muss. Wenn Störungen oder Probleme auftreten, sollen diese mit Hilfe der Technischen Dokumentation schnell gelöst werden können.
Bei den meisten Maschinen und Anlagen liegt eine Mischung aus physischer und softwaregestützter Steuerung vor, weshalb eine stimmige Verbindung der Software- und Maschinen-Dokumentationen wichtig ist.
Was ist der Unterschied zwischen den beiden Varianten?
Software-Dokumentation
Eine Software-Dokumentation umfasst alle Informationen, die sich auf ein bestimmtes Anwendungsprogramm beziehen. Inhalte sind z. B. Benutzerhandbücher, Application Programming Interface (API)-Dokumentationen für die Entwickler und Release-Notes zur Unterscheidung der einzelnen Versionen.
Das Hauptziel ist es, Entwickler und Anwender über die Funktionalitäten, Installation, Nutzung und Fehlerbehebung der Software zu informieren.
Maschinendokumentation
Die Maschinendokumentation bezieht sich auf Informationen zu physischen Maschinen und Geräten. Dazu gehören Betriebsanleitungen, Wartungshandbücher, technische Spezifikationen und Sicherheitsanweisungen.
Diese Unterlagen sind entscheidend für die korrekte Inbetriebnahme, Bedienung, Wartung und Reparatur von Maschinen.
Auf diese Themen gehen wir in den kommenden drei Wochen genauer ein:
11.07.2024: Warum braucht es Softwaredokumentation?
Eigentlich sollte eine Software intuitiv bedienbar sein, also wozu eine umfangreiche Dokumentation erstellen?
Einerseits besteht eine durch Normen begründete Pflicht dazu. Andererseits ist je nach Komplexität des Programms eine gut strukturierte und umfassende Dokumentation notwendig, damit der Nutzer einer Software diese versteht und alle Funktionen bedienen kann.
Diese deckt den gesamten Lebenszyklus der Software ab, von der Entwicklung und Wartung bis hin zur Installation und Nutzung.
Welche speziellen Anwendungsfälle und unterschiedlichen Formate es gibt, erklären wir in diesem Beitrag.
18.07.2024: Inhalte Software- vs. Maschinendokumentation
Wie unterscheiden sich die Inhalte der beiden Dokumentationen?
Neben den unterschiedlichen Ansprechpartnern werden auch ganz verschiedene Unterlagen und Informationen zur Erstellung benötigt.
Auch beim Aufwand während des gesamten Lebenszyklus des Produktes bzgl. Aktualisierungen besteht eine große Abweichung.
Dieser Beitrag zeigt, auf was es im jeweiligen Bereich besonders ankommt.
25.07.2024: Wie greifen Software und Maschine ineinander?
Manche Maschinen werden hauptsächlich durch physische Komponenten bedient und nur ein Teilaspekt der Funktion erfordert die Bedienung einer Software. Andere wiederum werden vollumfänglich durch eine Software bedient und gesteuert.
Anhand eines Beispiels aus dem Alltag erklären wir Ihnen im letzten Beitrag, wie sich die Gewichtung in den letzten Jahren verändert hat.
Sie werden die Unterschiede erkennen und sehen, welche Relevanz das Thema für unsere Arbeit bei midok® hat.
