3D Models in Technical Documentation – How to Get Started

Have you ever wondered whether it’s really necessary to use 3D models in documentation? On the other hand, the 3D data from R&D already exists anyway, so it would be a shame were these data just left to gather dust in the PLM system. Read this blog post to find out what 3D models can do for product users and how you can implement them in your technical writing department.

Vorteil #1: Intensive Beschäftigung mit dem Produkt

3D-Modelle motivieren Produktanwender, sich mit der Anleitung zu befassen. Finden sie auf der Startseite ein interaktives 3D-Modell, erwacht der Spieltrieb. Nutzer haben die Möglichkeit, sich das Modell aus verschiedenen Blickwinkeln anzusehen und zu zoomen. So beginnen sie automatisch, sich mit den Produktfunktionalitäten und Sicherheitshinweisen auseinanderzusetzen, was den verantwortungsvollen Umgang mit dem Produkt fördert. Ein nicht zu unterschätzender Vorteil, denn viele Anleitungen verstauben leider ungelesen in einem Schrank oder auf einer CD.

Vorteil #2: Leichteres Erfassen von Informationen

3D-Modelle sind wesentlich anschaulicher und übersichtlicher als herkömmliche Grafiken. Sie erlauben es Anwendern, ihren Blickwinkel frei zu wählen und das Objekt aus jeder beliebigen Perspektive zu betrachten – ob von oben, unten oder einer Seite. Bei Abbildungen hingegen sind mehrere Grafiken nötig, um das Gerät komplett darzustellen. 3D-Modelle ersetzen so den Geräteüberblick mit den manchmal verwirrenden „Beigelungsgrafiken“.

Vorteil #3: Identifikation und Lokalisierung von Bauteilen

Durch 3D-Modelle gewinnt die Anleitung eine neue interaktive Dimension. Denn damit lassen sich verschiedene Schichten des Produkts ein- und ausblenden, sodass Kunden und Servicekräfte sukzessive immer tiefer in das Gerät sehen. Die exakte Identifikation und Lokalisierung der Bauteile ist so wesentlich einfacher.

Worauf Sie beim Einsatz von 3D in der Dokumentation achten sollten

Natürlich sollte man nicht verschweigen, dass 3D-Modelle einige Herausforderungen mit sich bringen. Wie sehen diese aus und wie lässt sich mit ihnen umgehen? Die beiden gravierendsten Punkte sind die Sicherheitsprobleme, die mit 3D-Modellen verbunden sind.

 

Metadaten bieten Angriffsfläche für Industriespionage

3D-Modelle enthalten Metadaten, die Ansatzpunkte für Industriespionage bieten. So können dort zum Beispiel die Namen der Konstrukteure eines Geräts enthalten sein und dann für Social Hacks genutzt werden. Oder die Metadaten verzeichnen die Toleranzen der Bauteile, eine begehrte Information für Produktpiraten. Bevor Sie 3D-Modelle nutzen, müssen Sie sicherstellen, dass alle für die Dokumentation unnötigen Metadaten gelöscht werden.

 

Produktdetails könnten vom Wettbewerb ausgelesen werden

Aber auch das 3D-Modell selbst ist ein Ansatzpunkt für Industriespionage und Reverse Engineering, enthält es doch den kompletten Geräteaufriss des Produkts. Um zu verhindern, dass ein Wettbewerber die relevanten Daten ausliest, müssen die Abmessungen unkenntlich gemacht werden. Dafür halten moderne M-CAT-Systeme eine Funktionalität bereit, mit der Geometrien innerhalb gewisser Grenzen zufallsgesteuert umgeschrieben werden. Der Vorteil: Die Daten werden nicht nur verborgen, sondern komplett zerstört. Für einen Reverse-Engineering-Versuch sind diese 3D-Modelle nicht mehr geeignet; es wäre dann sogar einfacher, sich eine der Maschinen zu besorgen und diese zu analysieren.

 

Entwicklung modelliert Produkt unter Umständen nicht komplett

Daneben kann es auch noch kleinere Probleme geben, zum Beispiel dass in der Entwicklung, die die 3D-Modelldaten liefert, nicht immer alle Teile des Endgeräts modelliert werden. Oft fehlen zugekaufte Standardteile wie Hydraulik-Schläuche oder Steckverbindungen. In der Redaktion sollten Sie dies vor der Entscheidung für ein 3D-Modell prüfen und klären, ob Sie ohne diese Teile auskommen oder sie nachmodellieren können.

 

So kommen 3D-Modelle in die Technische Redaktion

In vielen produzierenden Unternehmen sind 3D-Daten bereits vorhanden. Normalerweise werden 3D-Modelle bereits während der Produktentwicklung erstellt. Typischerweise kommen M-CAT-Systeme wie Autodesk Inventor oder Solid Edge zum Einsatz. Einmal erstellt, werden die Modelle normalerweise in ein Product-Lifecycle-Management-System (PLM) eingepflegt. Dort lassen sich die verschiedenen Versionen und weitere ergänzende Daten verwalten.  

