Planung & Einführung von Redaktionssystemen für Technische Dokumentation

Das ein guter Plan, der durchdacht ist, der ausreichend skalierbare Möglichkeiten für zukünftige Aufgaben bietet, der Risiken und Optionen ausgewogen berücksichtigt, immer eine gute Idee ist, steht wohl außer Frage.

Nur was bedeutet ausreichend skalierbar, was bietet der Markt an passenden Systemen für die Aufgaben und die gesetzten Ziele?

Zielsetzung & Planung

Zentral ist da auf jeden Fall die Frage nach den Zielen die man mit einem Redaktionssystem erreichen möchte.

Um sich diesen Zielen bewusst zu werden, Sie ahnen es schon, stellt sich auch die Frage nach dem Sinn, der Bedeutung von Technischer Dokumentation wie Betriebsanleitungen, Bedienungsanleitungen, Wartungshandbücher und Ersatzteilkatalogen – also Benutzerinformationen.

Denn aus dieser Fragestellung bzw. durch den daraus resultierenden Antworten ergeben sich Sinn, Bedeutung und Nutzen von Redaktionssystemen für Benutzerinformationen.

Also gilt es zunächst die Bedeutung des 'Corpus Delicti' festzustellen. Welche Bedeutung haben denn Betriebsanleitungen & Co.:

  • Sie informieren den Benutzer und dienen ggf. als Ausbildungsinformation
  • Sie ist Teil des beschrieben Produkts – banal aber sehr bedeutsam, Stichwort 'Instruktionsmangel'
  • Ihr Inhalt bzw. fehlender Inhalt ist mit Haftungsrisiken verbunden
  • Nicht korrekt, verspätet oder formal falsch ausgeliefert ist sie in vielen Branchen mit Zahlungsausfallrisiken verbunden
  • Mängel der Dokumentation können insbesondere bei Konsumerprodukten schnell zu negativen Auswirkungen/ Image-Problemen führen.

Also sollte Endbenutzerdokumentation folgende Kriterien erfüllen:

Benutzerorientiert

  • Informativ, zum Produkt und der Bedeutung passend und fachlich korrekt ausgeführt sein
  • Inhaltlich vollständig, regelkonform und zielgruppenorientiert angepasst sein
  • Den Benutzerbedürfnissen entsprechend, nutzbar sein und unmittelbar zur Verfügung stehen.

Hersteller-/ erstellerbezogen

  • Rechtssicher und Regelwerken entsprechend
  • Zu definierten Milestones zur Verfügung stehen
  • In oft enge Budget passen.

Zusammengefasst ist eine Endbenutzerdokumentation also idealerweise informativ, vollständig, benutzerfreundlich, mit zielgruppenorientierten Inhalten, zeitnah und kostengünstig erstellt, sowie regelkonform und rechtssicher.

Demnach sind die Anforderungen die mit dem Einsatz eines Redaktionssystems für Technische Dokumentation verbunden sind, meist ziemlich hoch. Hinzu kommen noch Umgebungsvariablen sowie redaktionelle und organisatorische Bedingungen zu denen das System passen muss.

Festlegen von Auswahlparametern & Auswahlprozess

Aus den vorherigen Abschnitten lassen sich schon einmal ein paar Parameter ableiten an denen sich die Möglichkeiten und die Funktionen eines Redaktionssystems ausrichten müssen. Im Zusammenhang mit der Auswahl und der Einführung eines Redaktionssystems muss aber auch bedacht werden:

  • Welche Produktstrukturen müssen abgebildet werden können?
  • Wie hoch ist die Wahrscheinlichkeit für eine sich wiederholende Verwendung von Inhalten?
  • Müssen Versionen und Varianten mit abgebildet werden?
  • Sollen Daten aus anderen Systemen wie CAD, ERP und PDM direkt in das Redaktionssystem übernommen werden?
  • Ist eine Verkettung mit Lieferanten, Dienstleistern und/oder Kunden notwendig oder sinnvoll?
  • Welche Standards müssen bedient werden können?
  • Welche und wie viele Fremdsprachen sollen verwaltet werden?
  • Müssen Teams zusammenarbeiten die an unterschiedlichen Standorten arbeiten?
  • Müssen Informationen unter mehreren Marken (Brands) veröffentlicht werden können?
  • Welches Budget und Ressourcen stehen für die Einführung, Schulungen und Lebensdauer zur Verfügung?

Es wird deutlich erkennbar, dass die Planung, Auswahl und insbesondere die Einführung eines Redaktionssystems keine Tätigkeiten sind 'die man mal schnell' nebenher erledigt.

Hinzu kommt, dass es eine Vielzahl von Systemen und Tools gibt, die unterschiedliche Ansätze verfolgen, deren Funktionen und Abläufe für bestimmte Aufgaben optimiert sind. Es werden verschiedene Techniken eingesetzt die sich mehr oder weniger – oder auch gar nicht – für das Erreichen der definierten Ziele eigenen.

