Technische Dokumentation

Die technische Dokumentation

"Die" Technische Dokumentation ist der allgemeine Oberbegriff für die Dokumentation eines Produktes. Kennenlernen der Grundlagen einer verständlichen und aussagekräftigen technischen Dokumentation in Text und Bild. Wir unterstützen führende Unternehmen aus vielen Branchen bei der Erstellung und Pflege ihrer technischen Dokumentation. "Die" Technische Dokumentation ist ein Sammelbegriff für alle Dokumente zu technischen Prozessen und zur Entwicklung, Herstellung, Verwendung,..

.. Tips und Tricks zum Verfassen von technischen Dokumentationen.

mw-Klasse=" mw-headline" id="Zweck_der_Technischen_Dokumentation">_Zweck_der_Technischen_Dokumentation">[Editing | | Quelltext bearbeiten]>

Technische Dokumentation (auch technische Dokumentation oder Produktdokumentation) beinhaltet alle Informationen, die ein Produkt technisch darstellen und zu seiner Verwendung, Instandhaltung oder Instandsetzung anweisen. In der Regel ist die technische Dokumentation dem zu dokumentierenden Produkt über Namens- und Zahlensysteme einmalig zuordenbar. Sie dienen der Aufklärung und Unterweisung von definierten Anspruchsgruppen, dem Schutz der Herstellerhaftung, der Produktüberwachung, der Rückführbarkeit und Wiederholbarkeit sowie der permanenten oder rechtlich vorgeschriebenen Aufbewahrung der entsprechenden Daten.

In den Komponenten der Dokumentation finden Sie Angaben zum eigentlichen Gerät, zum Gebrauch und zum Benutzerverhalten. Die VDI 4500 unterscheidet zwischen innerbetrieblicher und außerbetrieblicher Technik: Die VDI 4500: In der hausinternen Dokumentation werden alle produktionsrelevanten Unterlagen archiviert und die Einhaltung der gesetzlichen Verpflichtungen nachgewiesen.

Es deckt den kompletten Lebenszyklus von der Planung, über die Produktentwicklung, Produkteinführung und -überwachung bis hin zur Produktabkündigung ab. In der Regel verbleiben die Daten beim jeweiligen Produzenten, der sie permanent speichert und während der ganzen Produktlebensdauer auf dem neuesten Stand der Technik ist. Zu den typischen Komponenten gehören Spezifikationen, Berechnungsdokumente, Prüfberichte, Risikobewertungen, technische Pläne und Produktionsunterlagen, der Nachweis von Qualitätssicherungsmaßnahmen und die komplette technische Dokumentation des Produktes.

Diese wird in der Regel von der Entwicklungs- oder Entwicklungsabteilung des Produzenten gepflegt. Mit der externen Dokumentation werden die Bediener und Nutzer des Produktes informiert und sichergestellt, dass das Gerät gefahrlos und sachgerecht inbetriebgenommen, benutzt, instandgehalten und ggf. beseitigt werden kann. Diese wird in der Regel von Fachredakteuren angelegt und in der Praxis in die jeweilige Landessprache des Anwenders übertragen.

Besondere Subtypen der Fachdokumentation resultieren aus gesetzlichen Vorgaben wie z.B. der Meldepflicht bei notifizierten Behörden (Beispiel: Technische Dokumentation nach RL 94/9/EG "ATEX"). Zur Gewährleistung der Produktsicherheit verlangen die staatlichen Gesetzgebungen und Verordnungen der privatrechtlichen Einrichtungen, dass Produzenten und Installateure von Technikprodukten technische Dokumentationen zur Verfügung gestellt werden. Bei Schäden führen mangelhafte technische Unterlagen zu einer Produzentenhaftung nach dem Produkt-Haftungsgesetz, dem BGB (§ 823 Schadenersatzpflicht) und einzelnen Vertragspflichten.

Handbücher für die Auslegung von Anlagendokumentationen oder Benutzerinformationen sind in verschiedenen Standards und Leitlinien, der EN 82079 oder der VDI 4500 erhältlich Die Dokumentation für Kraftwerksanlagen ist in der Leitlinie VGB R171, Anlieferung der Anlagendokumentation (Technische Daten, Dokumente) für Kraftwerksanlagen festgelegt. EN 61355 reguliert die Einstufung und Beschriftung von Unterlagen der Technische Dokumentation für Maschinen, Apparate und Ausrüstungen.

Bei der physischen Bewirtschaftung von geschriebenen und elektronisch vorliegenden Dokumenten kommt die international gültige ISO 15489 (Records Management) zur Anwendung. Für die Archivierung von Dokumenten wird die ISO 15489 verwendet. Die Begriffe (Begriffe) der Produktdokumentationen regeln u.a. DIN 199 Die Arbeit an einer Dokumentation ist eine geplante Aktivität. Deshalb sollte eine konsequente Erstellung der Fachdokumentation einem Konzept entsprechen, das im Laufe der Verarbeitung ausgebaut und umgestaltet wird.

Der Aufbau der technischen Dokumentation muss folgerichtig sein. Zur Erleichterung der Bearbeitung werden einzelne Unterlagen inhaltlich oder in Anlehnung an die Produktstruktur gruppiert und mit modularen Dokumentlisten und -verzeichnissen geführt. Standards wie die Norm EN 6789 bieten einen Kunststoffüberblick über das Dokumentationssystem Eine spezielle Konstruktion ermöglicht eine gezielte Ansicht eines Dokumentationsinventars.

Gerade Benutzerinformationen stellen höchste Ansprüche an Klarheit und Verständnis. Sie vereinfachen die Erfassung der Daten und erlauben es dem Anwender der Unterlagen, die gewünschten Informationen leichter zu finden. Die technische Dokumentation verwendet eine in der entsprechenden Benutzergemeinschaft (Community) übliche Benennung und ein hochspezialisiertes Vokabular. Neben den Strukturierungsverfahren ist die Nutzerinformation auch ein linguistischer Texttyp mit gewissen Hauptzielen, wie z.B.:

Weil technische Produkte aufgrund ihres großen Spezialisierungsgrads oft in eine große Anzahl von Staaten ausgeführt werden, werden die externen Dokumente und Anwenderinformationen meist in eine Anzahl von Landes- oder Regionalsprachen übertragen. Um eine kosteneffiziente Durchführung dieser Arbeiten zu gewährleisten, sollten technische Lektoren bereits in der Schreibphase auf die Erfordernisse des übersetzungsorientierten Textes achten.

Im Idealfall werden alle funktionalen Bereiche des Produzenten in die technische Dokumentation eines Produktes miteinbezogen. Insbesondere die Anfertigung von externen Dokumenten verlangt spezielle Kenntnisse und Vorkenntnisse. Damit sind Fachredakteure beauftragt, die oft für die Redaktion der Nutzerinformationen sowie für die Koordinierung des bereichsübergreifenden Dokumentationsablaufs in Fachbereichen - Fachredaktionen - zuständig sind.

Dieser Begriff steht in unmittelbarem Bezug zum Begriff der technischen Dokumentation.

Auch interessant

Mehr zum Thema