Außerdem wird während der Produktentwicklung meist im ERP-System eine Engineering Bill of Materials (EBoM) zusammengestellt. In ihr sind alle Bauteile und Materialien eines Geräts erfasst; sie ist quasi die „Landkarte“ und das Inventar für das Gesamtprodukt. 

Mit den Modellen und der EBoM hätten wir nun eigentlich alles Notwendige für die Technische Redaktion beisammen. Allerdings sind die 3D-Modelle für einen Einsatz in der Technischen Redaktion bei weitem überdimensioniert. Oft besteht ein einzelnes Modell aus mehreren hundert GB an Daten. Für die Anwendung in der Redaktion und für die Publikation zum Beispiel auf einer Website sind diese Modelle also (noch) nicht geeignet. 

 

3D-Modelle als Technischer Redakteur bearbeiten

Manchmal liegen 3D-Modelle bereits in datensparsameren „Lightweight“-Formaten vor. Das ist zum Beispiel der Fall, wenn das System für den Ersatzteilkatalog (ETK) mit 3D-Modellen arbeitet. In diesem Fall setzt  die Redaktion bereits auf einem vollständigen Datenbestand auf.  

Gibt es bisher keine solchen Lightweight-Formate im Unternehmen, lassen sich die 3D-Modelle in der Redaktion transformieren. Dazu finden sich auf dem Markt Autorentools für die Zweitverwertung von 3D-Modellen. Der Vorteil dieser Software: Die Lizenzkosten sind deutlich niedriger als bei Komplettsystemen und gleichzeitig sinkt durch den geringeren Funktionsumfang die Einarbeitungszeit für die Redakteure. Wichtig bei der Auswahl ist vor allem, dass die Software die Randomisierung der Abmessungen und die Entfernung von Metadaten beherrscht. 

 

3D-Modelle im Redaktionssystem

In der Redaktion gilt es nun zu definieren, auf welchem Weg die Nutzer die Anleitungen mit den 3D-Modellen präsentiert bekommen: als 3D-PDF oder als HTML-Anwendung. Mittlerweile stellt HTML den Standard für die Publikation von Anleitungen mit 3D-Modellen dar. Der Viewer für die Modelle wird meist von den 3D-Autorentools mitgeliefert und lässt sich bequem als JavaScript in die Webseite einbinden. Es gibt also keinen kundenseitigen Installationsaufwand – eine Anforderung, die andernfalls die Nutzung der 3D-Dokumente scheitern ließe. Allerdings ist diese Lösung nur auf Webservern möglich; filebasierte, statische Dokumentation (zum Beispiel als Auslieferung auf einer DVD) muss deshalb meist weiterhin auf 3D-PDF zurückgreifen.  

Für die Verwendung der 3D-Modelle auf Webseiten wird der Standard WebGL eingesetzt. Er ermöglicht eine performante Darstellung, die auch auf einem Mittelklasse-PC ohne Leistungseinbußen gelingt. WebGL ist ein Standard, den alle gängigen Autorentools als Exportformat beherrschen.  

Nach dem Export werden die 3D-Modelle als Ressourcen in das Redaktionssystem der Technischen Redaktion importiert. Dort lassen sie sich, ähnlich wie Bilder und Videos, aus dem Content heraus referenzieren.  

In SCHEMA ST4 erkennt das System automatisch, dass an der referenzierenden Stelle 3D-Content eingebunden wurde. SCHEMA ST4 berücksichtigt dies dann bei der Produktion der Zielformate und erzeugt automatisch den angepassten JavaScript-Code, der für die Darstellung des Modells sorgt. Diese Funktionalität ist grundsätzlich bereits in SCHEMA ST4 enthalten und out of the box nutzbar. Im Online Media Designer (OMD) können erfahrene Anwender darüber hinaus die Funktionalität selbst anpassen und noch zielgenauer auf ihre Bedürfnisse zuschneiden. 

 

Fazit: 3D in der Technischen Dokumentation eröffnet neue Möglichkeiten

Insgesamt zeigt sich: Die Arbeit mit 3D-Modellen ist einfacher als viele vielleicht im ersten Moment denken. Oft liegen bereits nutzbare Daten im Unternehmen vor. Und selbst wenn diese noch nicht vorhanden sind, lässt sich mit ein wenig Einarbeitung ein Lightweight-Modell erstellen. Die Handhabung im Redaktionssystem ist danach nur noch ein Kinderspiel. Der Weg ist also für alle Redaktionen frei, um die Power von 3D in der Technischen Dokumentation zu entfesseln. 

 

Sie möchten mehr erfahren? Sehen Sie sich unser Webinar zu 3D in der Technischen Doku an!

Conclusion: 3D models open up new possibilities in technical documentation

All in all, working with 3D models is much easier than you might think at first. Often there are already usable data available in the company. And even if these are not yet available, a lightweight model can be created with a little training. After that, handling in the content management system is a breeze. The way is therefore clear for all technical writers to unleash the power of 3D in technical documentation.