BA#020 Strategien für die Recherche einer Technischen Dokumentation

Eine gründliche Recherche ist entscheidend, um eine komplexe Technische Dokumentation erfolgreich zu erstellen. Lasten- und Pflichtenhefte, Design-Spezifikationen oder Besprechungsprotokolle helfen einem Technischen Redakteur dabei eine Betriebsanleitung zu erstellen. Aber woher bekommt man alle diese benötigen Informationen am besten? Und wie geht man dabei vor?

Bevor man die Technische Dokumentation erstellen kann, geht es zuerst darum einige grundlegende Informationen zu beschaffen. Welche Vorgaben hat der Kunde an die Maschine bzw. das Produkt und hat er auch Anforderungen an die Technische Dokumentation?

Über die Maschine bzw. das Produkt sollten grundlegende Dinge wie Positionen und Einbauweise von Komponenten und Bauteilen oder der zeitliche Ablauf von Arbeitsschritten bekannt sein. Die Entwickler einer Maschine bzw. eines Produktes sind dabei nicht immer auch diese Personen, welche die Technische Dokumentation schreiben. Häufig gibt es eine eigene Technische Redaktion, die sich mit dieser Aufgabe befasst. Diese benötigen im Erstellungsprozess einer Anleitung daher auch immer die Unterstützung von Experten, die sich mit der Maschine bzw. dem Produkt auskennen.

Diese können entsprechende Informationen an die Technische Redaktion weitergeben. Das können Details zu Objekten und Tätigkeiten bzw. Abläufe sein. Auch welche Teile wie angeordnet sind und wie diese nachvollziehbar und konsistent zu benennen sind. Auch kennen sich die Experten mit den jeweiligen Kundenanforderungen an das Produkt bzw. die Maschine aus. Dieses Wissen ist für die Technische Redaktion am Beginn des Dokumentationsprozess sehr wichtig.

Häufig sind diese Personen aber schwer beschäftigt und sehen die Technische Dokumentation und Anleitung als eine lästige Pflicht, welche nach Erstellung sowieso im Schrank verschwindet. Wie erreicht man nun diese Personen am besten, um wichtige Fragen bezügliche der Anleitung klären zu können?

Hier hilft die richtige Vorbereitung, um möglichst wenig Zeit der Experten in Anspruch zu nehmen. Erscheint man zu einem Gespräch bereits gut vorbereitet und hat mögliche Fragen schon im Vorfeld an die zuständige Person übermittelt, ist das schon die halbe Miete.

Arbeiten Sie sich schon mal in die Thematik des Produktes ein. Was für Informationen über das Produkt liegen bereits vor? Gibt es vergleichbare Produkte und liegen hierfür bereits Anleitungen vor, bei dem man entsprechende Teile für die eigene Technische Dokumentation wiederverwenden kann. Machen Sie sich entsprechende Notizen, die offene Fragen enthält, wo einer Klärung bedürfen.

Umso mehr Vorwissen Sie sammeln, desto kürzer ist die Liste an offenen Fragen für die Experten aus der Produktentwicklung.

Wenn Sie Glück haben, müssen Sie gar nicht viel recherchieren. Einige fleißige Entwickler haben die Dokumentation im Hinterkopf und kommen direkt auf Sie zu oder stellen Ihnen wichtige Informationen zusammen, was alles dokumentiert werden muss.

Da dies aber eher die Ausnahme als die Regel ist, sollten Sie für die Recherche selber aktiv werden. Sie können beispielsweise an Besprechungen teilnehmen, in denen auch die Entwickler involviert sind. Zwar dreht sich in diesen Besprechungen nicht alles um die Technische Dokumentation aber Sie bekommen so einen wertvollen Einblick in den Entwicklungsprozess und können auch dort schon wichtige Rückfragen zur Dokumentation stellen oder Anmerkungen geben.

Weiterhin können Sie einige der Entwickler in ein Einzelgespräch verwickeln und Ihre Fragen dabei abklären. Sprechen Sie zuerst mit Experten, die einen allgemeinen Überblick über das Projekt haben. So können Sie viele allgemeine Punkte bereits im Voraus abklären, bevor Sie sich an spezielle Themen heranwagen.

