Qualitätssicherung von Technischer Dokumentation

Sie haben ein tolles Produkt entwickelt, von dem Sie ganz begeistert sind? Super! Und wie steht es mit der zugehörigen Technischen Dokumentation? Sollten Sie bisher der Auffassung gewesen sein, dass diese eher zu vernachlässigen ist, dann müssen wir Sie leider enttäuschen. Sie ist ein nicht zu unterschätzender Bestandteil Ihres Produktes. Und warum sollte dieser schlechter sein als Ihr Produkt selbst? Es lohnt sich, hier von Anfang an Wert auf einen hohen Qualitätsstandard zu legen.

Interne vs. externe Technische Redakteure

Der hohe Standard bzw. gute Qualität beginnt bereits mit der Planung. Mit Planung ist allerdings nicht nur die Konstruktion und der Vertrieb Ihres Produkts gemeint, sondern auch wie die Technische Dokumentation entsteht und wer damit befasst sein soll. Logischerweise können Sie nicht jeden x-beliebigen Mitarbeiter mit dieser Aufgabe betrauen. Schielen Sie evtl. gerade in Richtung Ihres Konstrukteurs oder Ihrer Konstrukteure? Das ist nicht immer eine gute Idee. Konstrukteure sollen das tun, was sie gut können: konstruieren. Hätten Sie die Aufgabe gewollt, Anleitungstexte zu erstellen, hätten sie vermutlich etwas anderes gelernt. Sie würden ja auch keinen Buchhalter im Marketing einsetzen, oder?

Sie brauchen also fähiges und vor allem geeignetes Personal für die Technische Dokumentation. Jemanden, der sowohl die rechtlichen als auch normativen Anforderungen kennt, die Ihr Produkt betreffen oder zumindest weiß, wo er sie finden kann. Haben Sie schon so jemanden in Ihrem Team? Herzlichen Glückwunsch! Wenn nicht, haben Sie zwei Möglichkeiten. Sie können entweder einen Einarbeitungsplan erstellen und das Personal passend einarbeiten, was meist mit erheblichem Mehraufwand für Sie verbunden ist oder Sie beauftragen einen externen Dienstleister damit.

Vorteil eines Dienstleisters: Qualitätsstandards schaffen und kontinuierlich einhalten

Ein Dienstleister für Technische Dokumentation ist darauf spezialisiert, sich mit den einzelnen Stationen einer Technischen Dokumentation auseinanderzusetzen. Im günstigsten Fall begleitet er Sie und Ihr Produkt von Anfang bis Ende. Mit ihm zusammen können Sie eine sinnvolle Planung erstellen. Er übernimmt die Recherche entsprechender Normen für Sie, sofern diese noch nicht vorhanden sind und kümmert sich um die Redaktion.

Mit Ihnen zusammen erarbeitet er die Gestaltung Ihrer Technischen Dokumentation, in dem er z. B. bestimmte Merkmale definiert, die für Ihre Dokumentation wichtig sind.

Für die Qualitätssicherung während des Dokumentationsprozesses ist eine systematische Arbeitsweise unbedingt notwendig. Arbeitsabläufe sollten daher sinnvoll strukturiert sein: was kommt zuerst – zunächst – zuletzt.

Die Erarbeitung bzw. Verwendung von Checklisten hat sich ebenso bewährt wie das sogenannte 4-Augen-Prinzip. Checklisten sind, ebenso wie Formatvorlagen, dazu da Abläufe zu strukturieren und standardisierbar zu machen. Außerdem können sie, z. B. bei Aktualisierungen leicht angepasst werden.

All das ist für Dienstleister für Technische Dokumentation ganz automatisch für jedes Projekt im Tagesgeschäft enthalten, unabhängig davon, ob Ihr Dienstleister ein klassischer "Einzelkämpfer" ist oder ein ganzes Team für die Redaktion betreut. Im letzteren Fall können Ausfallzeiten und Qualitätssicherung sicher einfacher und standardisierter ablaufen, es kostet aber vermutlich auch etwas mehr. Achten Sie in jedem Fall darauf, dass gewisse Qualitätskriterien eingehalten werden und fragen Sie doch einfach Ihren Dienstleister für Technische Dokumentation, wie er die Qualität seiner Arbeit für Sie sicherstellt.

Wie erhalte ich intern die gleiche Qualität in der Technischen Dokumentation wie ein Dienstleister?

