Überspringen zu Hauptinhalt

Extra #010 Zusammenarbeit und Auswahl Dienstleister für Dokumentation

Extra #010 Zusammenarbeit Und Auswahl Dienstleister Für Dokumentation

Eine häufige Situation in der Praxis: Sie benötigen eine Betriebsanleitung für ein neues Projekt oder müssen sogar eine Anlagendokumentation für ein Produkt erstellen. Jedoch haben Sie dafür keine Zeit, da Sie sich mit technischen Problemen oder Kundenwünsche beschäftigen müssen, die in der letzten Minute festgestellt wurden. In diesen Situationen suchen viele Unternehmen einen Dienstleister, der Ihnen die Dokumentation schreibt und professionell erstellt.

Doch wie und wann beauftragt man einen Dienstleister mit der Erstellung der Dokumentation? Kann er jederzeit in das Projekt einsteigen? Welche Informationen benötigt er für die Erstellung der Betriebsanleitung? Und wie bekommt der Hersteller die Daten zurück? Können diese für zukünftige Projekte verwendet werden?

All diese Fragen und noch weitere bekommen wir regelmäßig gestellt, wenn sich eine neue Zusammenarbeit mit einem Kunden anbahnt. Egal ob wir Unterstützung bei der CE-Kennzeichnung, bei der Risikobeurteilung oder beim Erstellen der Betriebsanleitung geben sollen.

Definition der Grundlagen für die Zusammenarbeit

Unsere Empfehlung dabei ist es, zu aller erst die Rahmenbedingungen für die Zusammenarbeit zu definieren. Denn dann kann Ihnen der Dienstleister ein passendes Angebot erstellen und Sie erkennen auch, welche Leistungen Sie erhalten. Und so wissen Sie natürlich auch, welche Kosten auf Sie zukommen.

Zu den grundlegenden Absprachen gehört aus unserer Sicht allem voran der Zeitraum der zur Verfügung steht, was im Leistungsumfang enthalten ist und welche Dokumente der Kunde am Ende bekommt. Diese Dinge hören sich prinzipiell einfacher an, als sie sind. Denn diese können große Auswirkungen auf die Zusammenarbeit haben, gerade wenn diese mehrere Jahre gehen soll.

Zeitraum für die Projektabwicklung

Der Zeitraum für das Projekt ist prinzipiell einfach geklärt. In der Regel gibt es einen Termin zur Endabnahme, bei der auch die Anlagendokumentation fertiggestellt sein muss. Somit wäre der Endzeitpunkt definiert. Bei der Festlegung des Beginns hat man mehr Spielraum. Hier sollte im Idealfall ein Kompromiss aus ausreichend zur Verfügung gestellter Zeit und nicht zu früher Einbindung in das Projekt gefunden werden.

Denn einen Dienstleister zu früh in ein Projekt einzubinden kann auch teuer werden. Müssen beispielsweise komplette Kapitel neu geschrieben werden, weil sich Teile des Produktes komplett geändert haben, wurde der Dienstleister zu früh in das Projekt eingebunden und vergangene Arbeit war umsonst. In meiner langjährigen Erfahrung hatten wir häufig diesen Fall, wenn der Endkunde der die Anlage kauft, noch viele Änderungen bei einer Zwischenabnahme oder sogar bei der Endabnahme gewünscht hat. Dann mussten die Steuerung oder Funktionen angepasst werden, die bereits in der Anleitung beschrieben waren. Arbeit die hätte vermieden werden können.

Eine zu späte Einbindung des Dienstleisters ist genauso oft anzutreffen. Meist geschieht dies dann, wenn kurz vor der Endabnahme auffällt, dass noch eine Betriebsanleitung geschrieben werden muss. Die dadurch nur wenig zur Verfügung stehende Zeit ist interessanterweise häufig nicht das eigentliche Problem. Denn als professioneller Dienstleister können wir auch mehrere Personen an einem Projekt arbeiten lassen. Das Hauptproblem ist dagegen, dass die Maschine dann nicht mehr zur Verfügung steht, da sie sich bereits auf dem Transportweg befindet. Und ohne eine Maschine ist es schwer die notwendige Recherche und Informationen zu beschaffen.

