Probleme rund um die Projektdokumentation - und wie man sie löst

Mit Dokumentationen haben die meisten wenig Erfahrung. Das ist kein Grund zur Panik, aber auch nicht für Nachlässigkeiten.

Dieser Prüfungsteil trägt ein Viertel zur Gesamtnote bei, genauso viel also wie Präsentation und Fachgespräch zusammen. Auch in Ihrem späteren Berufsleben müssen oft Dokumentationen angefertigt werden, und die Prüfer wollen ja letzten Endes wissen, ob Sie für den Beruf taugen.

Worum es geht

Der Prüfling soll zeigen, dass er ein Projekt planen, abwickeln und dokumentieren kann. Und zwar kundengerecht.

Kundengerecht ist es zum Beispiel niemals, wenn Ihre Arbeit vor Rechtschreibfehlern wimmelt. Dies ist keine Lappalie, sondern ein gewichtiger Abwertungsgrund, denn Sie zeigen damit, dass Sie es entweder nicht besser können oder nicht für nötig halten, die Arbeit von einem Bekannten korrekturlesen zu lassen. Die Prüfer gehen dann zwangsläufig davon aus, dass Sie das auch in Ihrer späteren Berufspraxis so machen werden.

Kundengerecht ist es genauso wenig, wenn sie mit Layoutfeatures herumspielen. Ein Anfängerfehler ist, einfach draufloszuschreiben. Solange Sie kein durchgängiges Layoutkonzept haben, brauchen Sie nicht anzufangen.

Sie können aber auch zuerst den Rohtext schreiben und zum Schluss erst formatieren. Diese Methode spart Zeit, verlangt aber etwas Erfahrung.

Layoutvorgaben

Manche IHKs schreiben bestimmte Layouts vor. Ist dies der Fall, dann wäre es unklug, sich eigene auszudenken. Andernfalls gelten grob folgende Regeln:

Das kleine Einmaleins der Typographie

Hinsichtlich der Fonts gelten einige Regeln, jedenfalls vom professionellen Standpunkt her. Für Fließtext sollte man eine Proportionalschrift mit Serifen benutzen, z. B. Times, New York oder Palatino. Bei Proportionalschrift haben die Buchstaben einen unterschiedlichen Platzbedarf, der proportional zur Buchstabenbreite ist. Der Raum wird so besser ausgenutzt. Serifen sind die Verbreiterungen am Fuß und Kopf von Buchstaben. Serifen erleichtern bei Fließtext die Lesbarkeit.

Für Beschriftungen in Grafiken benutzt man serifenlose Proportionalschrift wie Arial oder Helvetica, da Serifen hier die bildliche Klarheit stören würden.

Quellcode und Shell-Auszüge stellt man mit einem Fixed-Width-Font (Monospace-Font) wie Courier oder Monaco dar, damit Einrückungen untereinander stehen.

Mag sein, dass Ihnen das übertrieben vorkommt - Vielleicht geraten Sie aber an einen Prüfer, der in der Materie geschult ist. Wenn nicht, so wirkt Ihre Arbeit auch auf einen Nichtfachmann optisch ansprechender. Jedenfalls sind die Office-Produkte einer Redmonder Softwarefirma kein Maßstab. Nehmen Sie wenn möglich TeX.

Ein peinlicher Fehler sollte noch erwähnt werden, die Übernahme von Textformatierungsmerkmalen in das Inhaltsverzeichnis bei automatischer Indexerstellung. Im Inhaltsverzeichnis haben Hervorhebungen nichts zu suchen!

Sprachliches und Schreibstil

Die Projektdokumentation ist eine Facharbeit und soll frei von persönlichen oder anderen sachfernen Einflüssen verfasst werden. Oberstes Gebot ist ein sachlicher, deutlicher, wertneutraler, fachsprachlicher Schreibstil. Dies folgt aus den Zielen in der Prüfungsverordnung. Dokumentationen schreibt man in der Gegenwartsform (Präsens), also nicht:

"Der Kunde betonte, dass ihm eine fristgerechte Fertigstellung wichtig sei."

sondern besser:

"Fristgerechte Fertigstellung hat laut Kundenwunsch hohe Priorität."

"Ich-Form"

Das Wort "ich" ist verpönt! Auch wenn Ihnen Schulaufsätze in der 1. Person besser von der Hand gehen, in einer technischen Dokumentation wirkt dies amateurhaft. Haben Sie schon einmal Produktdokumentation gesehen, in der der Autor in der Ich-Form schreibt? - eben!

