Individuelle Dokumentation – Step by Step

Sarah Lukoszek Als Senior Consultant bei Fischer ist es meine Aufgabe, Sie auf dem Weg in die digitale Zukunft zu unterstützen.

Step by Step zur individuelle Dokumentation. Lernen Sie mit diesem spannenden Artikel Ihren Redaktionsprozess zu optimieren!

Inhaltsverzeichnis:

    Ein intuitiv nutzbares Varianten-, Variablen- und Änderungsmanagement ist ein wichtiger Baustein der modernen Technischen Redaktion. Insbesondere im Sondermaschinenbau stellt die Vielfalt der Produkte für eine individuelle Dokumentation eine große Herausforderung dar. So vielseitig wie die Varianten sind auch die Aussagen, die in diesem Zusammenhang getroffen werden:
    Die Spanne reicht von „Individualisierte Dokumentation ist bei uns Pflicht – aber an der Effizienz müssen wir noch stark arbeiten.“ über „Natürlich könnten wir unsere Dokumentation auch individualisiert drucken. Die Kunden wünschen sich das und das Marketing natürlich auch. Aber die Druckkosten wären ca. 5x höher und keine Kostenstelle im Unternehmen übernimmt das!“ bis hin zu „Wir erwarten einen Anstieg der Auftragseingänge, d.h. wir haben auch in der Redaktion eine höhere Auslastung, bekommen aber nicht mehr Ressourcen. Wie können wir die Redaktion darauf vorbereiten und die Durchlaufzeiten pro Auftrag senken?“

    Je mehr man sich mit der Branche auseinandersetzt und Technische Redakteure zu diesem Thema interviewt, desto deutlicher wird es, dass der Umgang mit dem Variantenmanagement sehr unterschiedlich ist. Gründe hierfür gibt es Zahlreiche. In erster Linie ist dies auf die verschiedenen Schwerpunkte zurückzuführen, die in einem Unternehmen gesetzt werden.
    Außerdem befindet sich jedes einzelne Unternehmen in einer anderen Entwicklungsstufe. Ein Anlagenbauer nutzt vielleicht schon ein effektives Variantenmanagement und möchte nun noch schneller und effizienter in der Dokumentation werden. Andere Unternehmen stecken mit ihrer Technischen Redaktion noch in den Kinderschuhen und müssen das Variantenmanagement erst aufbauen. Ihre firmenspezifische Ausgangslage ist ausschlaggebend, wenn Sie Step by Step Ihren Weg zur individualisierten Dokumentation gehen.
    Zudem gibt es verschiedene Faktoren, die eine variantenreiche Dokumentation hervorbringen und beeinflussen. Je nachdem in welchem Umfeld bzw. welcher Branche sich ein Unternehmen befindet, müssen gezwungenermaßen verschiedene Variantenarten in Betracht gezogen werden.

    Welche Variantenarten gibt es?

    Grundsätzlich können wir folgende Variantenarten unterscheiden

    • Produktvarianten bzw. Produktkonfiguration
    • Baustände/Baujahre/Fertigungsjahr
    • Software-Stände
    • Sprachvarianten (z.B. spanische Betriebsanleitung)
    • Zielgruppenspezifische Varianten (z.B. Wartungsanleitung)
    • Lokalisierungen (z.B. Anleitungen für den US-Markt)
    • Formatabhängige Varianten (z.B. Online-Hilfe)
    • Kundenspezifische Varianten (z.B. OEM-Layout)

    Der Redaktionsprozess

    Die Säulen einer qualitativ hochwertigen, individualisierten Dokumentation bildet der Redaktionsprozess mit seinen einzelnen Schritten. Um am Ende ein gutes Ergebnis und somit eine gelungene Dokumentation zu garantieren, muss jeder einzelne Schritt stimmen. Mit einer guten Organisation legen Sie den Grundstein, um langfristig nachvollziehen zu können, welche Informationen für welche Varianten genutzt werden. Selbiges gilt auch für die Erstellung. Auch an diesem Punkt muss die richtige Arbeit mit den Varianten beachtet werden. Der Umgang mit den Varianten beeinflusst dabei direkt den Reviewprozess und natürlich auch die gesamte Übersetzungen. Insbesondere das Handling unterschiedlicher Sprachen ist ein Paradebeispiel für die Arbeit mit einer variantenreichen Dokumentation.

    In den letzten Jahren stellt man vermehrt fest, dass es bei der Bereitstellung von Informationen nicht nur darum geht, PDFs für die einzelnen Produktvarianten zu veröffentlichen. Neue Zielgruppen mit dementsprechend geänderten Anforderungen, neue Bereitstellungsformate und neue Medien zur Informationsdarstellung – all das hat einen großen Einfluss auf die Arbeit eines Technischen Redakteurs. Damit einher geht ein neuer Variantenreichtum, welcher effizient bedient werden muss. Wir sehen also: Varianten, beeinflussen den gesamten Prozess und müssen somit in jedem Prozessschritt beachtet und korrekt gehandhabt werden.

    Nur so entsteht ein Prozess, der die Arbeit mit vielen Varianten unterstützt und gleichzeitig zu bestmöglichen Ergebnissen führt. Doch ein auf Varianten ausgelegter Prozess ist nur die halbe Miete. Sie kennen es bestimmt: so lange das Konzept für die Arbeit und einige Regeln dazu nicht im Redaktionsleitfaden dokumentiert sind, ist es schwierig, teamübergreifend mit gleicher Qualität zu arbeiten. Denn hinter jedem gut funktionieren Prozess steckt ein Dokumentationskonzept.

    Was macht ein gutes Dokumentationskonzepts aus?

    • Zielgruppen und Informationsbedarf – machen Sie sich Gedanken darüber, für wen Sie eigentlich schreiben.
    • Informationsmodell und Strukturierungsmethode – wie dokumentiere Sie? Welches Informationsmodell verwenden Sie?
    • Modul- und Variantenmatrix – die Frage aller Fragen, was dokumentieren Sie? Wenn Sie dies wissen, können Sie zu einem späteren Zeitpunkt eine Modul- und Variantenmatrix aufspannen, die die Inhalte definiert.
    • Schnittstellen – wo bekomme Sie Ihre Informationen her? Wer sind die passenden Ansprechpartner in der Entwicklung oder beispielsweise im Marketing. Aber auch technische Schnittstellen sind von Bedeutung. Haben Sie ein ERP, an das Sie sich andocken müssen, um Daten zu ziehen oder zurückzuspielen?  
    • Bereitstellung – auf welche Art und Weise stellen Sie diese Informationen zur Verfügung? Beispiele sind Maschinendisplays, PDF oder Onlinehilfen für Software.  

    Genau diese fünf Themenbereiche sollten Sie sich anschauen, wenn Sie ein gutes Dokumentationskonzept aufstellen wollen. Sie sind eng miteinander verwoben und beeinflussen einander. Die verschiedenen Zielgruppen und deren Informationsbedarf beeinflussen direkt die Modul- und Variantenmatrix. Werden Sie sich darüber bewusst, je mehr Zielgruppen Sie haben, desto größer ist die Modulmatrix. Von Ihrer Zielgruppe bzw. dem Informationsbedarf dieser hängt ebenfalls das Strukturierungsmodell ab, das Sie entwerfen. Wenn Sie mehr Zielgruppen und einen höheren Informationsbedarf haben, wird sich das Funktionsdesign deutlich unterscheiden. Das liegt daran, dass Sie weitere Sequenzierungsmuster benötigen oder unterschiedliche Handbuchtypen erstellen müssen. Die Zielgruppe und deren Informationsbedarf hat ebenfalls Auswirkung auf die Art der Bereitstellung der Informationen. Die jüngere Generation liest sicherlich weniger gerne PDF-Wälzer als eine ältere Zielgruppe, die direkt an den Maschinen stehen und auch nicht immer ein Tablet zur Verfügung haben. Alles hängt zusammen. Wenn Sie sich dafür entscheiden, individualisierte Dokumentationen anzubieten, müssen alle fünf Themenbereiche (Zielgruppen und Informationsbedarf, Modul- und Variantenmatrix, Informationsmodell und Strukturierungsmethode, Schnittstellen, Bereitstellung) miteinander und nicht separat betrachtet werden.

    Der Weg zur Automatisierung Step by Step

    Steht das Dokumentationskonzept und wird dieses durchgängig im Redaktionsprozess beachtet und umgesetzt, kann man sich darauf aufbauend mit dem wichtigen Thema Effizienz beschäftigen. Denn nun gilt es, nicht nur qualitativ hochwertige Dokumentationen zu erarbeiten, sondern diese auch so zeit- und kosteneffizient wie möglich zu erstellen. Auf dem Weg zu einem effizienten Handling von Varianten gibt es eine Vielzahl an Möglichkeiten und Abstufungen, die Ihnen Ihre Arbeit vereinfachen und kostbare Zeit einsparen, um sich so anderen Themen zu widmen. Sie erinnern sich an diese Aussage: “Wir erwarten einen Anstieg der Auftragseingänge, d.h. wir haben auch in der Redaktion eine höhere Auslastung, bekommen, aber nicht mehr Ressourcen. Wie können wir die Redaktion darauf vorbereiten und die Durchlaufzeiten pro Auftrag senken?”. Genau hier können wir jetzt ansetzen!

    Automatisierung mit dem Redaktionssystem TIM

    Das Masterdokument als Grundlage Ihres Erfolgs

    Im ersten Schritt ist es wichtig, ein Masterdokument / Maximaldokument zu erstellen. Dieses beinhaltet alle bekannten Produktvarianten. Es gilt, variantenbildende Merkmale zu identifizieren und die Frage zu beantworten, was für das Produkt beschreibungsrelevant ist. Im gleichen Zuge müssen variantenspezifische Inhalte getaggt werden.
    Standardisierte Module sind an dieser Stelle keine Voraussetzung, helfen Ihnen aber dabei, die Module optimal wiederzuverwenden.

    Phase 1: Manuelles Filtern über den Variantendialog
    Jeder, der mit TIM arbeitet, weiß, man kann Varianten zuordnen, auswählen und nach Informationssammlungen filtern. Ebenso ist es möglich einen Publikationsdialog zu erstellen für den eine Ausleitung nicht nötig ist. Es gibt viele verschiedene Ansätze.

    Phase 2: Manuelle Filterung über eine Auftragsdatei (TIM Plus)
    Hierbei handelt es sich um einen Export aus einem ERP-System. Die dort hinterlegten Merkmale filtern die Informationssammlung auf die individuellen Inhalte und löschen alle unrelevanten Beschreibungen.

    Phase 3: Automatisierte Filterung
    Wenn man automatisiert filtern will, ist der Export aus dem ERP-System der Trigger der den Workflow startet.

    8 Wochen, 4 Schritte – Ihr Weg zur individuellen Dokumentation

    Schritt 1: Workshop
    Im ersten Schritt gilt es einen Workshop zu belegen. So gelingt es, sich einen Gesamtüberblick zu verschaffen. Es werden variantenbildende Merkmale als Basis definiert. Wichtig: Das Konzept ist die Grundlage für alles. Die Zeit und Energie, die man an diesem Punkt investiert, zahlen sich später aus.

    Schritt 2: Spezifikation
    Im nächsten Schritt geht es um die Spezifikation bzw. den Proof of Concept. Verbesserungswünsche und Automatisierungspotenziale müssen an dieser Stelle identifiziert und festgehalten werden, bevor Sie dann die Anpassungswünsche an Fischer übermittelt werden.

    Schritt 3: Umsetzung
    An diesem Punkt steht alles im Zeichen der Umsetzung. Im engen Austausch setzt Fischer Ihr System passgenau um.

    Schritt 4: Profitieren Sie von Ihrer Arbeit
    Ab diesem Punkt profitieren Sie von Ihrer Arbeit. Nun haben Sie ein System, das Sie beim Arbeiten unterstützt. So gelingt es Ihnen, die Qualität der Dokumente zu steigern und effizient zu arbeiten. In der von Ihnen gewonnenen Zeit können Sie sich um andere Themen kümmern und Ihre Ressourcen einteilen.

    Gerne begleiten wir Sie auf Ihrem Weg zu einer individuellen Dokumentation. Treten Sie mit uns in Kontakt! Wir freuen uns, Sie zu beraten!

    Jetzt Beratungsgespräch vereinbaren!