Definition des Leistungsumfangs – verwendete Software

Kommen wir von der zeitlichen Planung zur Definition des Leistungsumfangs. Auch dieser Bereich ist umfangreich und sollte im Voraus geplant sein. Viele professionelle Dienstleister wie wir arbeiten beispielsweise mit unterstützender Software wie Autorentools. Dadurch können wir Texte einheitlicher erstellen und auch für zukünftige Projekte wiederverwenden. Diese Software ist in der Regel jedoch teuer in der Anschaffung und für den Kunden selbst uninteressant. Also muss zu Beginn der Zusammenarbeit definiert werden, welche Software der Kunde möchte bzw. welches Dateiformat er nach Projektabschluss erhalten möchte.

Viele unserer Kunden möchten zum Ende des Projektes die Daten in Microsoft Word, Adobe Framemaker oder Adobe InDesign. Und dies bekommen sie, obwohl wir mit unterstützender Software arbeiten. Denn die von uns verwendeten Tools können in diese Formate exportieren. Dadurch sind wir optimal aufgestellt, auch für eine längere Zusammenarbeit. Denn wir können dadurch die Texte wiederverwenden und für zukünftige Projekte einsetzen, die dadurch wiederum schneller fertiggestellt werden können.

Definition des Leistungsumfangs – Zielgruppen, Bestimmungsort, Umfang

Sobald die zu verwendete Software definiert wurde, kann man über die Inhalte sprechen. Was genau möchte der Kunde vom Dienstleister erhalten? Soll es eine komplette Betriebsanleitung nach IEEE 82079-1 sein? Oder nur eine Wartungsanleitung oder ein Software Handbuch? Für welchen Markt soll die Anleitung erstellt werden? Den EU-Markt oder für die USA? Und wer ist die Zielgruppe des Produktes und des Dokumentes?

All diese Fragen definieren die Qualität des Produktes, in diesem Fall die Betriebsanleitung. Nur wenn klar ist, was Sie von einem Dienstleister erwarten und haben möchten, kann er Ihnen auch genau das liefern. Die Erstellung der Dokumentation nach IEEE 82079-1 bzw. DIN EN 82079-1 „Erstellen von Gebrauchsanleitungen“ ist für viele inzwischen Standard. Die Beschäftigung mit der Zielgruppe und dem Zielmarkt hingegen leider nicht.

Die Kenntnis über die Zielgruppe und den Zielmarkt sind daher so wichtig, da diese Informationen bereits zu Beginn des Projektes bekannt sein müssen. Eine nachträgliche Anpassung der Dokumentation ist häufig schwierig und aufwändig. Die Wichtigkeit der Zielgruppe wird leider häufig unterschätzt und das Thema auch beim Hersteller nur wenig behandelt. Und das obwohl er sich bereits zu Beginn seiner Produktentwicklung im Rahmen der CE-Kennzeichnung mit dem Thema beschäftigen sollte. Da ich auf die Zielgruppenanalyse bereits in einer eigenen Podcast-Folge eingehe, werde ich hier jetzt nicht weiter darauf eingehen. Die Anpassung des Zielmarktes ist ebenfalls wichtig, denn nur so kann eine Dokumentation den Anforderungen des Marktes und des Gesetzgebers entsprechen und entsprechend haftungssicher sein.

Wer macht was?

Zu guter Letzt sollte im Vorfeld einer Zusammenarbeit besprochen werden, welche Arbeiten der Dienstleister übernimmt und welche unter Umständen vom Hersteller übernommen werden. Wir haben häufig die Anfrage, in wie weit uns Personal des Herstellers unterstützen und Arbeit abnehmen kann. Häufig um Kosten einzusparen.

Diese Arbeitsteilung ist ein zweischneidiges Schwert, das auch häufig den eigentlichen Grund, also die Kosteneinsparung, zu Nichte macht. Selbstverständlich können Mitarbeiter des Herstellers uns unterstützen und beispielsweise einfache Dinge wie das Erstellen und Bearbeiten von Bildern übernehmen. Das kann sich dann auch positiv auf die Kosten einwirken und zu Einsparungen führen.

