Weiterbildung Technische Redaktion

Die Gebrauchsanweisung für Entwickler: Bei der Entwicklung von technischen Produkten, Systemen und Software ist das Verfassen einer nachvollziehbaren technischen Dokumentation unerläßich. Dabei ist es nicht nur wichtig den Status Quo zu erfassen, sondern auch die Gedanken der Herangehensweise und Entscheidungsfindungen: Eine schlüssige technische Dokumentation beinhaltet also auch die Historie der Entwicklung. Welche Argumente waren für bestimmte Weiterentwicklungen ausschlaggebend?

In einer Weiterbildung erfahren die Seminar-Teilnehmer, von was eine gute technische Dokumentation abhängt und welche Teile diese beinhalten soll, wie z. B. Historie, Entscheidungsfindungen, Argumente, Abhängigkeiten, Konventionen (z. B. Namenskonventionen), rechtliche Rahmenbedingungen, wirtschaftliche Rahmenbedingungen, Wettbewerbssituation, uvm.

 

Eine technische Projektdokumentation ist die entscheidende Grundlage für Weiterentwicklungen und sichert dem Unternehmen den Fortbestand in vielerlei Hinsicht. Solange nur der Entwicklungschef die Historie und geplante Erweiterungen einer Produktentwicklung im Kopf hat, entsteht für ein Unternehmen eine nicht akzeptable Abhängigkeit zum Wissensinhaber und unvorhersehbare Ereignisse wie Unfall, Kündigung uvm.

Sobald der Wissensträger (in der Regel der Projektleiter) sein Wissen zu Papier bringt, zwingt er sich selbst zur Strukturierung seiner Informationen. Alleine schon daraus ergeben sich häufig neue Entwicklungsansätze und Optionen. Zudem tut er sich in Zukunft viel leichter bei der Nachvollziehbarkeit von Entscheidungen in der Vergangenheit, also zu früheren Projektständen. Gegenüber der Geschäftsleitung kann der Projektverantwortliche immer auf Entscheidungsfindungen und Argumente oder sogar Entscheidungen des Managements zurückgreifen.

Ein weiterer Vorteil von guten Projektdokumentationen liegt darin, dass das gesamte Projektteam über Historie, Zwischenstände, Entscheidungskriterien, Plan, Meetingergebnisse, Schulungen und Ziele ständig informiert ist und sozusagen am gleichen Seil zieht. Über Schreibrechte (Abkommen innerhalb des Teams oder technisch innerhalb einer Dokumentationssoftware) kann auch vereinbart werden, wer welche Teile der technischen Dokumentation fortführen kann.

 

Es geht nicht darum, dass die Geschäftsleitung über jedes technische Detail stets im Bilde sein muß:

Vielmehr ist es unabdingbar über wichtige Entscheidungen informiert zu sein und nachvollziehen zu können. Durch eine gute Projektdokumentation können Aufgaben und Zuständigkeiten leichter an andere Mitarbeiter übertragen werden.

Für Investoren ist eine schlüssige technische Dokumentation unerlasslich und spiegelt die Gewissenhaftigkeit des gesamten Unternehmens wider.

 

Je nach Größe und Komplexibilität eines Projekts wächst auch der Aufwand für das Dokumentieren. Dabei gibt es in der Regel mehrere technische Redakteure der Dokumentation, die sich an vorher festgelegte Konventionen halten.

 

Während die meisten Projekte in herkömmlichen Textverarbeitungsprogrammen verfaßt werden, gibt es auch spezielle Software für technische Dokumentationen. Allerdings lernt man in einem Seminar für technische Redaktion auch, dass bereits auch MS Word diverse Grundfunktionen wie etwa historische Stände bietet.

 

Einige Projektleiter suchen im Internet nach einer passenden Vorlage für eine technische Dokumantation oder einem ähnlichen Beispiel. Davon ist allerdings abzuraten, weil das eigene Projekt in der Regel nicht in das Korsett eines anderen paßt und eben jedes Projekt seine eigenen Regeln, Abhängigkeiten und Eigenheiten besitzt. Die beste Vorlage ist das Erstellen der eigenen Projektdokumentationen von Grund auf. Wir empfehlen dazu eine Schulung oder Seminar von Profis.

 

Welcher Schreibstil der richtige ist, hängt immer vom Projekt, der Branche (Maschinenbau, Software-Engineering, Medizintechnik) ab und lernen Seminar-Teilnehmer ebenfalls in einer Schulung.

 

Das Themen "technische Dokumentation" und "Produkthaftung" sind aus rechtlicher Sicht sehr eng verbunden. Im Produkthaftungsfall steht die Produktdokumentation mehr denn je im Mittelpunkt des Geschehens: Stichwort grobe Fahrlässigkeit usw. Fehlt die technische Dokumentation komplett, hat der Hersteller im Streitfall besonders schlechte Karten.