Der richtige Umgang mit Zuliefererdokumentation
Wie behandle ich Zuliefererdokumentation in meiner Technischen Dokumentation?
Dies ist eine häufig gestellte Frage von technischen Redakteuren, wenn sie eine Technische Dokumentation für ein Produkt erstellen. Es ist zwar bekannt, dass die Dokumentation eines Produktes nicht nur aus einer Betriebsanleitung besteht, aber nur wenige wissen, dass es für den sicheren Betrieb nicht ausreicht, die Technische Dokumentation der Komponentenzulieferer einfach nur bei zuheften.
Das Ziel des Technischen Redakteurs muss es sein, aus den Betriebsanleitungen der einzelnen Baugruppen eine in sich schlüssige Gesamtanleitung zu erstellen, die auch die Auswirkungen des Zusammenspiels von neuen Komponentenverknüpfungen beschreibt.
Die Integrationstiefe der Zuliefererdokumentation richtet sich nach der Zielgruppe.
Einfache Tätigkeiten, die meist von Hilfskräften oder Bedienern ausgeführt werden, müssen detaillierter und möglichst ohne Querverweise auf andere Quellen integriert werden.
Bei Fachkräften kann der Technische Redakteur voraussetzen, dass aufgrund der fachlichen Vorbildung das Auffinden von Querverweisen möglich ist und somit keine detaillierte Integration der Zuliefererdokumentation nötig ist.
Als Integration von Informationen in die Technische Dokumentation wird nicht das Abschreiben von Zuliefererdokumentation verstanden. Vielmehr ist es eine sinnvolle Einarbeitung der zielgruppengerechten Textpassagen, die ein sicheres Arbeiten mit und am Produkt gewährleisten.
Möchte der Technische Redakteur auf ein bereits vorhandenes Dokument verweisen, reicht es nicht aus, auf das Dokument im Gesamten zu verweisen.
Ein guter Verweis gliedert sich in:
• Kapitel
• Unterkapitel
• Text-, Grafik- oder Tabellenpassage
Sicherheitsrelevante Informationen aus Zuliefererdokumentationen müssen in die eigene Technische Dokumentation integriert werden. Ein Verweis darauf ist nicht zulässig!