Technische Dokumentation

Der Gesetzgeber fordert, dass der Hersteller die Technische Dokumentation zu seinen Produkten ab dem Zeitpunkt des Verkaufs mindestens 10 Jahre vorhalten muss. Der Verkauf jedes Produktes setzt diesen Zeitpunkt wieder zurück. Falls im Zuge der Produktbeobachtungspflicht die Dokumentation anzupassen ist,…

Sind Informationen für den Umgang mit entzündlichen Stoffen zu beachten, muss der Hersteller entsprechende Informationen in seiner Technischen Dokumentation bereithalten. Die Maschinenrichtlinie fordert zudem, dass eine Maschine so konstruiert und gebaut sein muss, dass keine Brand- und Überhitzungsgefahren entstehen können…

Falls mehrere Dokumente die „Betriebsanleitung“ in einer Technischen Dokumentation ausmachen, muss der Zusammenhang der einzelnen Dokumente klar erkennbar sein. Dies kann man mithilfe von entsprechenden Verweisen und Verzeichnissen in allen Dokumenten sicherstellen. Dadurch ist ersichtlich, welches Dokument welchen Zweck erfüllen…

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…