So kann Technische Dokumentation auch entstehen...

Ein bisschen provokant und überzogen mag diese Darstellung sein… Aber im Kern trifft sie die Sache zumindest nicht nur am Rand.

So manch Technischer Redakteur kennt die Situation und fragt sich auch regelmäßig: "Wie bekomme ich jetzt nur die Informationen von den Kollegen aus der Entwicklung?" Vielleicht unterscheidet sich Ihre Situation auch nicht immer stark von der im Folgenden geschilderten:

  1. Fragen Sie Ihren Entwickler, wie dieses "vermaledeite Ding" überhaupt funktioniert.
  2. Sie ernten eisiges Schweigen.
  3. Wenn Sie genau hinhören, könnten Sie eine Stecknadel fallen hören.
  4. Fühlen Sie sich auch ganz allein auf weiter Flur?
  5. Dann gibt es nur eine Möglichkeit, die redaktionelle Arbeit zu erledigen: Schreiben Sie einfach etwas. Irgendetwas.
  6. Geben Sie Ihr Geschriebenes an den Entwickler weiter.
  7. Sie werden beobachten, wie der Entwickler sich aufregt, wie sehr Sie einfach ALLES missverstanden haben.
  8. Und während der Entwickler schimpft, wird er zwischen seinen Vorwürfen auch Informationsfizzelchen rausrücken.
  9. Sammeln Sie diese kleinen Stücke ein. Sie sind die einzige verlässliche technische Information, die Sie erhalten werden.
  10. Versuchen Sie, diese winzigen Informationen zu einem tragenden Teppich zu weben und Ihre bisherige Dokumentation zu ergänzen. Technisch korrekt versteht sich.
  11. Machen Sie bei Schritt 6 weiter.

Und wenn Sie eher von der Seite der Entwickler sind und nicht der Technische Redakteur - vermutlich fühlen Sie sich ebenso missverstanden. Oder Sie sollen als Entwickler plötzlich auch die Dokumentation erstellen und wissen gar nicht, wie Sie anfangen können? - Das ist nur verständlich, viele unserer Kunden nutzen bereits unsere Fachkunde, um Ihre Entwickler die wirklich wichtigen Dinge erledigen zu lassen: entwickeln.

Die Handbuch Experten versuchen, die Schritte 1 bis 5 möglichst zu umgehen und durch gezielte Fragen vorab Informationen zu erhalten. - Und verschiedene Leute, vielleicht auch in Ihrem Unternehmen, arbeiten bereits (vielleicht schon länger?) daran, den Prozess der Handbuch-Erstellung besser zu gestalten.

Gerne unterstützen wir Sie auch dabei mit unserer Erfahrung aus mehreren Jahrzehnten Technischer Dokumentation.

Weitere Artikel, die Sie interessieren könnten