|
Die Projektdokumentation soll den Werdegang des
Projektes von der ursprünglichen Projektspezifikation bis
zum endgültigen Projektergebnis/ Produkt, also den
gesamten Projektprozess,
wiederspiegeln. Folglich beginnt die Projektdokumentation
mit einer vollständigen Beschreibung
des Auftrages und der zu erreichenden Projektziele
und endet mit dem Nachweis dafür, dass alle Ziele
erreicht wurden, idealerweise also mit dem Inbetriebnahmeprotokoll.
Der Zweck der Projektdokumentation liegt im Wesentlichen
darin, dem späteren Leser, der vor der Aufgabe der
Bewältigung eines ähnlichen Projektes steht,
entscheidende Schlüsselstellen
oder Gelenkstellen des
Projektes aufzuzeigen. An welchen Punkten des Projektes
wurden welche wichtige Entscheidungen getroffen? Warum
wurden die Entscheidungen
so und nicht anders getroffen? Welche Alternativen wurden
erörtert? Welche Auswirkungen hatten die letztendlichen
Entscheidungen? Welche Quellen wurden
zur Erlangung einer Entscheidung genutzt? Hinweise, wie
mit dem heutigen Wissen an diesen Stellen eventuell anders
verfahren würde, können hierbei zweckdienlich sein.
Eine gute Projektdokumentation eines
Vorgängerprojektes bewahrt den Leser davor, in seinem
anstehenden Projekt die gleichen Fehler zu begehen.
Ferner sollte es mit Hilfe der Projektdokumentation
möglich sein, das erzeugte Produkt relativ einfach
nachzuproduzieren. Daher gehören umfassende Material-
und Werkzeuglisten
ebenso zu einer guten Projektdokumentation wie eine
sinnvolle und nachvollziehbare Ablauf-
und Zeitplanung sowie
ein vollständiger und selbstverständlich fehlerfreier
Satz aller relevanten technischen
Zeichnungen.
Die praktische Umsetzung
der Zeichnungen in Teilkomponenten des Produktes und
letztendlich in das Gesamtprodukt selbst muss komplett
nachvollziehbar sein. Hilfreich hierbei kann eine vielsagende
Bebilderung sein. Wichtig ist, dass nicht die
Bearbeitungsmethoden selbst bis in's letzte Detail
beschrieben werden sondern erläutert wird, welche
Bearbeitungsmethoden warum angewandt wurden.
Beispielsweise sollte beim Fügen zweier Werkstücke durch
Punktschweißen nicht das Punktschweißen erklärt werden
sondern warum hier die Methode des Punktschweißens
angewandt wurde.
Wo auch immer eine Parametrierung
an Komponenten des Produktes erfolgt, beispielsweise die
genaue Einstellung eines Sensors oder Aktors, sei sie
mechanisch - beispielsweise die genaue Einbauposition -
elektrisch oder wie auch immer geartet, ist diese zu
dokumentieren und zu begründen. Ein weiteres Beispiel
hierfür sind das Einstellen von Verzögerungszeiten oder
auch Zählerparametern in der Programmierung.
Es erklärt sich von selbst, dass eine ordentliche äußere
Form und eine sinnvolle innere
Gliederung ebenso zum Erfolg der
Projektdokumentation beitragen wie eine anschauliche
und verständliche Sprache unter gezielter
Verwendung von Fachbegriffen
(Fachsprache).
Eine unvollständige, unstrukturierte
Projektdokumentation, im schlimmsten Falle noch in
schlechtem Deutsch und fachlich fehlerhaft geschrieben,
wird ihre - oben beschriebenen - Zwecke nicht erfüllen.
|