Natürlich stehen Systeme zur Verfügung die sich auf nahezu alle Aufgaben und Bedingungen skalieren lassen, aber stehen Ihnen für diese Systeme auch dauerhaft die notwendigen Ressourcen zur Verfügung. Deckt Ihre IT-Technik die Anforderungen des Systems ab, oder müssen Sie dann noch nachrüsten. Stellt sich noch die Frage nach den Kosten für die Erstinvestition und die Lebensdauer. Passen die noch zu Ihren Budgets für ein Redaktionssystem?

Auf der anderen Seite findet man auch eher kostengünstige Systeme und häufig mit interessanten Features die auf sich aufmerksam machen. Aber wie sieht es da mit der Skalierbarkeit und den sicherlich wachsenden Anforderungen an die Systeme aus? Wie lassen sich solche Systeme in eine Cloud-Umgebung integrieren?

Na ja, und dann gibt es auch noch die 'einfach, ideal, unschlagbar günstig, sofort einsetzbar, für alle Produkte geeignet, mit vielen kostenlosen Mustern, usw.' Systeme. Ja, auch die haben eine Berechtigung, wenn sie zu Ihren Zielen, Ihren Produkten und Ihren Umgebungsparametern passen. Häufig verstecken sich aber hinter den verlockenden Schlagworten und niedrigen Einstiegskosten ungünstige Lebensdauerkosten und mangelnde Skalierbarkeit.

Der beste Rat für die Auswahl von Redaktionssystemen ist: Lassen Sie sich beraten!

Möglichst ergebnisoffen, von Spezialisten, die den Markt kennen und mit der Bearbeitung von Technischer Dokumentation vertraut sind.

Ein guter Berater wird mit Ihnen gemeinsam:

  • Ihre Zielsetzung auf mögliche Lücken prüfen, Ihre Umgebungsvariablen definieren, bewerten und dokumentieren.
  • Ihre Dokumentationsinhalte, -strukturen und die zu berücksichtigenden individuellen Anforderungen an die Dokumente untersuchen und deren Auswirkungen auf die Systemauswahl feststellen.
  • Ihre Produktstruktur und die Anforderungen von Ihnen zu bedienenden Märkte in die Bewertungskriterien mit einbeziehen.
  • Zu berücksichtigenden Regelwerke und die sich daraus ergebenden Systemparametern herausarbeiten.
  • Systeme dahingehend prüfen, ob sie zu Ihren Budget, Ihren technischen Möglichkeiten und den zur Verfügung stehenden Ressourcen passen.

Legen Sie fest, welche Aussagen der Abschlussbericht des Beraters enthalten muss und ob der Berater eine Systemempfehlung oder eine Systemtypempfehlung mit einbeziehen soll.

Mit dem Abschlussbericht des Beraters halten sie dann das perfekte Lastenheft für die Auswahl Ihres Redaktionssystems in den Händen.

Lassen Sie sich auch die Konditionen und Zeiträume angeben zu denen der Berater für eventuelle Leistungen in der Einführungsphase eines Redaktionssystems zur Verfügung steht. Das kann sehr hilfreich sein, weil er schon sehr viel an Wissen über Ihre Technische Dokumentation und Ihre Produkte hat und seine Unterstützung kann die Einführung von Systemen erheblich erleichtern und verkürzen.

Natürlich sollten Sie auch die Lizenzgeber Ihrer Kandidaten einladen. Benutzen Sie die Dokumentation des Beraters als Lastenheft für Ihr Redaktionssystem, dass hilft allen Beteiligten schnell und zuverlässig zu erkennen, was Sie benötigen. 

Noch ein sehr wichtiger Hinweis: Redaktionssysteme sind meist komplex und organisieren eine Menge an Daten und die Inhalte werden meist von mehreren Personen bearbeitet und das häufig über Jahre. Sorgen Sie unbedingt für Regeln mit denen diese Personen Inhalte bearbeiten, verwalten und organisieren.

Befolgen Sie die 'goldene Regel' für Redaktionssysteme:

Setzen Sie kein Redaktionssystem ohne Redaktionsleitfaden bzw. Redaktionshandbuch ein.

Wesentliche Aspekte, die der bei der Erstellung von Technischer Dokumentation nicht unterschätzt werden dürfen, sind die zu Verfügung stehenden Informationen. Hier sind Informationsverfügbarkeit, -qualität und -aktualität entscheidend. 

Zur Einführung eines Redaktionssystems gehört daher auch immer die Analyse und Beurteilung des Informationsflusses. Der Einsatz eines Redaktionssystems zur Beseitigung organisatorischer Mängel oder systemisch bedingter Störungen bei der Informationsbereitstellung, wäre von vorn herein zum Scheitern verurteilt.