Produktdokumentation

Bei der Produktdokumentation handelt es sich um eine Dokumentensammlung, die aus produktbezogenen Informationen besteht. Die Informationen decken den gesamten Lebenszyklus eines Produktes ab – von der Entwicklung über die Herstellung, Verwendung und Wartung bis zur Entsorgung. Inhalte der Produktdokumentation richten sich dabei an verschiedene Stakeholder, darunter Entwickler, Hersteller, Zulieferer, Regulierungsbehörden und natürlich Endnutzer.

Wie ist eine Produktdokumentation aufgebaut?

Die Dokumentensammlungen innerhalb einer Produktdokumentation liegen strukturiert in einem standardisierten Format vor. Die Standardisierung unterscheidet sich je nach Markt- oder Industriebereich. Branchenspezifische Anforderungen, regulatorische Vorgaben und die adressierten Nutzergruppen entscheiden darüber, wie eine Produktdokumentation erstellt ist und welche Informationen sie umfasst.
Im Aufbau folgt die Produktdokumentation dann einer einheitlichen Logik. Das bedeutet, dass sie einheitlich strukturiert ist und der jeweiligen Nutzergruppe Informationen in einer sachgerechten Terminologie bereitstellt. Kurzum: Eine Produktdokumentation ist konsistent aufgebaut.

Zudem relevant: Produktdokumentationen müssen so vorliegen, dass sie eindeutig übersetzbar sind.

Produktdokumentationen enthalten alle Dokumente, die im Leben eines Produktes entstehen oder für Reparatur-, Wartungs-, Weiterentwicklungs- oder Nutzungszwecke zukünftig gebraucht werden.

Technische Dokumentation

Die Technische Dokumentation beinhaltet alle Informationen, um als Verwender oder Produktbeteiligter ein technisches Produkt sicher zu nutzen und Gefahren korrekt einzuschätzen. Die interne Dokumentation beginnt bereits mit der ersten Entwicklung eines Produktes und endet erst nach dessen Aufbewahrungsfrist. Sie dient als Nachweis gegenüber dem Gesetzgeber. Hingegen enthält die externe Dokumentation alle Informationen für Endnutzer, also zum Beispiel Bedienungs- oder Montageanleitungen.

Regulatorische und Qualitätsdokumentation

Mit der Regulatorischen Dokumentation und der Qualitätsdokumentation weisen Unternehmen nach, dass sie gesetzliche Anforderungen innerhalb von Produktprozessen erfüllen. Beispiele sind Compliance- und Testberichte, Prüfzertifikate, Protokolle aus Qualitätskontrollen oder GMP-Dokumente (Good Manufacturing Practices).

Entwicklungs- und Nutzungsdokumentation

Von der Entwicklung bis zur Nutzung eines Produktes ist es ein weiter Weg. Diesen protokolliert die Produktdokumentation vollständig. So gibt es die Entwicklungsdokumentation, die Anforderungsdokumente, Designdokumente oder Berichte zu Prototypen beinhaltet. Sie stellt also genau dar, welche Schritte ein Produkt in seiner Entwicklung durchlaufen hat.
Im Vergleich dazu beschreibt die Nutzungsdokumentation Endnutzern und Monteuren, wie sie mit dem Produkt sicher umgehen. Bestandteile sind Bedienungsanleitungen, Installationshinweise, Informationen zur Wartung und Sicherheitsinformationen.

Projekt- und Prozessdokumentation

Produktprozesse sind an Zeitpläne und Ziele geknüpft. Die Projekt- und Prozessdokumentation hält alle Planungen von der Produktentwicklung bis zur -produktion fest – einschließlich der Zeitpläne für die jeweiligen Umsetzungsschritte. Geschäfts- und Produktprozesse beschreibt die Aufzeichnung so, dass sie für die Herstellung des Produktes anwendbar sind.

Welche Inhalte hat eine Produktdokumentation?

Welche Bestandteile eine Produktdokumentation umfasst, ist vom zu dokumentierenden Produkt abhängig. So gibt es andere Anforderungen für die Produktdokumentation von technischen Anlagen und Maschinen im Vergleich zu einer Softwarelösung. Entsprechend unterscheiden sich auch die in der Produktdokumentation enthaltenen Stilmittel: Bild, Text und Zeichnungen sind klassische Elemente, die in ihr vorkommen.
Inhalte einer Produktdokumentation sind zum Beispiel:

• Produktbeschreibung
• Prototypenberichte und Änderungsprotokolle
• Fertigungsvorschriften
• Stücklisten (Bill of Materials)
• Zulassungsdokumente und Zertifikate
• Anleitungen für Nutzer und Installateure
• Konformitätserklärungen
• Risikobeurteilungen und Sicherheitshinweise
• Broschüren und Flyer