Leider ist jedoch häufig das Gegenteil anzutreffen. Durch die Mitarbeiter des Herstellers entsteht eine Mehrarbeit. Zum Beispiel durch falsche, undeutliche oder schlechte Bilder. Das wiederum erhöht den Kommunikationsaufwand. Und ehrlich gesagt unterschätzen auch viele Chefs die Zeit, die ihre, meist (in diesem Bereich) ungelernten Mitarbeiter benötigen. Ganz nach dem Motto, „der ist ja sowieso da und kann es mitmachen“. Die internen Personalkosten werden dadurch komplett vernachlässigt und häufig wäre es günstiger, einen Dienstleister damit zu beauftragen.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Informationsbedarf und Projektstart

Nachdem wir nun die Rahmen der Zusammenarbeit definiert haben, geht es an den ersten Informationsaustausch und meist auch in die Angebotserstellung über. Denn ein Hersteller möchte ja schließlich wissen, wie viel die Arbeit des Dienstleisters kostet.

Die ersten Informationen für die Angebotserstellung hat der Dienstleister bereits auf Basis der Grundlagen erhalten. Er weiß nun, welches Dateiformat der Kunde zum Projektabschluss möchte, wohin die Anlage gehen soll und was er zu tun hat. Doch diese Informationen genügen meist noch nicht für eine Angebotserstellung.

Denn die Höhe der Projektkosten hängt direkt mit der Komplexität des Produktes zusammen. Komplexe Maschinen und Anlagen sind in der Regel auch entsprechend umfangreich zu beschreiben. Entsprechend wirkt sich dies dann auch auf die Betriebs- oder Anlagendokumentation aus. Kleinere und einfache Produkte haben meist Betriebsanleitungen mit einem Seitenumfang von ca. 80 Seiten. Mittlere Maschinen und kleinere Anlagen tendieren schnell zu 200 Seiten und größere Maschinen und Anlagen gehen schnell in Richtung von 300-400 Seiten oder mehr. Sollte das Produkt ein Gebäude wie ein Kraftwerk sein, reden wir dagegen tatsächlich von einer Anlagendokumentation die auf einer Euro-Palette angeliefert wird und auf entsprechend viele Ordner aufgeteilt ist.

Vor-Ort-Termin und erstes Kennenlernen

Wir machen es in der Regel häufig so, dass wir für diese Informationsbeschaffung einen Vor-Ort-Termin bei Ihnen vereinbaren. So können wir erste Eindrücke Ihres Produktes sammeln und für die Angebotserstellung aufnehmen. Und Sie können uns und unser Team gleichzeitig kennenlernen.

Bei diesen Terminen können wir auch gerne auf Wunsch bereits mit der Arbeit am Projekt beginnen. Anhand der heutigen Technik können wir bei diesem Termin bereits Fotos des Produktes oder auch Videos erstellen und aufnehmen. Zum einen unterstützt dies unseren Redakteur bei der Informationssammlung und zum anderen geht auch so keine Zeit verloren. Im Idealfall sparen Sie sich so einen weiteren Vorort-Termin.

Angebot, Projektverlauf, Rückfragenmanagement

Im nächsten Schritt erhalten Sie dann das Angebot für Ihr Projekt. Je nach Umfang des Projektes sprechen wir das Angebot persönlich mit Ihnen durch, um auch gleich auf Rückfragen eingehen zu können. Im Anschluss starten das Projekt und die Dokumentationserstellung.

Während unsere Fachkräfte die Betriebsanleitung erstellen, werden diese immer wieder mit Fragen auf Sie zukommen. Denn wir müssen das Produkt verstehen und uns in Ihre Kunden oder Anwender versetzen. Diese Kommunikation findet über Vor-Ort-Termine, Telefonate oder E-Mails statt. Ich persönlich stelle mich bei Kunden auch gerne als derjenige vor, der viele dumme Fragen stellt. Denn ich versuche so unbedarft an Ihr Produkt heranzugehen, wie es jeder neue Nutzer tut.

Während dieser Prozess läuft, wächst Ihre Anlagendokumentation oder Ihre Betriebsanleitung Stück für Stück. In dieser Zeit können Sie jederzeit Zwischenstände anfordern, um den Fortschritt zu sehen. Je nach Vereinbarung erstellen wir in dieser Zeit ebenfalls auch die Bilder und andere Informationen, um eine ordnungsgemäße und professionelle Dokumentation zu erstellen.