Die Ich-Form lässt sich am einfachsten umgehen, indem man sich auf die Sache konzentriert und konsequent mit starken Verben in der Aktivform formuliert. Dazu ein Beispiel:

Ich wähle das Programm x für den Zweck y, weil...
(Ich-Form, aktiv, - so nicht!)
Das Programm x wird von mir für den Zweck y gewählt, weil...
(Mir-Form, passiv, - nie und nimmer!)
Das Programm x wird für den Zweck y gewählt, weil...
(passiv, - Besser, aber nicht gut!)
Das Programm x kommt zum Einsatz, weil...
(personenneutral, aktiv, ohne Hilfsverb - OK!)

Gebunden oder ungebunden?

Wenn Ihre IHK - diese legt das nämlich fest - nichts anderes vorschreibt, geben Sie Ihre Dokumentation gebunden oder im Schnellhefter ab. Ein Copy-Shop macht Ihnen das preiswert im Handumdrehen. Nehmen Sie nicht die billigste Variante, denn wenn sich die Arbeit schlecht umblättern lässt oder gar Blätter herausfallen, wird Ihr Korrektor nicht sehr erbaut sein. Die Ausführung sollte weder billig noch überzogen wirken. Von manchen IHKs ist berichtet worden, dort würden die Blätter später wieder herausgetrennt. In dem Fall können Sie sich die Mühe natürlich sparen.

Haben Sie mehrere Exemplare abzuliefern, so müssen diese allesamt den gleichen Umfang haben!

Seitenbeschränkung

Einige IHKs legen eine Beschränkung der Dokumentation auf z. B. 10 Seiten fest. Deckblatt, Inhaltsverzeichnis und Anhang gehören nicht zur Seitennummerierung. Wenn Sie alles zusammengetippt haben, und es sind 35 Steiten dabei herausgekommen, dann

Wie folgendes Beispiel zeigt, kann die Platzersparnis beträchtlich sein; es handelt sich ausnahmslos um 24-Punkt-Schriften!

Legende:
1) Courier, 24
2) Times, 24
3) Apple Garamond Book, 24
4) wie 3), Laufweite minimiert

Platzersparnis sollte die Lesbarkeit natürlich nicht reduzieren. Wahrscheinlich wird Ihr Prüfungsausschuss nicht nennenswert abwerten, wenn Sie ein paar Seiten zuviel abliefern.

Inhalt

Das ist nicht so schwierig. Die Dokumentation soll beschreiben

Halten wir fest: Die Dokumentation soll auch den Weg vom Start bis zum Ziel nachvollziehbar machen, nicht nur das Ergebnis beschreiben! Das gesamte Projekt und seine Beschreibung soll außerdem möglichst praxisrelevant sein.

Manche schreiben Aufsätze, die sich wie "mein schönstes Ferienerlebnis" lesen, andere kopieren seitenweise aus Online-Tutorials oder Produktdokumentationen. Das ist nicht Sinn einer Projektdokumentation. Dass Sie über Wissen verfügen, beweisen Sie in anderen Prüfungsteilen; hier sollen Sie zeigen, wie Sie Ihr Wissen anwenden. Natürlich sollten Sie auch die fachlichen Grundlagen beleuchten, aber dies darf nicht zum Schwerpunkt der Arbeit ausarten.

Zu guter letzt heißt praxisrelevant, dass Sie nicht nur die fachliche Seite behandeln, sondern auch das kaufmännische und betriebliche Drumherum nicht fehlen darf, also

Am besten packt man all dies in den Anhang.

Probleme mit Firmengeheimnissen

Manchmal verbieten Firmen, Originalbelege abzuliefern, weil damit Firmengeheimnisse bekannt werden würden. Das ist verständlich. Netzwerktopologie und -konfiguration berühren die Datensicherheit und Händlerkontakte und Preisaufstellungen sollte man besser geheimhalten, wenn man beim nächsten Angebot keine böse Überraschung erleben will.

Im Prüfungsausschuss sitzen Leute aus der Branche, vielleicht sogar von der Konkurrenz. Andererseits müssen die ja Ihre Arbeit bewerten und brauchen dazu möglichst umfassende Informationen. Also haben sie ein berechtigtes Interesse. Was nun?

