Technische Dokumentation verwalten: Warum Hersteller andere Anforderungen haben als Händler
Technische Dokumentation und technische Dokumente zu verwalten klingt zunächst einfach.
Schließlich liegen am Ende immer Dateien vor:
- Datenblätter
- Montageanleitungen
- Betriebsanleitungen
- Konformitätserklärungen
- Zertifikate
- Sicherheitsdokumente
Deshalb liegt die Vermutung nahe, dass technische Dokumentation hauptsächlich ein Thema für Dokumentenmanagement-Systeme oder MAM-Systeme ist.
In der Praxis zeigt sich jedoch schnell:
Die eigentliche Herausforderung liegt selten in der Datei selbst.
Die eigentliche Herausforderung liegt in den fachlichen Beziehungen zwischen den Dokumenten.
Genau hier unterscheiden sich Hersteller und Händler grundlegend.
Händler verwalten Dokumente.
Hersteller verwalten zusätzlich die Regeln und Beziehungen hinter den Dokumenten.
Technische Dokumente verwalten aus Sicht eines Händlers
Für Händler, Distributoren oder Großhändler ist ein Dokument meist eine zusätzliche Information zu einem Produkt.
Typischerweise sieht das Datenmodell so aus:
Produkt
├─ Datenblatt.pdf
├─ Bedienungsanleitung.pdf
├─ Sicherheitsdatenblatt.pdf
└─ Zertifikat.pdf
Die zentrale Frage lautet:
Welches Dokument gehört zu welchem Produkt?
In vielen Fällen reicht diese Zuordnung vollständig aus.
Die technische Dokumentation wird vom Hersteller bereitgestellt.
Der Händler muss sie lediglich verwalten, bereitstellen und aktuell halten.
Warum Händler trotzdem Regeln benötigen
Auch Händler benötigen Geschäftslogik.
Allerdings konzentriert sich diese Logik häufig auf die Aktualität der Dokumente.
Typische Anforderungen:
- Wer hat das Dokument zuletzt geprüft?
- Wann muss eine erneute Prüfung erfolgen?
- Existiert bereits eine neuere Version?
- Wer ist für die Pflege verantwortlich?
Oft werden deshalb Prüfzyklen und Wiedervorlagen eingerichtet.
Wird ein festgelegtes Datum erreicht, erscheint das Dokument automatisch auf einer Arbeitsliste und muss erneut überprüft werden.
Die Geschäftslogik des Händlers dient in erster Linie dazu, Aktualität und Verfügbarkeit sicherzustellen.
Technische Dokumentation verwalten aus Sicht eines Herstellers
Hersteller befinden sich in einer vollkommen anderen Situation.
Hersteller konsumieren Dokumente nicht.
Sie erzeugen und verantworten Dokumente.
Dadurch entstehen zusätzliche Anforderungen:
- Mehrsprachigkeit
- Versionsverwaltung
- Freigabeprozesse
- Dokumentnummern
- Produktfamilien
- Dokumentfamilien
- Veröffentlichungsregeln
- Konsistenzprüfungen
Die Frage lautet deshalb nicht mehr:
Welches Dokument gehört zu welchem Produkt?
sondern:
Welche Dokumente gehören fachlich zusammen?
Reicht ein MAM-System für technische Dokumentation aus?
Viele Hersteller suchen zunächst nach einem MAM-System (Media Asset Management) oder einer Lösung zur Dokumentenverwaltung.
Das ist nachvollziehbar. Technische Dokumentation besteht schließlich aus Dateien wie Datenblättern, Montageanleitungen, Zertifikaten, Konformitätserklärungen oder Sicherheitsdokumenten.
Ein MAM-System eignet sich hervorragend, um solche Dateien zentral zu speichern, zu organisieren und bereitzustellen.
Typische Aufgaben eines MAM-Systems sind die Verwaltung von PDFs, Bildern, Medienobjekten, Versionen und technischen Dokumenten.
Für Hersteller reicht die reine Dokumentenverwaltung jedoch häufig nicht aus.
Die eigentliche Herausforderung besteht oft nicht darin, einzelne Dateien zu verwalten, sondern die fachlichen Beziehungen zwischen den Dokumenten abzubilden.
Sobald technische Dokumentation mehrsprachig wird oder mit Produkten, Produktfamilien und Freigabeprozessen verknüpft werden muss, entstehen zusätzliche Anforderungen:
- Sprachversionen verwalten
- Dokumentfamilien bilden
- Produktbezüge automatisch pflegen
- Freigaberegeln definieren
- Dokumentnummern erzeugen
- Konsistenzregeln überwachen
Ein MAM verwaltet in erster Linie Dateien.
Hersteller müssen zusätzlich die Geschäftslogik hinter den Dokumenten verwalten.
Deshalb stoßen klassische MAM-Systeme bei komplexer technischer Dokumentation häufig an Grenzen. Entscheidend ist nicht nur, wo ein Dokument gespeichert wird, sondern welche fachlichen Beziehungen zwischen den Dokumenten bestehen und welche Regeln dabei gelten.
Die Herausforderung: Mehrsprachige Dokumente
Betrachten wir eine Montageanleitung.
Im Unternehmen existieren eventuell:
- Montageanleitung DE
- Montageanleitung EN
- Montageanleitung FR
- Montageanleitung IT
- Montageanleitung CZ
Nun stellt sich eine entscheidende Frage:
Sind das fünf Dokumente?
Oder ist es ein Dokument mit fünf Sprachversionen?
Die Antwort bestimmt das gesamte Informationsmodell und damit das zugrunde liegende kanonische Datenmodell.
Warum Geschäftslogik wichtiger ist als Dateiverwaltung
Sobald Dokumente zusammengehören, entstehen Regeln.
Beispielsweise:
Jede Sprache darf nur einmal vorkommen
Erlaubt:
DE
EN
FR
IT
CZ
Nicht erlaubt:
DE
DE
EN
FR
Diese Regel beschreibt keine Dateiverwaltung.
Die Regel beschreibt die fachliche Realität.
Kein Anwender sollte entscheiden müssen, welches von zwei deutschen Dokumenten gültig ist.
Eine Geschäftsregel erkennt den Fehler automatisch und meldet die Inkonsistenz.
Gemeinsame Eigenschaften vererben
Alle Sprachversionen besitzen häufig dieselben Eigenschaften:
- Dokumenttyp
- Produktfamilie
- Freigabestatus
- Veröffentlichungsregeln
- Beschreibungen
Diese Informationen müssen nicht mehrfach gepflegt werden.
Stattdessen können sie zentral definiert und automatisch übernommen werden.
Das reduziert Pflegeaufwand und erhöht die Konsistenz.
Dokumentnummern automatisch erzeugen
In vielen Unternehmen werden Dokumentnummern manuell vergeben. Dadurch entstehen häufig Tippfehler, Dubletten oder uneinheitliche Nummernkreise.
In einem Informationsmodell können Dokumentnummern automatisch aus vorhandenen Informationen erzeugt werden, beispielsweise aus einer Dokumentenfamilie und der zugehörigen Sprache. Die zugrunde liegende Geschäftsregel lässt sich in einer Entscheidungslogik (Decision Engine) definieren.
Die Nummer entsteht damit nicht durch manuelle Eingabe, sondern durch eine definierte Geschäftsregel.
Hersteller brauchen Dokumentenmanagement plus Geschäftslogik
Hier liegt der entscheidende Unterschied.
Ein Datenmodell beschreibt:
- Dokumente
- Produkte
- Sprachen
- Kategorien
Geschäftslogik beschreibt:
- Regeln
- Beziehungen
- Berechnungen
- Plausibilitätsprüfungen
- Vererbungen
- Freigaben
Erst die Kombination aus Datenmodell und Geschäftslogik bildet die Realität eines Herstellers korrekt ab.
Dokumentenmanagement für Hersteller ist mehr als Dateiverwaltung
Ein Händler konzentriert sich typischerweise auf:
- Dokumentbereitstellung
- Aktualität
- Verfügbarkeit
- Produktzuordnung
Ein Hersteller zusätzlich auf:
- Mehrsprachigkeit
- Dokumentfamilien
- Freigaben
- Nummernkreise
- Konsistenzregeln
- fachliche Beziehungen
Beide verwalten Dokumente.
Aber sie verwalten unterschiedliche Realitäten.
Warum klassische Dokumentenverwaltung oft an Grenzen stößt
Je komplexer technische Dokumentation wird, desto wichtiger werden Geschäftsregeln.
Sprachversionen, Dokumentfamilien, Freigaben, Vererbungen und automatische Dokumentnummern lassen sich nur eingeschränkt über eine reine Dateiverwaltung abbilden.
Ein Hersteller muss deshalb nicht nur Dokumente verwalten, sondern auch die fachlichen Regeln hinter den Dokumenten modellieren.
Erst das Zusammenspiel aus Datenmodell, Dokumentenmanagement und Geschäftslogik bildet die Realität eines Herstellers vollständig ab.
Fazit
Wer technische Dokumentation verwalten möchte, benötigt mehr als einen Speicherort für Dateien.
Ein MAM-System kann Dokumente speichern und organisieren.
Hersteller müssen darüber hinaus die fachlichen Beziehungen und Regeln hinter den Dokumenten verwalten:
- Sprachversionen
- Dokumentfamilien
- Freigaben
- Nummernkreise
- Konsistenzprüfungen
- Veröffentlichungsregeln
Die eigentliche Herausforderung liegt deshalb nicht in den PDFs.
Die eigentliche Herausforderung liegt in der Geschäftslogik hinter den Dokumenten.
Dateien sind das Ergebnis.
Geschäftslogik erzeugt dieses Ergebnis. Wer nur Dateien verwaltet, bildet die fachliche Realität eines Herstellers nur unvollständig ab.