Wenn Sie genügend Dokumentation haben, kennen Sie dieses Prozedere zur Genüge. Gut ausgebildete Redakteure, die standardisierte Prozesse für alle Projekte kennen und Ihre Produkte trotzdem jedes Mal, auch wenn sie von der Norm abweichen, verständlich beschreiben, sind Gold wert.

So wissen erfahrene Redakteure, dass das 4-Augen-Prinzip vor allem nach der Bearbeitung zum Einsatz kommt. Manchmal sind allerdings auch Zwischenschritte nötig, weil die Dokumentation schon während der Produktentwicklung erstellt wird. Dann werden Zwischenstände auch schon im 4-Augen-Prinzip geprüft. Dieses dient nicht nur der Fehlerkorrektur, sondern bietet auch die Möglichkeit etwaige Verständnisprobleme zu beheben. Planen Sie also auch Korrekturschleifen mit ein.

Auch sollten regelmäßige Updates zum Stand der Technik erfolgen und Fortbildungen den Blick über den Tellerrand ermöglichen. Auch eine Bewertung Ihrer Dokumentation von Extern kann helfen, den Fokus auf das Wesentliche zu lenken. Gerne können Sie z. B. auf einen Doku-Check zurückgreifen, wenn Sie wissen möchten, wie gut Ihre Technische Dokumentation wirklich ist.

Qualität auch beim Übersetzen Technischer Dokumentation

Wenn Ihre Technische Dokumentation dann in ihrer endgültigen Fassung vorliegt und Ihr Produkt nicht nur im deutschsprachigen Raum auf den Markt kommen soll, werden Sie sich spätestens dann mit dem Thema Übersetzungen auseinandersetzen. Hierfür bietet sich die Zusammenarbeit mit einem professionellen Übersetzer an. Wichtig ist, dass dieser möglichst Muttersprachler in der Zielsprache ist und systematisches Arbeiten kennt. Erfahrungen in anderen Bereichen der Technischen Dokumentation sind ebenfalls vorteilhaft.

Für eine gleichbleibende Qualität empfiehlt es sich, die vielleicht in vorherigen Projekten erstellen Dokumente bereits mit Translation-Memory-Systemen übersetzt zu haben. Gemeinsam mit einer Terminologie-Liste stellen Sie sicher, dass relevante Schlüsselbegriffe korrekt übersetzt werden.

Wir fassen also nochmal zusammen

Um eine hohe Qualität in der Technischen Dokumentation liefern zu können, sollten Sie folgende Punkte nicht aus den Augen verlieren:

• Seien Sie auf dem Stand der Technik, informieren Sie sich regelmäßig über Änderungen bei Normen und Gesetzen
• Arbeiten Sie, wann immer möglich, mit Profis zusammen, z. B. indem Sie Ihre Redaktion regelmäßig schulen lassen
• Lassen Sie nicht jeden jede Arbeit machen:
  • Informationen müssen vom Entwickler kommen,
  • textliche / bildliche Ausarbeitungen können Redakteure vielleicht leichter umsetzen
• Lassen Sie Übersetzungen nur von Muttersprachlern mit entsprechendem technischem Hintergrund erstellen
• Nutzen Sie professionelle Tools für ein professionelles Aussehen (damit ist nicht zwingend ein Redaktionssystem gemeint, auch wenn hier die Qualitätssicherung deutlich besser vorgegeben werden kann, im Falle von Editoren muss das der Erstellungsprozess abfangen)
• Ermöglichen Sie den Verantwortlichen die entsprechenden Schulungen zu Tools, Systematiken, etc. Holen Sie sich ab und zu den Blick von außen, z. B. Ihren Kunden, Ihrer Marketing-Abteilung oder externen Dienstleistern, um bestmögliche Qualität sicherzustellen

Und sich professionelle Hilfe zu holen ist kein Zeichen von eigenem Unvermögen. Sie beweisen damit vielmehr, dass Sie alles tun wollen, um Ihr Produkt, auf das Sie zurecht stolz sein können, bestmöglich zu präsentieren und so vielen Kunden wie möglich zugänglich zu machen.

Beauftragen Sie mit den Handbuch Experten einen Dienstleister, der seit über 30 Jahren Erfahrung in mehr als 6.500 Projekten in der Technischen Dokumentation hat und sich mit Qualität, Stand der Technik und Standardisierung auskennt.