„Ein Bild sagt mehr als tausend Worte“

Die Bilder werden dabei von uns auf verschiede Weisen, dem Informationsziel entsprechend erstellt. Ist ein Foto zielführend, verwenden wir Fotos, die wir während Vor-Ort-Termine gemacht haben. Sind Zeichnungen zielführend, generieren wir diese aus Ihren CAD-Daten. So ist ihr Arbeitsaufwand so gering wie möglich. Da ich der Vergangenheit bereits einen Podcast zum Thema Bilder und Bildbearbeitung veröffentlicht habe, verlinke ich diesen ebenfalls. Sollten Sie sich für dieses Thema interessieren, kann ich diesen wärmstens empfehlen.

Nach einiger Zeit sind wir dann auch bereits kurz vor Ende des Projektes. Die Anleitung ist erstellt und wird bei uns intern noch korrekturgelesen. Im Anschluss erhalten Sie die vollständige Anleitung zur Überprüfung. Diese wird bei Bedarf von uns natürlich noch kostenfrei korrigiert, falls dies notwendig sein sollte.

Da die Muttersprache unserer Redakteure Deutsch ist, erhalten Sie von uns zu diesem Zeitpunkt eine deutschsprachige Betriebsanleitung. Wird eine Übersetzung benötigt, wird diese erst nach Freigabe des deutschen Textes erstellt. Die Übersetzung wird in solchen Fällen von professionellen, ausgebildeten Fachkräften erstellt, mit denen wir bereits seit vielen Jahren zusammenarbeiten.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Die Auswahl eines passenden Dienstleisters

Und somit sind wir am Ende des Projektes. Normalerweise erhalten Sie an diesen Zeitpunkt eine professionelle Betriebsanleitung, dem Stand der Technik entsprechend. Selbstverständlich den Anforderungen entsprechend wie zu Beginn vereinbart.

Nachdem wir diesen Ablauf skizziert haben, wenden wir uns der Kernfrage zu: Wie wählt man einen passenden Dienstleister aus? Diese Frage ist leider nicht pauschal zu beantworten. Hier spielen viele Kriterien zusammen, die jeder Hersteller anders bewertet.

Die aus meiner Sicht wichtigsten Punkte sind dabei:

  • Nähe des Dienstleisters
  • Dauer der Zusammenarbeit
  • Portfolio des Dienstleisters
  • Zwischenmenschliche Beziehung / persönlicher Kontakt

Die Kriterien im Detail

Die räumliche Nähe des Dienstleisters ist vor allem bei einer Zusammenarbeit wichtig, bei der viele Vor-Ort-Termine notwendig sind oder kurzfristige Anpassungen in der Dokumentation notwendig sind. Denn dann kann ein Dienstleister mit kurzem Anfahrtsweg zum Hersteller kommen und Informationen aufnehmen. Sind Projekte seltener oder können die Informationen kompakt oder auf anderen Wegen recherchiert werden, ist eine weitere Anfahrt hingegen auch in Ordnung.

Die Dauer der Zusammenarbeit hingegen sollte vorab dringend festgelegt werden. Eine längere Zusammenarbeit mit einem Dienstleister bringt den Vorteil, dass dieser die Produkte immer besser kennen lernen kann. Dadurch können Produkte wiederum schneller und mit weniger Rückfragen beschreiben werden.

Ein wichtiges Kriterium bei der Dauer der Zusammenarbeit ist auch immer das Zwischenmenschliche und der persönliche Kontakt. Ein Hersteller muss einem Dienstleister vertrauen können und sich auf diesen auch verlassen können. Daher ist es uns wichtig, dass uns potenzielle Kunden vor der Zusammenarbeit kennen lernen, beispielsweise bei einem Vor-Ort-Termin.

Das Portfolio

Bei einer längeren Zusammenarbeit sollte bei der Auswahl des Dienstleisters auch dessen Portfolio mehr berücksichtigt werden. Denn wenn der Dienstleister neben der Dokumentationserstellung auch Überprüfungen oder die Anpassung auf andere Märkte anbieten kann, hat man einen vielseitigen und vertrauten Partner.

