Erklärung

Eine Produktdokumentation, auch „technische Dokumentation“ genannt, beinhaltet sämtliche Informationen und Daten zu einem Produkt – diese beschreiben das Produkt an sich, dessen Anwendung, Fertigung, Zukaufteile und Montage, Wartung und Instandhaltung sowie Anweisungen zur Reparatur. Es werden alle Lebensphasen bis zur Entsorgung beschrieben.

Zur besseren Übersicht sind Produktdokumentationen durch unternehmensspezifische Namens- oder Nummernsysteme systematisch strukturiert.

Ziel

Eine Produktdokumentation wird angefertigt, um den Hersteller haftungsrechtlich abzusichern, um die Reproduzierbarkeit und Rückverfolgbarkeit von Produktkomponenten und deren Montage zu gewährleisten, um Informationen und Instruktionen für Zielgruppen oder Mitarbeiter zu strukturieren und um sämtliche, zur dauerhaften/gesetzlich geforderten Archivierung relevanten Daten zu sammeln.

Vorgehen

Wenn man eine technische Dokumentation anfertigt, differenziert man (nach VDI 4500) nach „intern“ und „extern“:

1. Interne Dokumentation:
In der internen Dokumentation werden alle produkt- und produktionsrelevanten Dokumente gesammelt und strukturiert, um der gesetzlichen Nachweispflicht gerecht zu werden. Damit kann belegt werden, dass das Unternehmen/der Hersteller sämtliche rechtlichen Vorgaben eingehalten hat.
Diese Dokumente können Lasten- und Pflichtenhefte sein, aber auch Unterlagen zu Berechnungen und Risikobeurteilungen, Berichte zu Versuchen und Tests, sowie technische Zeichnungen, CAD – Datensätze, Verträge und Dokumente bezüglich der Fertigung und Nachweise zur Qualitätssicherung und -kontrolle.
Innerhalb eines Unternehmens wird die Dokumentation meist von Mitarbeitern der Entwicklung und Konstruktion durchgeführt.


2. Externe Produktdokumentation:
Eine externe Produktdokumentation wird für Nutzer angefertigt und liegt diesen meist in Form einer Gebrauchsanweisung, einer Anleitung zu Montage, Installation oder Service, eines Bord- oder Benutzerhandbuchs, eines Online- oder telefonischen Supports oder Tutorials vor.
Angefertigt wird diese Dokumentation i.d.R. von der technischen Redaktion und wird dann in sämtliche benötigten Sprachen übersetzt.


Zu beachten ist, dass sowohl die interne, als auch die externe Dokumentation Normen und Richtlinien unterliegen, die von DIN, VDI, VDE, CEN o.ä. definiert werden. Internationale Normen werden z.B. von dem ISO festgelegt – dennoch sind zudem länderspezifische Vorgaben zu berücksichtigen.

Anhaltspunkte für die Gestaltung von interner und externer Produktdokumentation finden Sie z.B. unter EN 82079 oder 61355, der erwähnten VDI 4500 oder DIN199.

Tipp

Da große Verantwortung sowie Haftungsfragen vor allem bei der externen Dokumentation anfallen, ist es unabkömmlich diese von Personen mit derartigen Qualifikationen und Fachkenntnissen, z.B. technischen Redakteuren, schreiben zu lassen. Technische Redakteure haben zudem die Funktion als Koordinator für den abteilungsübergreifenden Dokumentationsprozess inne.

Quellen

  • Lehrstuhl und Institut für allgemeine Konstruktionstechnik des Maschinenbaus RWTH Aachen – Univ.-Prof. Dr.-Ing. Jörg Feldhusen
  • EN 82079
  • Richtlinie VDI 4500
  • www.wikipedia.de

Beispiele