Technische Dokumentation | augmentor Digital Instruction Service Platform

augmentor Digital Instruction Service Platform

Der neue Standard für eine kundenorientierte technische Dokumentation für den optimalen After Sales Support.
Besuchen Sie uns auf dem 3. Handelsblatt Industrie 4.0 Gipfel am 9. + 10. November 2017 in St. Leon-Rot.

Technische Dokumentation

Die technische Dokumentation ist ein Aufgabengebiet, in dem alle produktrelevanten Informationen gebündelt, gepflegt und aufbereitet werden. Es umfasst den gesamten Lebenszyklus eines Produkts von der Spezifikation, Konstruktion, Herstellung über Qualitätssicherung und Produkthaftung bis hin zur Produktdarstellung, sowie insbesondere die Anleitung zu ordnungsgemäßen und sicheren Inbetriebnahme, Nutzung, Wartung, Instandhaltung, Repartur sowie der Außerbetriebnahme und Entsorgung eines technischen Produkts.

Der Begriff technisches Produkt ist beliebig weit auszulegen.

      

Neben typischen technischen Produkten, zu denen Haushaltsgeräte, Fahrzeuge, Audio-/Video/TV-Geräte, Spielzeuge usw. gehören, erfordern auch Softwareprodukte eine technische Dokumentation.

Man unterscheidet allgemein die interne technische Dokumentation von der externen technischen Dokumentation.

Die interne technische Dokumentation widmet sich der internen Informationspflege über den gesamten Produktlebenszyklus. Sie verwaltet und organisiert alles relevante Wissen zu einem Produkt. Die Teilaufgaben betreffen die Konstruktion, Risikoabschätzungen, die Qualitätssicherung, Haftungsfragen, patentrechtliche Frage usw.

Die externe technische Dokumentation verwantwortet alle Dokumente, mit denen Anwender und Nutzer des Produkts angeleitet oder eingewiesen werden und die einen ordnungsgemäßen und sicheren Gebrauch ermöglichen. Diese Dokumente sind nach Vorgabe des Gesetzgebers Produktbestandteil und können in unterschiedlichsten Formen geliefert werden.

Übliche Bezeichnungen für die Dokumente der externen technischen Dokumentation sind - Installations- oder Montageanleitung - Gebrauchsanleitung oder Gebrauchsanweisung - Kurzanleitung - Benutzerhandbuch - Serviceanleitung - Tutorial - Bordbuch (z.B bei Schiffen) - Online-Hilfe

Meist wird ein externes technisches Dokument zunächst in der Landessprache des Produkt-Herstellers verfasst und anschließend in die gewünschten Zielsprachen übersetzt. Die Übersetzung wird oft als externe Auftragsarbeit vergeben.

Bei softwaretechnischen Schnittstellen hat sich weitgehend eingebürgert, die Dokumentation in englischer Sprache zu verfassen. Die Benutzerhandbücher von Softwarprodukte dagegen werden lokalisiert (also übersetzt) ausgeliefert. Häufig kommen dabei bereits digitale Verfahren zum Einsatz.