Technische Dokumentation erstellen lassen

Seit 1991 erstelle ich technische Dokumentation für technische Trainer, Servicetechniker und Projektleiter.

Eine interessante und anspruchsvolle Aufgabe! Oftmals müssen einige Hürden genommen werden, bevor die Dokumentation fertig gestellt werden kann und der Zeitrahmen ist knapp.

So fehlen beispielsweise die notwendigen technischen Details, Informationen sind noch confidential, die Ansprechpartner bei Projekten sind (noch) nicht bekannt oder das Projekt ist noch nicht vollständig strukturiert und durchdacht. Sind die anfänglichen Probleme gelöst, kann die eigentliche Arbeit beginnen.

Relevante Informationen werden gesammelt und nach Themen sortiert. Danach entsteht eine thematische Gliederung als ein erstes „Gerüst“ für das neue Dokument. Die vorhandenen Informationen werden den einzelnen Themen zugeteilt. Da die einzelnen Themen meist aufeinander aufbauen ist eine Akualisierung und Anpassung der ersten Gliederung und eine erneute Aufteilung der Inhalte fast immer notwendig.

Bei komplexen Inhalten müssen die Themen visualisiert werden, damit diese gemeinsam mit dem Text auch verständlich sind. Also werden die notwendigen Fotos, Screenshots, Grafiken und Flowcharts erstellt und ergänzt.
Am Ende wird das Layout optimiert und nochmals das Dokument auf Übersichtlichkeit, Richtigkeit und logischen Aufbau überprüft.

Erst jetzt steht die erste Version und wartet auf die offizielle Freigabe. Im nächsten Schritt beginnt die Erstellung der zusätzlichen Materialien.

 

Die Erstellung technischer Dokumentation ist nicht trivial, oftmals jedoch entscheidend für den Erfolg eines Projektes.
Nur mit der richtigen Dokumentation kann der Roll-Out und die Wartung korrekt durchgeführt werden oder eine Schulung effektiv und nachhaltig gestaltet werden.

Durch eine gute (Projekt-) Dokumentation, für die richtige Zielgruppe erstellt, wissen alle Beteiligten WAS, WIE, WANN und DURCH WEN getan werden muss.

Wussten Sie schon? Ohne Technische Dokumentation ist das Anbringen eines CE-Zeichens unzulässig!

Verlief am Ende das Projekt planmässig, so sind der Kunde und auch ich zufrieden.
Euer
Claus Wolfgramm
Technical Training Consultant | Knowledge Management | Tutorials und mehr…