Der Produktmanager beispielsweise kann Ihnen genauere Informationen zu den Kundenforderungen an das Produkt geben. Welche Probleme will der Kunde mit der Entwicklung des neuen Produktes lösen? Diese Herangehensweise verhindert, dass Sie zu früh mit ungenügenden Hintergrundwissen an Experten herantreten und auf diese Weise die kostbare Zeit der Experten in Anspruch nehmen.

Wenn die grundlegenden Dinge bekannt sind und nur noch spezielle Fragen offen sind, können Sie sich an die Experten wenden. In diesem Personenkreis ticken die Menschen unterschiedlich. Einige schätzen die Arbeit der Technischen Redaktion, andere empfinden Sie und die Rückfragen nur als hinderlich oder überflüssig. Die einen haben kaum Zeit für Rückfragen, die anderen sind sehr gesprächig und vermitteln jede Menge nicht relevanten Informationen zum Produkt. Wenn bekannt ist wie die jeweiligen Personen ticken, kann das Gespräch mit einigen Strategien einfach und zielgerichtet geführt werden.

Einige Experten sind häufig schwer beschäftigt und haben nur wenig Zeit und/oder nur wenig Lust, um über die Technische Dokumentation zu sprechen. Hier hilft es auf die Wichtigkeit der Technischen Dokumentation hinzuweisen und das diese ein verpflichtender Bestandteil des Produktes ist.

Sammeln Sie die benötigten Fragen, die nur dieser schwer beschäftigte Experte beantworten kann und halten Sie die Gespräche kurz. Dadurch geht dem Experten nur wenig Zeit verloren und er muss keine allgemeinen Fragen beantworten.

Der gesprächige Typ spricht sehr viel und ausführlich über das Produkt bzw. die Entwicklung. Der Technische Redakteur ist natürlich dann schnell überfordert, wenn eine Welle von technischen Details auf ihn hereinbricht. Zudem geht viel Zeit bei einem solchen Charaktertyp verloren, ohne dass man nur einen Teil der Fragen stellen konnte.

Da dieser Experte sich ja die Zeit nimmt um die eigenen ungeklärten Fragen zu beantworten, möchte man Ihn auch nur ungern unterbrechen. Hier hilft es die Rückfragen verstärkt per E-Mail zu erledigen.

Der Experte könnte auch nur ein sehr zurückhaltender Charakter sein. Lockern Sie die Stimmung vor Gesprächen mit ein wenig Smalltalk auf oder schicken Sie Ihre Fragen wieder vorab per Mail. Das macht es für den Experten einfacher auf Ihre Fragen einzugehen. Die Fragen sollten auch möglichst offen gestellt sein, damit der Experte diese nicht nur mit einer Ja- oder Nein-Aussage beantwortet kann.

Fragen Sie auch nach einer Demonstration des Produktes. Möglicherweise erhalten Sie dann auch Videomaterial, welches die Abläufe bzw. Arbeitsschritte mit dem Produkt darstellen.

Findet der Informationsaustausch mit internationalen Experten statt, sollten Sie sich mit den Fachausdrücken in der Fremdsprache auseinandersetzen. Auch sind auf mögliche kulturelle Gepflogenheiten zu achten.

Es bietet sich auch an, die Kommunikation mit dem Gegenüber per E-Mail abzuwickeln. So können Sie sich besser vorbereiten und der Gesprächspartner kann sich die Antworten auf die zugesandten Fragen in Ruhe überlegen.

Achten Sie bei einer internationalen Kommunikation auch auf Ihren Umgangston. Bedenken Sie, dass in anderen Kulturen manche Dinge als unhöflich betrachtet werden, was bei uns als normal betrachtet wird. In Deutschland steigen wir gerne sofort geschäftsmäßig in das eigentliche Thema ein, andere Kulturen schätzen erst mal ein bisschen Smalltalk. Wir tendieren auch dazu direkt Kritiken zu äußern, während andere Nationen dieses Verhalten eher als aggressiv werten.

