Technische Dokumentation

Eine Betriebsanweisung muss an geeigneter Stelle an der Arbeitsstätte zugänglich sein. Dies ist eine Forderung aus der Betriebssicherheitsverordnung. Wenn es die betrieblichen Tätigkeiten erfordern, wie beispielsweise im Umgang mit Gefahrstoffen, muss die Betriebsanweisung in unmittelbarer Nähe in gedruckter Form vorliegen…

Es empfiehlt sich über Zündgefahren für Geräte in explosionsfähigen Atmosphären entsprechende Informationen in der Technischen Dokumentation bereitzustellen. Es bietet sich an Information zu Zündgefahren und mögliche Maßnahmen für die entsprechende Zielgruppe (Anwender, Reinigungs- oder Wartungspersonal) anzugeben. Beispielsweise welche Maßnahmen, der…

Der Hersteller einer Maschine oder Anlage hat darauf zu achten, dass seine Technische Dokumentation dem aktuellen Stand der Technik entspricht. Wenn durch neue Entwicklungen verbesserte Methoden zur Sicherheit des Produktes bekannt sind, müssen diese Aktualisierungen in die Betriebsanleitung mit einfließen.

Ein Hersteller muss in seiner internen Technischen Dokumentation auch entsprechende Unterlagen bereithalten. Dazu gehören auch Nachweise zur Umsetzung von Anforderungen an sicherheitsrelevante Funktionen wie Schutzeinrichtungen. Zu diesen internen Entwicklungsdokumenten, die das Know-how des Herstellers wiederspiegeln, zählen unter anderem: Die Eigenschaften…

Um eine Technische Dokumentation übersichtlich zu gestalten, können Orientierungshilfen auf den Seiten die Aufmerksamkeit des Lesers entsprechend steuern. Die geläufigste Orientierungshilfe ist die Seitenzahl. Aber auch Zwischenüberschriften, Marginalien, Stichwörter oder Register helfen dem Benutzer bei der schnellen Navigation durch das…

Das Inhaltsverzeichnis einer Technischen Dokumentation bietet dem Leser einen Überblick über die Inhalte der Dokumentation. Zwar genügt es die Inhalte mit einer Nummerierung und entsprechenden Überschriften zu versehen, jedoch ermöglichen visuelle Hilfsmittel die unterschiedlichen Ebenen besser darzustellen. Beispielsweise kann man…

Das typografische Gestalten einer Technischen Dokumentation ist ein funktionaler Prozess. Gut gestaltete Texte helfen dem Benutzer zeitsparend und energiesparend benötigte Informationen zu finden. Um dem Leser einer Dokumentation den textlichen Inhalt gut zu präsentieren, gibt es einige Punkte die es…

Die Bestimmungen für eine Technische Dokumentation für den australischen Markt sind sehr eng mit dem europäischen Markt gekoppelt. In Australien kommen dabei die Warnsymbole der internationalen Norm ISO 7010 zum Einsatz. Zudem übernehmen die Australier viele Bestimmungen aus dem europäischen…

Die Technische Dokumentation muss vor dem Inverkehrbringen des Produktes abgeschlossen sein. Daher ist es sinnvoll die Technische Redaktion frühzeitig im Konstruktionsprozess mit einzubinden. Spätestens dann wenn das Lastenheft für das Produkt vorliegt. Aus den Anforderungen an das Produkt im Lastenheft…

Um die Technische Dokumentation sinnvoll zur strukturieren, bietet sich die Norm DIN EN 82079-1 an. Diese sorgt mit ihren klaren Konzepten für eine gute Struktur und ist zudem eine echte Hilfestellung beim Erstellen einer Anleitung. Dabei enthält die Norm Prinzipien…