Technische Dokumentation: So wird aus Pimcore ein Redaktionssystem

Betriebsanleitungen im Maschinen- und Anlagenbau, Software-Dokumentationen oder Serviceanleitungen in der Automobil-Industrie: In der Technischen Dokumentation erstellen wir vielfältige, anleitende Inhalte für zum Teil sehr komplexe Technik-Produkte. Diese Art des Contents und der Content-Erstellung steht bei der Verwendung der Datenmanagement-Software Pimcore üblicherweise nicht im Fokus,

Betriebsanleitungen im Maschinen- und Anlagenbau, Software-Dokumentationen oder Serviceanleitungen in der Automobil-Industrie: In der Technischen Dokumentation erstellen wir vielfältige, anleitende Inhalte für zum Teil sehr komplexe Technik-Produkte. Diese Art des Contents und der Content-Erstellung steht bei der Verwendung der Datenmanagement-Software Pimcore üblicherweise nicht im Fokus. Allerdings ist die Software sehr flexibel und individuell anpassbar. Das ermöglichte es unseren Entwicklern bei TANNER, ein schlankes, kostengünstiges Redaktionssystem zu erschaffen, mit dem auch Personen ohne tiefere System-Kenntnisse Technische Dokumentation erstellen können.

Warum Pimcore gut zu den Besonderheiten Technischer Dokumentation passt

Ob Montageanleitung oder Onlinehilfe – anleitende Technik-Inhalte dienen sowohl der genauen und verständlichen Instruktion der Produktanwender als auch der haftungsrechtlichen Absicherung des Herstellers. In Inhalt und Form sind technische Informationen daher stark reglementiert. Terminologie, Stil, Grammatik, Syntax sowie der inhaltliche Aufbau folgen klaren Regeln, die auf Eindeutigkeit, Verständlichkeit und Übersetzbarkeit abzielen. Phrasen oder Füllwörter sind unerwünscht. Der Content Technischer Dokumentationen ist in der Formulierung nicht so frei und vielfältig wie beispielsweise marketingorientierte Inhalte für den E-Commerce.

Die starke fachliche Struktur von Technik-Inhalten passt sehr gut zur Strukturiertheit eines PIM-Systems. Das und die 100-prozentige Individualisierbarkeit von Pimcore machen wir uns bei unserem schlanken Redaktionssystem zunutze. Dabei verwenden wir die Pimcore-Objekte, -Module und -Beziehungen, um damit die inhaltliche Struktur der jeweiligen Anleitung aufzubauen und die Eingabemasken für die Nutzer des Redaktionssystems zu erstellen. Anstatt wie bei der Datenmodellierung in den Eingabemasken Felder für Produktmerkmale (z. B. Name, SEO-Name, Preis usw.) zu definieren, verwenden wir Freitextfelder. Module für strukturierte Produktdaten werden so zu Modulen für frei formulierbare Texte.  

Eine Betriebsanleitung im PIM-System schreiben

Ich verdeutliche das Prinzip an einer Betriebsanleitung. Diese muss klare inhaltliche Vorgaben erfüllen. Sie enthält standardmäßig Inhalte wie Vorbedingungen, Personalqualifikation, Hinweise zur Installation, Wartung, Störungsbeseitigung, Reinigung, Warnhinweise usw.

Unsere Betriebsanleitung ist im Pimcore-Redaktionssystem ein Objekt. Dieses enthält Module für alle Inhalte, die in der Anleitung vorgesehen sind. Die Reihenfolge der Module bestimmt die Struktur dieses Objekts. In den Modulen finden sich Freitextfelder für die zu schreibenden Informationen. Diese Felder sind aussagekräftig benannt und mit Hinweisen für den Nutzer des Redaktionssystems versehen.

Intuitiv und sicher in der Handhabung

In einem Warnhinweis müssen beispielsweise die Art bzw. Quelle der Gefahr, die Folgen und Handlungsaufforderungen vermittelt werden. Für jede dieser Informationen gibt es ein separates Freitextfeld. Das vereinfacht die Erstellung der notwendigen Informationen und stellt sicher, dass nichts vergessen wird. Die Handhabung dieses Redaktionssystems ist leicht verständlich und intuitiv, vergleichbar mit der eines CMS-Systems wie Wordpress. Das ermöglicht es auch Personen mit wenig Erfahrung bei der Verwendung von Redaktionssystemen, Technische Dokumentation systemgestützt zu erstellen.

Effiziente Verwertung von Produktinformationen

Für das Erstellen von Technischer Dokumentation übernehmen wir das Grundprinzip des Datenmanagement-Systems und nutzen damit viele Funktionen, die dieses bietet. Eine als Pimcore-Objekt erstellte Anleitung ist modular, ihre einzelnen Inhalte sind somit flexibel wiederverwendbar. Die technischen Daten eines Produkts werden beispielsweise sowohl in den Produktdaten benötigt als auch im entsprechenden Kapitel in der Technischen Dokumentation. Einmal angelegt, kann dieser Inhalt an allen relevanten Stellen ausgespielt und zentral aktuell gehalten werden – nach dem gleichen Prinzip, wie wir es vom Produktdaten-Management im PIM-System kennen. Da die Inhalte in diesem System medienneutral vorliegen, können sie leicht für das Ausspielen in unterschiedliche Print- und Online-Medien aufbereitet werden.

