Kleine Sektflaschen Hochzeit
Bei der Frage, welche Inhalte oder Themen technische Dokumentation enthalten soll, sind je nach Branche und Produkttyp eine Reihe von Vorschriften und Normen zu berücksichtigen. Es gehört zu den Aufgaben eines Technischen Redakteurs, die relevanten Vorgaben zu recherchieren. Inhaltsverzeichnis technischer Dokumentationen - Checkliste - KONTECXT GmbH Technische Dokumentation. Nachfolgend ist technische Dokumentation im engeren Sinne der externen technischen Dokumentation gemeint. Dazu gehören Gebrauchsanleitungen, Bedienungsanleitungen usw. Siehe auch die Seite " Was ist technische Dokumentation ", Abschnitt "Definition technische Dokumentation". Allgemeine Vorgaben durch Normen und Gesetze Allgemeine Vorgaben zum Inhalt macht beispielsweise das Produktsicherheitsgesetz, § 6, Absatz 1: "Der Hersteller [hat] bei der Bereitstellung eines Verbraucherprodukts auf dem Markt... 1. sicherzustellen, dass der Verwender die Informationen erhält, die er benötigt, um die Risiken, die mit dem Verbraucherprodukt […] verbunden sind […] beurteilen und sich gegen sie schützen zu können […]" ( 2015) Daraus lässt sich ableiten, dass Sicherheitshinweise und Warnhinweise sehr wichtig sind.
Dann legen wir Ihnen AutoText ans Herz. Solche Schnellbausteine beschleunigen in Word die Technische Dokumentation um ein Vielfaches. An alles gedacht – und was sagt der Anwender? Haben Sie alle Punkte beachtet, dann macht Word die Technische Dokumentation zum Kinderspiel. Technische dokumentation inhaltsverzeichnis wien. Doch Sie ahnen es sicher: Auch das ist nur die halbe Miete. Denn die Technische Dokumentation kann noch so strukturiert sein – ob der Anwender die Inhalte auch versteht und richtig anwenden kann, steht wieder auf einem anderen Blatt. Eine User Journey hilft einzuschätzen, ob die Anwender tatsächlich mit der Technischen Dokumentation zurechtkommen und wo möglicherweise Verbesserungen oder Ergänzungen nötig sind. Wir unterstützen Sie in MS Word Manchmal erreicht man als Word-Anwender einen Punkt, an dem es einfach nicht weitergeht – wir kennen das zu gut. Das Layout macht nicht das, was es soll oder die schiere Menge an Bildern und Texten lähmt das Dokument und macht den Umgang damit unerträglich. Aber keine Sorge – in 99, 9% der Fälle haben wir dazu eine Lösung parat!
Allen voran ist hier die DIN EN 82079-1 zu nennen, die sich in Kapitel 5 "Inhalt von Gebrauchsanleitungen" relativ ausführlich, aber natürlich allgemein gehalten, mit dem Inhalt von technischer Dokumentation befasst. In Kapitel 5. 1 fordert die Norm beispielsweise: "Die Funktionalität der Produkte muss beschrieben werden und Fragen der Nutzer zum WO? WER? WAS? WANN? WIE? WARUM? sollten vorweggenommen und passende Antworten gegeben werden. Richtlinie für die Erstellung der Dokumentation zur betrieblichen Projektarbeit - IHK zu Rostock. " "Die Informationstiefe hängt von der (den) Zielgruppe(n) ab und den beabsichtigten oder erlaubten Aufgaben, die im Laufe des Produktlebens ausgeführt werden. " (Beuth 2013, 20) Und in Kapitel 5. 8. 2 "Installation": "Bei Produkten, die eine Installation erfordern, muss die Gebrauchsanleitung, soweit zutreffend, enthalten: - Vorgehensweise zur Entfernung von Transport- undVerpackungssicherungen […] - Checkliste der Dinge, die in der Packung enthalten sind […] - Anschlussplan und/oder -tabelle - Bedingungen für Zusammenbau und Montage […]" Fallbeispiel Kreissäge Nachfolgend wird am Beispiel einer Kreissäge demonstriert, wie Schritt für Schritt eine Inhaltsstruktur, unter anderem auf Basis von Vorschriften aufgebaut werden kann.
Hierfür sind vom Hersteller entsprechende Risikobeurteilungen durchzuführen. Nur unvermeidliche Restrisiken müssen letztendlich in der technischen Dokumentation beschrieben werden.