Darauf gibt es keine befriedigende Antwort. Falls nötig, müssen Sie solche Passagen unkenntlich machen. Wenn dies aber dazu führt, dass Ihre Leistung nicht mehr bewertet werden kann, weil die Beurteilungsgrundlage verloren geht, sitzen Sie in der Tinte. Wählen Sie also von Anfang an nur ein solches Projekt, das Sie außerhalb auch "verkaufen" können, ohne dass Ihr Arbeitgeber auf die Barrikaden geht.

Unvorhersehbare Umstände im Zeitplan

Ein Plan ist dazu da, über den Haufen geschmissen zu werden!

Lassen Sie sich in dem Punkt nicht beirren. Sobald sich neue Gesichtspunkte ergeben, die ein Festhalten am Plan zum Nachteil werden lassen, ist er überholt. Zwar müssen Sie einen Plan einreichen, mit zeitlicher Aufschlüsselung der einzelnen Projektteile, Beschreibung dessen, was Sie überhaupt machen wollen und einigem mehr. Aber man kann sich beinahe darauf verlassen, es kommt meist anders als geplant, und die 35 bzw. 70 Stunden Projektdauer sind im Handumdrehen vorbei.

Scheuen Sie sich nicht - falls nötig - von Ihrem Zeitplan abzuweichen. Solche Entscheidungen dokumentieren Sie dann mit Begründung; Ihr Korrektor wird das wahrcheinlich sogar zu Ihren Gunsten werten, weil Sie Flexibilität und Entscheidungsfähigkeit beweisen. Übrigens steht nirgends geschrieben, Sie müssten Ihr Projekt in einem Stück durchführen. Sie können die Zeit durchaus auf einen ganzen Monat verteilen. Damit gewinnen Sie zeitlichen Spielraum. Aber nicht übertreiben; wenn der Prüfungsausschuss misstrauisch wird, ist das nicht so schön für Sie.

Eins noch hierzu: Die Verletzung formaler Bestimmungen wie der Stunden-Obergrenze kann Ihnen das Genick brechen. Unter Umständen sind Sie also gezwungen, Ihren Zeitplan "schönzurechnen".

Kosten-Nutzen-Analyse

Alle IT-Berufe gelten zur Hälfte als kaufmännisch. Schon deshalb gehört zu einem ganzheitlichen Projekt auch der wirtschaftliche Nutzen und der entstandene Kostenaufwand. Oft lässt sich der Nutzen nicht beziffern; dann kann man sich auf die Kosten beschränken. Kostenrechnung ist eine irrsinnig komplexe Materie. Niemand erwartet also Expertenwissen. Aber Grundkenntnisse sollten in jedem Fall angewendet werden, weil man damit Kostenbewusstsein demonstriert.

In Prüfungsgesprächen hört man auf die Frage "Was hat das Projekt eigentlich gekostet?" manchmal sinngemäß: "Gar nichts, weil der Betrieb mich ja sowieso bezahlen musste und die technischen Geräte alle schon da waren." - Ein vermeidbarer Fauxpas.

Geklaute Projekte

Abkupfern ist ziemlich gefährlich. Sie ahnen vielleicht nicht, wie klein die Welt sein kann. Häufig kennen sich die Prüfungsausschüsse verschiedener IHKs.

Sie geben außerdem eine schriftliche Erklärung ab, dass Ihre Arbeit noch keinem anderen Ausschuss vorgelegen hat. Damit werden Sie zum Betrüger mit der Folge, dass Sie die Prüfung wegen Plagiats nicht bestehen. Sogar wenn der Schwindel Jahre später auffliegt, kann man Ihnen u. U. den Facharbeiterbrief wieder entziehen.

Literaturquellen

Quellen dürfen Sie nicht nur verwenden, Sie sollen es sogar. Sie werten dadurch Ihre Arbeit auf und zeigen, dass Sie den fachlichen Background Ihres Themas recherchiert haben. Quellen können auch eine Entscheidung begründen oder untermauern.

Legen Sie ein Quellenverzeichnis am Ende der Arbeit an und verweisen Sie im Text auf die jeweiligen Einträge. Wie man das macht, darüber gibt es bibliographische Standards, die beachtet werden sollten. Schauen Sie sich dazu einfach mal eine wissenschaftliche Fachveröffentlichung an; in der Wissenschaft werden nämlich die geltenden Regeln sehr genau befolgt.

Zitieren Sie ohne Quellenangabe, sind Sie ein Plagiator.