Verwaltung der Inhalte mit dokumentationsrelevanten Funktionen

Darüber hinaus nutzen wir spezielle Funktionen von Pimcore, die für die Technische Dokumentation erweitert wurden. Ein Beispiel dafür ist das optimierte Übersetzungsmanagement mit Statusverwaltung. Mit diesem Feature wird immer das ganze Dokument zur Übersetzung gegeben. Es können aber nur die Teilbereiche bearbeitet werden, die dafür freigegeben sind. Der Status hält die Redakteure stets auf dem Laufenden. „Nicht übersetzt“, „In Übersetzung“, oder „Übersetzt & aktuell“ geben Aufschluss über den aktuellen Stand. Auch der Freigabeprozess von Dokumenten und der darin enthaltenen Bestandteile ist dank Status-Angabe leicht verständlich und übersichtlich. Ein weiteres Feature ist der optimierte Vergleich von Dokumentversionen. Mit diesem werden Änderungen zwischen zwei Versionen direkt im Layout des Dokuments sichtbar gemacht.

Alle Technik-Informationen sind aktuell und nutzbar

Die Verwendung von Pimcore als Redaktionssystem hat noch mehr Vorteile, insbesondere wenn die Software bereits für die Verwaltung von Produktinformationen im Einsatz ist. Üblich ist es in dem Fall, die von der Technischen Redaktion erstellten Dokumente als Assets ins PIM-System zu laden und mit den relevanten Produktinformationen zu verknüpfen. Bei diesen Assets handelt es sich meist um PDF-Dokumente, also fertig publizierte Medien. In dieser Form sind die Inhalte allenfalls lesbar, nicht aber weiter nutzbar für andere Kanäle. Infolgedessen werden zwar Produktinformationen aktuell gehalten, Änderungen in der Technischen Dokumentation verursachen aber oft hohe Logistik- oder Druckaufwände. Dieser Konflikt besteht nicht, wenn die Erstellung der Technischen Dokumentation mit der Produktdaten-Welt in einem System vereint wird.

Digitalisierung im Unternehmen vorantreiben

Sind sämtliche Informationen über ein Produkt inklusive dessen Technische Dokumentation für alle Abteilungen im Unternehmen zugänglich und leicht auffindbar, optimiert das viele Prozesse – sei es die Übersetzung von Inhalten oder deren Verwendung im Marketing, im Vertrieb usw. Aufwände, Kosten und Durchlaufzeiten werden gesenkt. Die Qualität und Nutzbarkeit der Daten wird erhöht, die Digitalisierung im Unternehmen vorangetrieben.

Ein Redaktionssystem in Pimcore ist schnell implementiert und dazu kostengünstiger und einfacher in der Bedienung als ein professionelles Redaktionssystem mit großem Funktionsumfang. Nicht nur Fachleute im redaktionellen Schreiben, sondern auch jeder Entwickler, Produktmanager oder Servicemitarbeiter ist in der Lage, dieses Redaktionssystem für die Erstellung technischer Inhalte zu nutzen.

Produktdaten und auch die Technische Dokumentation werden heute digital benötigt. Was liegt näher, als die Flexibilität von Pimcore zu nutzen, um diese Inhalte direkt hier zu erstellen, damit sie überall im Unternehmen und auf allen Vertriebs- und Service-Kanälen nutzbar sind?

Über die TANNER AG 

Die TANNER AG ist führender Dienstleister für Technik-Kommunikation. Als Komplettanbieter unterstützt sie seit über 35 Jahren Konzerne und mittelständische Unternehmen in Marketing, Vertrieb und After-Sales. Mit relevanten Inhalten, wirkungsstarkem Design, digitalen Tools sowie mit IT-Verfahren und IT-Infrastrukturen für die effiziente Umsetzung von Digitalisierungsstrategien. TANNER-Kunden kommen aus allen B2B-Branchen.

Hauptsitz des Unternehmens ist Lindau am Bodensee. Darüber hinaus hat die TANNER AG acht weitere Standorte in Deutschland sowie Tochterunternehmen in der Schweiz und Vietnam. Mit mehr als 180 Spezialistinnen und Spezialisten erarbeitet das Unternehmen mit modernen Verfahren und Tools individuelle Kommunikationslösungen.

Want to submit a guest post to Pimcore's Blog?

It has over 4,000 subscribers and attracts more than 280,000 monthly visits, and we're always looking for more brilliant contributors to join our ranks. Contact us.

Alexander Witzigmann
  • CTO
1 Artikel von diesem Autor

Mehr Pimcore Neuigkeiten entdecken

A variety of businesses are looking at the possibility of adding a TMS during the PIM conception phase to add value in the realm of knowledge management; this indicates their...
February 24, 2020
How can you scale your digital commerce to the next level? Multilingual, Multistore, Multi-currency, Multi-everything. If you want your commerce not just to survive, but to live...
May 19, 2020
With the help of DeepL, Asioso developed a free module for Pimcore to make the work of its customers more efficient.
June 26, 2020
Das deutsche Software-Unternehmen Bit&Black entwickelt für Pimcore eine Extension, die es Pimcore-Anwendern ermöglicht, Inhalte als IDML-Dokument zu exportieren. Die Extension...
August 04, 2020

82.000+ Unternehmen vertrauen auf Pimcore. Entdecken Sie die 250+ beliebtesten Stories.