Produktdokumentationen enthalten also spezifische Informationen aus verschiedenen Bereichen, darunter Protokolle aus Audits, Marketingmaterialien oder Fertigungsvorschriften. Entsprechend vielseitig ist das Team, das Produktdokumentationen im Unternehmen umsetzt. Es besteht in der Regel aus Ingenieuren sowie technischen Redakteuren. Doch auch Marketing- und Vertriebsverantwortliche, Projektmanager oder, je nach Produkt, IT-Administratoren unterstützen die Produktdokumentation im interdisziplinären Austausch.

1. Bedarfe und Anforderungen analysieren

Gesetzliche Standards sowie die Anforderungen von Stakeholdern wie Kunden oder Lieferanten entscheiden über den Aufbau der Produktdokumentationen.
Zum einen bestimmen gesetzliche Standards, welche Dokumente verpflichtender Teil der Produktdokumentation sind. Zum anderen fordern Stakeholder weitere Dokumente an, die über das Produkt informieren. Insgesamt resultiert daraus eine verständliche und vollständige Dokumentation aller Daten im Produktlebenszyklus.

2. Prozessschritte und Inhalte dokumentieren

Die Inhalte einer Produktdokumentation stammen aus verschiedenen Quellen:

• Sicherheitsbeauftragte erstellen Sicherheitsdatenblätter und Risikobewertungen.
• IT-Administratoren protokollieren Änderungen in Datenbanken.
• Marketing- und Vertriebsteam liefern die fertigen Produktbroschüren.
• Projektmanager hinterlegen Projektpläne und Änderungsprotokolle.
• Rechtsberater übermitteln verpflichtende Zulassungsdokumente.
• Produktionsingenieure bestimmen Produktions- und Arbeitsanweisungen.
• Entwicklungsingenieure stellen die Konstruktionszeichnungen bereit.

Der technische Redakteur bereitet Inhalte wie Anleitungen, Beschreibungen und Sicherheitshinweise in Zusammenarbeit mit den verschiedenen Rollen so auf, dass sie einer einheitlichen und konsistenten Terminologie folgen.

3. Veröffentlichen und aktualisieren

Eine Produktdokumentation wird fortlaufend aktualisiert. Analog prüfen auch Produktverantwortliche wie Produktmanager, Führungskräfte und der technische Redakteur durchgehend, ob alle neuen Informationen korrekt vorliegen. Ist dies der Fall, genehmigen sie die Anpassung der Produktdokumentation und veröffentlichen sie.

Hersteller sind gesetzlich verpflichtet, für jedes Produkt eine Produktdokumentation anzufertigen. Jede Änderung am Produkt selbst oder im Prozess ist in der Produktdokumentation zu erfassen. Das macht die Produktdokumentation zu einem Nachweis: Hersteller zeigen, dass sie alle gesetzlichen Anforderungen an ein Produkt zu jeder Zeit erfüllt haben – also in der Produktentwicklung, Herstellung, Anpassung sowie Entsorgung.

Andersherum schützt die Produktdokumentation in der Funktion als Nachweis Hersteller vor Haftungsrisiken. Sie dokumentiert eindeutig, dass der Hersteller alle Schritte im Produktprozess compliant und gesetzeskonform umgesetzt hat.

Gesetzliche Vorschriften

Eine in der Produktdokumentation aufgeführte CE-Kennzeichnung ist zum Beispiel für viele Produkte verpflichtend, die Sie in der EU vermarkten. Richtlinien wie die Maschinenrichtlinie informieren darüber, ob Sie eine CE-Kennzeichnung benötigen. Kennzeichnungspflichtig sind grundsätzlich alle Produkte, die in den Anwendungsbereich der europäischen Richtlinie über Gesundheit, Sicherheit, elektromagnetische Verträglichkeit und Umweltschutz fallen.
Erst die Produktdokumentation ermöglicht es, behördliche Zulassungen und Zertifizierungen zu erhalten. Unternehmen der Pharmaindustrie sind zum Beispiel verpflichtet, GMP-Dokumente nachzuweisen. Sie dokumentieren Daten zur Produktion und Qualitätssicherung detailliert.

Produkthaftung

Besonders wichtig ist die Produktdokumentation für Hersteller jedoch in Hinblick auf die Produkthaftung. Im Falle einer Prüfung oder bei einem Schaden müssen Unternehmen die Produktdokumentation in Gänze nachweisen. Idealerweise weist sie genau nach, dass der Hersteller alle notwendigen Schritte unternommen hat, um Sicherheit und Qualität des Produkts zu gewährleisten.
Doch auch bei Qualitätsmängeln ist eine vollständige Produktdokumentation essenziell. Erst sie sichert die Rückverfolgbarkeit von Problemen. Fehler identifizieren Produktverantwortliche so auch noch in der Retrospektive. Ebenso hilft sie bei Rückrufaktionen, betroffene Produktbestandteile schnell und vor allem genau zu orten.

Wichtige Normen

Informationen sind in der Produktdokumentation so aufzuführen, dass sie den geltenden Normen entsprechen. Sie geben Auskunft darüber, wie Sie Informationen bereitstellen und welche Informationen Ihre Produktdokumentation enthalten. Das sind bekannte Normen explizit für die technische Produktdokumentation:

• Die IEC/IEEE 82079-1 definiert die allgemeinen Anforderungen an die Technische Dokumentation.
• Die DIN EN 82079-1 definiert, wie Sie Gebrauchsanleitungen erstellen müssen.
• Die ANSI Z535.6 definiert, welche Warn- und Sicherheitshinweise Sie aufführen müssen.
• Die DIN EN ISO 17100 definiert, wie Sie Technische Dokumentationen übersetzen, und informiert über mögliche Übersetzungssoftware.

Aufbewahrungsfristen

Produktdokumentationen sind im übergeordneten Sinne ein doppelter Nachweis. Auf der einen Seite weisen die Dokumente jeden einzelnen Schritt des Herstellers im Produktlebenszyklus nach. Auf der anderen Seite zeigt die Produktdokumentation auch, wo sich diese Nachweise befinden. Sprich: Sie gibt an, wo Sie Dokumente archivieren und verwalten.
Dies ist notwendig, da Produktdokumentationen Objekte sind, die gesetzlichen Aufbewahrungsfristen unterliegen. Produktdokumentationen bewahren Sie im Unternehmen für zehn Jahre auf. Inaktive Dokumente liegen im revisionssicheren Archiv.

Dokumentensammlungen einer Produktdokumentation verfolgen mehrere Ziele. Zunächst gewährleisten sie, dass ein Hersteller ein Produkt überhaupt auf den Markt bringen darf. Sie ist also eine Zulassungsvoraussetzung. Im weiteren Verlauf gewährleistet die Produktdokumentation die Rückverfolgbarkeit aller Schritte. Alle bereits abgeschlossenen Schritte sind in ihr dann so dokumentiert, dass sie jederzeit als Nachweis gegenüber Behörden oder Prüfungen sind.

Das und der ständige Fortlauf der Produktdokumentation erhöhen ihre Komplexität. Denn gleich mehrere Verantwortliche fügen wieder und wieder Dokumente zur Sammlung hinzu. Technische Redakteure bereiten sie dann verständlich auf – im Zweifelsfall sogar in mehreren Sprachen, sofern es sich um ein international vermarktetes Produkt handelt.

Zusammengefasst sind das Besonderheiten der Produktdokumentation:

• Gesetzliche Anforderungen zu jeder Zeit einhalten
• Dokumente in Echtzeit verwalten
• Produktdokumentationen standardisiert und verständlich aufbereiten
• Langzeitarchivobjekte mindestens zehn Jahre revisionssicher archivieren
• Verschiedene Produktbeteiligte auf demselben Stand halten
• Rückverfolgbarkeit von Produktdaten zu jeder Zeit garantieren

Ein Dokumentenmanagement-System (DMS) sammelt für Sie sämtliche Dokumente, die im Lebenszyklus eines Produktes entstehen. In ihm managen sie aktive Dokumente und archivieren inaktive Inhalte revisionssicher. Daraus resultieren für Sie drei Vorteile:

1. Ein DMS ist Management-Plattform und Archiv in einem.
2. Ein DMS automatisiert und beschleunigt Archivprozesse.
3. Ein DMS beschleunigt Workflows.

Ein solches DMS ist Doxis.

Was ist Doxis?

Doxis ist eine Enterprise-Content-Management-Plattform. Das bedeutet, dass Doxis Prozesse rund um Dokumente, Geschäfte und Kollaboration vereinheitlicht – und das systemübergreifend. Als DMS nutzen Sie Doxis zum Beispiel, um Produktdokumentationen zu erstellen, zu bearbeiten und zu archivieren. Damit ergänzt Doxis Ihr Product Information Management System (PIM). Für Sie ändert sich dadurch nichts: Sie arbeiten wie gewohnt im PIM, Doxis agiert im Hintergrund. So managen Sie Produktdokumentationen medienbruchfrei.

Hey Doxi, wie funktioniert Doxis als Software für Produktdokumentationen?

Produktdokumentationen beginnen mit der Idee eines Produkts und enden mit dessen Entsorgung. Im Grunde bildet die Produktdokumentation das gesamte Leben eines Produkts ab. Wie diese Dokumentation aussieht, entscheiden gesetzliche Anforderungen. Insbesondere Manufacturing Verticals müssen spezifische Anforderungen je nach Branche und Produktart in der Produktdokumentation berücksichtigen, um sie korrekt umzusetzen.

Grundsätzlich ist eine Produktdokumentation dann konsistent, wenn sie standardisiert vorliegt, übersetzbar ist, leicht verständlich ist und alle geltenden Anforderungen erfüllt. In Doxis verwalten Sie sämtliche Dokumente der Produktdokumentation so, dass Sie diese jederzeit bearbeiten und als Archivobjekt jederzeit nachweisen können.

Häufige Fragen zur Produktdokumentation