Bleiben Sie mit Ihren internationalen Gesprächspartner in Kontakt. Diese schätzen es, wenn man sich unmittelbar nach einem Gespräch mit einer E-Mail bedankt und die wichtigsten Punkte des Gespräches zusammenfasst.

Das Zusammenfassen von Gesprächen mithilfe von Notizen ist ein allgemeiner Punkt, den man beachten sollte. Es hilft den Experten, wenn diese von der Technischen Redaktion ein Feedback bekommen, in denen die wichtigsten Punkte aus dem Gespräch zusammengefasst sind.

Sie können dann auch eine Rückmeldung aus Ihrer Zusammenfassung einfordern, ob Sie alles richtig verstanden haben.

Steigern Sie zudem den Stellenwert der Technischen Redaktion indem Sie das Produkt testen und Verbesserungen an die Experten weitergeben, beispielsweise zur Handhabung der Benutzersteuerung.

Ebenso ist es ratsam nach Gesprächen mit Experten ihm Auszüge aus der Dokumentation oder sogar eine Vorabversion zukommen zu lassen. Sie können dann ein Feedback einfordern, dass der Experte den Auszug bzw. die Vorabversion auf seine Richtigkeit überprüft.

Ein Kunde beauftragt uns für die Erstellung einer Dokumentation für seine Anlage. Wir bekommen einen zentralen Ansprechpartner für Rückfragen und lassen uns von diesem erste Informationsmaterialien zukommen. Darunter zählen Unterlagen wie Risikobeurteilung, Lasten- und Pflichtenheft, CAD-Daten und Kurzbeschreibungen über die Hauptfunktionen der Anlage. Wir fragen auch nach, ob Anleitungen zu ähnlichen Produkten als Vorlage vorhanden sind und welche Vorgaben der Kunde uns hinsichtlich des Layouts der Anleitung stellt.

Wir sichten nun diese Unterlagen und sammeln die ersten Eckdaten für die Technische Dokumentation. Zudem vereinbaren wir in den meisten Fällen mit dem Kunden einen Termin Vor-Ort, um uns die Anlage im Detail anzuschauen und Detailinformationen zu sammeln.

Vor Ort fragen wir neben unserem Ansprechpartner auch weitere Personen wie zuständige Konstrukteure explizit nach den Funktionen und Details von bestimmten Bauteilen. Ebenso die Funktionen zu einzelnen Schaltern in der Steuerung des Produktes oder die Funktionen von Menüeinträgen. Wir lassen uns Arbeitsschritte und Handlungsabläufe erläutern, die in der Anleitung beschrieben werden müssen. Zudem klären wir mögliche Restrisiken an der Anlage mit dem Kunden und lassen uns die Technischen Schutzeinrichtungen erläutern und vor welchen Gefahren die Anwender in der Anleitung gewarnt werden müssen.

Wir machen vor Ort mit einer Kamera Bilder von der Anlage und klären gleich mit dem Kunden ab, wie detailliert eine Abbildung in der Anleitung dargestellt sein muss, um eine Handlung bzw. einen Ablauf zu verdeutlichen.

Im weiteren Erstellungsprozess stellen wir dem Kunden immer wieder Rückfragen oder holen uns ein Feedback des jeweiligen Ansprechpartners zu bestimmten Themen ein. So klären wir hinsichtlich der Terminologie die einheitliche und gleichbleibende Benennung von Bauteilen und Komponenten ab. Wir senden dem Kunden immer wieder Zwischenstände zu und bitten Ihn um seine Meinung zum zugeschickten Kapitel oder Abschnitt. Fehlende Informationen wie beispielsweise Screenshots der Anlagensteuerung fordern wir beim Kunden frühzeitig ein, wenn diese auftreten.

Wir prüfen die fertige Anleitung abschließend nochmal in einem internen Korrekturlauf, bevor wir die finale Version zur Freigabe an den Kunden übermitteln. Wenn gewünscht veranlassen wir im Nachhinein auch die Übersetzung der Anleitung in die vom Kunden gewünschte Sprache.