Verwendet der Dienstleister beispielsweise professionelle Software wie Autorenunterstützung oder Redaktionssysteme müssen diese mit Inhalten befüllt werden, bevor sie ihre Wirkung ganz entfalten können. Das funktioniert nicht mit nur einem einzelnen Projekt, hierfür müssen mehrere Projekte erstellt werden.

Und zum Schluss sollte sich der Hersteller auch immer überlegen, wohin er mit seiner technischen Dokumentation auf lange Sicht hin möchte. Werden hier Gedanken zu Themen wie VR/AR-Unterstützung, digitale Betriebsanleitung oder zusätzliche, andere Medienformen überlegt, sollte ebenfalls ein Dienstleister gewählt werden, der sich damit bereits befasst.

Überprüfung von Dokumentationen

Da ich es gerade vom Portfolio hatte, möchte ich an dieser Stelle kurz auf eine andere Leistung von uns zu sprechen kommen, der Dokumentationsüberprüfung oder dem „GFT DokuCheck“, wie es bei uns heißt. Denn dieser wird bei uns ebenso häufig beauftragt, wie die Dokumentationserstellung. Denn natürlich haben viele Hersteller bereits vorhandene Betriebsanleitungen oder Anlagendokumentationen, die über die Jahre hinweg erstellt wurden. Jedoch ist häufig nicht klar, wie gut oder schlecht man in diesem Bereich aufgestellt ist.

Wir überprüfen beim „GFT DokuCheck“ die vorhandene Anleitung auf die Anforderungen aus Normen, Richtlinien und Gesetzen. Angepasst auf den gewünschten Zielmarkt des Kunden. Nach Übermittlung der vorhandenen Dokumentation in digitaler Form, erhält unser Kunde ein Angebot für die gewünschte Überprüfung. Auch hier hängt der Aufwand vom Seitenumfang, der Zielgruppe und dem Zielmarkt ab.

Das Dokument wird dann auf „Herz und Nieren“ überprüft und über die Kommentarfunktion der PDF-Dateien kommentiert. Zusätzlich erhält der Kunde einen Prüfbericht mit ausführlichen Kommentaren, anhand dessen er seine Dokumente überarbeiten kann.

Daneben bieten wir noch eine Kurzüberprüfung, den „GFT DokuKurzCheck“, an. Bei dieser kostenlosen Überprüfung schränken wir die Zeit ein, die wir für die Überprüfung ansetzen. Denn aufgrund unserer Erfahrung und Ausbildung können wir schon in kurzer Zeit den Zustand einer Dokumentation beurteilen. Wir können innerhalb kurzer Zeit häufig gemachte Fehler erkennen und feststellen.

Fazit

Aber nun wieder zurück zur Auswahl eines Dienstleister. Wie Sie anhand meiner Auflistung sehen können, ist die Auswahl eines passenden Dienstleisters von vielen Kriterien abhängig. Dementsprechend ist die Wahl nicht immer leicht.

Dennoch empfehle ich sich mit dem Thema zu beschäftigen. Denn für viele kleinere oder auch mittlere Unternehmen lohnt es sich nicht, einen technischen Redakteur einzustellen. Häufig muss die technische Dokumentation dann von jemand anderem mitgemacht werden. Derjenige hat leider häufig weder die Zeit, noch die Ausbildung diesem Job gerecht zu werden. Die Dokumentation wird trotz ihrer Bedeutung für die Produkthaftung, Produzentenhaftung und der CE-Kennzeichnung zum Stiefkind. Und dadurch steigen Risiken für das Unternehmen.

Die Suche nach einem professionellen Dienstleister lohnt sich also gerade für diese Unternehmensgrößen. Außerdem bringt ein Dienstleister weitere, indirekte Vorteile mit. Denn seine Kernkompetenz liegt in der Erstellung von technischer Dokumentation. Entsprechend groß sind hier sein Erfahrungsschatz und sein Investitionswillen in Software. Außerdem bildet er sein Personal auch durchgehend weiter, um den Anforderungen des Marktes zu entsprechen. All das sind Kosten, die der Hersteller dann nicht selbst tragen muss.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen