Technische Dokumentation >> Blogreihe: Über die Schulter geschaut

Blogreihe: Über die Schulter geschaut

Technische Dokumentation für einen Lieferbot

Die Erstellung einer Technische Dokumentation lässt sich ohne konkreten Anwendungsfall nur schwierig beschreiben – auch da die Thematik eher trocken anmutet. Daher haben wir uns für unsere neue Blogreihe ein realitätsnahes Szenario ausgedacht, um Ihnen einen konkreten Einblick in unsere Arbeit zu bieten. Anhand eines imaginären Produkts und imaginärer Kunden führen wir Sie nach und nach durch verschiedene Aspekte der Technischen Dokumentation. Los geht’s heute mit den ersten Schritten, wenn ein Neukunde eine erste Dokumentation von uns erstellen lassen möchte.

Das Szenario

Die P.Dippides GmbH ist ein Start-up, das mit seinem autonom fahrenden Lieferbot „Bot.Bote“ einen Überraschungserfolg am Markt verzeichnet hat. Anfangs verfassten die Entwickler*innen intern die Dokumentation des Bot.Boten. Doch durch die steigende Nachfrage sind die Mitarbeiter*innen mit ihren eigentlichen Aufgaben mehr als ausgelastet. Zudem wünscht sich die Geschäftsleitung eine professionellere Dokumentation in einheitlicher Optik, da sich weiterhin ein exponentielles Unternehmenswachstum abzeichnet und man auch rechtlich auf der sicheren Seite sein möchte.

 

 

Statt zusätzlich zur sonstigen Expansion auch noch eine Dokumentationsabteilung aus dem Boden zu stampfen, soll ein externer Dienstleister mit der Technischen Dokumentation des Bot.Boten betraut werden. Nach einigen Gesprächen sind die Verantwortlichen bei P.Dippides überzeugt vom Angebot der dictaJet Ingenieurgesellschaft mbH und geben die Dokumentation in Auftrag.

 

 

 

Klärung der Arbeitsgrundlagen

Nach der Beauftragung geht es bei dictaJet sofort rund. Die Zeit drängt und bevor auch nur ein Wort der Dokumentation verfasst wird, müssen noch einige Grundlagen festgestellt werden. Ein Technischer Redakteur aus dem dictaJet-Team, nennen wir ihn Jens Schreiber, übernimmt den Auftrag. Zusammen mit der Vertriebsabteilung, die den neuen Kunden und seine Anforderungen (noch) am besten kennt, und in Rücksprache mit P.Dippides ermittelt Jens folgende Informationen:

  • Zielgruppe
  • Relevante Richtlinien und Normen (z. B. fällt der Bot.Bote als Maschine unter die Maschinenrichtlinie und muss daher eine Dokumentation zu allen Lebenszyklen beinhalten)
  • Benötigte Dokumentationsarten (Betriebsanleitung für Unternehmen, die den Bot.Boten für ihre Lieferungen einsetzen, sowie Wartungsanleitung für die Servicetechniker von P.Dippides und seinen Vertragshändlern)

Außerdem erstellt dictaJet zeitgleich einen Styleguide, um Einheitlichkeit, das gewünschte Layout und die Corporate Identity von P.Dippides sicherzustellen.

Technische Dokumentation Beispiel Prozess

Modularisierung und Schreiben der Dokumentation

Jetzt beginnt die Textarbeit, aber es geht immer noch nicht ans Schreiben. Stattdessen nimmt Jens sich die bisherige Dokumentation des Bot.Boten vor und modularisiert die Inhalte anhand der Strukturierungsmethode des „Information Mapping®“. Die daraus resultierenden „Informationshäppchen“ können bei einem Wiederholungsauftrag flexibel wiederverwendet werden, ohne dieselben Inhalte mehrfach beschreiben zu müssen. So gibt es jetzt z. B. einen Sicherheitshinweis zur Klemmgefahr beim Schließen des Paketfachs und ein Impressum, die als separate „Bausteine“ vorliegen und in eine weitere Dokumentation für P.Dippides nur eingefügt werden müssten.

Anschließend beschreibt Jens noch die neu hinzugekommenen Funktionen und Merkmale. Hier wird nun endlich klassisch geschrieben. Die entsprechenden Inhalte hat P.Dippides in Form verschiedenster Dokumente aus der internen Dokumentation geliefert. Aus ihnen zieht Jens die entscheidenden Informationen und bindet sie in überarbeiteter Form in die neue Anwenderdokumentation ein. Bei Unklarheiten hält er Rücksprache mit den P.Dippides-Entwickler*innen. So wird er langsam, aber sicher zum Experten für das Produkt und die speziellen Wünsche des Kunden.

Einbindung der Grafikabteilung

Als Nächstes benötigt Jens noch einige Grafiken, da sich manche Sachverhalte so besser darstellen lassen als mit einer reinen Beschreibung. Bilder sagen schließlich mehr als tausend Worte. Dazu wendet er sich an jemanden aus der Grafikabteilung, nennen wir sie Viktoria Vektor. Vicky erstellt nach Jens’ Anweisungen verschiedene digitale Zeichnungen für die Dokumentation. Sie helfen z. B. in der Produktvorstellung, die Aufmerksamkeit der Leser*innen auf die wesentlichen Bestandteile und Aspekte des Bot.Boten zu lenken. Denn im Gegensatz zu Produktfotos sind bei einer Technischen Zeichnung nur die relevanten Elemente dargestellt. Daher sind sie ein wertvolles Mittel, um Entscheidendes herauszuarbeiten und die Verständlichkeit der schriftlichen Dokumentation zu verbessern.

Technische Dokumentation Beispiel Grafiken

Auch wenn aktuell noch keine Übersetzung geplant ist, sind die Zeichnungen und Grafiken von Anfang an ohne Text konzipiert. Denn Text in Grafiken bedeutet bei der Übersetzung immer Zusatzaufwand. Stattdessen stellt Viktoria die wichtigen Punkte geschickt bildlich dar oder versieht sie mit einer Beigelung.

Korrekturzyklen und Freigabe

Sobald alle Inhalte passend zur Zielgruppe aufbereitet sind, geht die Dokumentation als Entwurf an P.Dippides. Die Produktverantwortlichen haben noch ein paar kleine Änderungswünsche. Sie möchten z. B. die Strichstärke einer Zeichnung verändern, einige inhaltliche Sätze hinzufügen und eine falsche Bestellnummer austauschen. Da Zielgruppe, Layout etc. vorab vereinbart wurden und bei der Erstellung enger Kontakt zum Kunden gehalten wurde, kommt es in dieser Phase aber nicht mehr zu gravierenden Änderungen.

Jens arbeitet die Kundenkorrekturen ein und liefert einen zweiten Entwurf aus. Diesmal stimmt alles und das Dokument wird freigegeben. Jetzt wird noch eine hochauflösende Druckversion erstellt, die P.Dippides direkt an eine Druckerei weiterleiten kann.

Nach dem Druck ist der Bot.Bote mit seinen neuen, zielgruppenspezifischen Handbüchern bereit, die Welt zu erobern.

Die Blogreihe

In den nächsten Monaten begleiten wir den Bot.Boten in weiteren Artikeln dieser Blogreihe durch verschiedene Themengebiete der Technischen Redaktion.