Eine Software Dokumentation soll grundsätzlich drei Fragen rund um ein Programm erläutern. Wie funktioniert das Programm?Wie wird das Programm bedient?Wie wurde die Software entwickelt? Mit Beantwortung dieser Fragen deckt die Software Dokumentation auch alle unterschiedlichen Zielgruppen ab. Die Anleitung zu…
Das Schreiben einer Software Dokumentation unterscheidet sich von einer normalen Technischen Dokumentation. Wie die Anleitung für Software aufgebaut ist, hängt davon ab wie häufig man die Software verwendet. Bei einmaliger Nutzung möchte der Anwender schnell und ohne seitenlanges Lesen handeln…
Die Risikobeurteilung ergab eine zu hohen Schallemission an einer Maschine. Der Konstrukteur bzw. die Herstellerfirma dieser Maschine hat nun drei Möglichkeiten, um die Maschine sicher zu gestalten. Die erste Wahl sollte immer eine konstruktive Lösung einer Gefährdung sein. Kann die…
Um eine Technische Dokumentation zielgruppengerecht aufzubereiten, gilt es auch im Bereich der textlichen Gestaltung einiges zu beachten. So sollte der Satzaufbau der Betriebsanleitung einfach gehalten sein. Handlungen beschreibt man in kurzen und verständlichen Sätzen. Der Schreibstil der Betriebsanleitung sollte von…
Die Technische Dokumentation enthält viele Informationen für den Benutzer einer Maschine. Dazu zählen auch Handlungsanweisungen für verschiedenen Bedienungsabläufe. Diese sollten klar und kurz formuliert sein. In jedem Satz sollte zudem nicht mehr als eine Handlung beschrieben sein, um die Informationsmenge…
Eine Technische Dokumentation enthält häufig Abbildungen auf verschiedenen Arten. Unter anderem Fotografien von Bauteilen, Werkzeugen oder der Maschine aber auch 3D-Abbildungen oder Schemazeichnungen. Doch wann sollte welche Art der Abbildung eingesetzt werden? 3D-Abbildungen können komplexe Sachverhalte darstellen und eigenen sich…
Die CE-Kennzeichnung ist nicht zwingend gefordert für Maschinen für den US-Markt. In Amerika ist CE nicht anerkannt, die amerikanischen Behörden haben ein eigens Prüfverfahren. Bevor ein Produkt auf den amerikanischen Markt gelangen kann, ist dieses nach US-Normen und -Standards auf…
Direkte Anforderungen in der Maschinenrichtlinie bezüglich ökologische Aspekte und dem Umweltschutz sind in der aktuellen Fassung nicht vorhanden. Jedoch ist das Vermeiden oder Verringern von Umweltgefahren ein weiteres Ziel, womit sich die Hersteller und Konstrukteure befassen müssen. Die Europäische Union…
Es besteht für die Technische Dokumentation eine Aufbewahrungspflicht von mindestens 10 Jahren. Dies fordert die Maschinenrichtlinie aus Gründen der Produkthaftung. Der Hersteller muss hierzu die Technische Dokumentation auf Rückfragen von Behörden innerhalb dieser Zeit vorweisen können.
Die interne Technische Dokumentation enthält alle notwendigen Unterlagen zur Entwicklung, Fertigung und Prüfungen der Eigenschaften des Produktes und verbleiben im Unternehmen des Herstellers. Hierzu zählen die Risikobeurteilung, technische Zeichnungen, Berechnungsunterlagen, Versuchsberichte, Pflichtenhefte und Nachweise hinsichtlich Qualitätssicherungsmaßnahmen. Nur in bestimmten Fällen…
Sie sehen gerade einen Platzhalterinhalt von Facebook. Um auf den eigentlichen Inhalt zuzugreifen, klicken Sie auf die Schaltfläche unten. Bitte beachten Sie, dass dabei Daten an Drittanbieter weitergegeben werden.
Mehr InformationenSie sehen gerade einen Platzhalterinhalt von Instagram. Um auf den eigentlichen Inhalt zuzugreifen, klicken Sie auf die Schaltfläche unten. Bitte beachten Sie, dass dabei Daten an Drittanbieter weitergegeben werden.
Mehr InformationenSie sehen gerade einen Platzhalterinhalt von X. Um auf den eigentlichen Inhalt zuzugreifen, klicken Sie auf die Schaltfläche unten. Bitte beachten Sie, dass dabei Daten an Drittanbieter weitergegeben werden.
Mehr Informationen