Notizen zum Projekt (-Praktikum)


von Prof. Jürgen Plate

Projektdokumentation

An dieser Stelle wird knapp zusammengefasst, was aus dem Kapitel "Dokumentation" der Projekttechnik-Vorlesung für uns besonders wichtig ist. Die Dokumentation ist kein Ablaufprotokoll des Praktikums. Es soll daher nicht aufgezählt werden, welche Schritte notwendig waren, um die gestellte Aufgabe zu lösen. Vielmehr soll die gefundene Lösung dokumentiert und deren Wahl begründet werden. Zur Dokumentation gehört auch immer eine Bedienungsanleitung. Natürlich ist auch auf korrekte Rechtschreibung und Grammatik zu achten (u. a. Groß- und Kleinschreibung, Kommasetzung, Bindestriche, Absätze ...). Der Umfang liegt bei 10 - 20 Seiten (Erfahrungswert). Die Doku hat eine Titelseite mit Projekttitel, Semester und Teilnehmern der Arbeitsgruppe. Grundsätzlich ist dabei auf einen sachlich-neutralen Ton zu achten, der keinen Platz für umgangssprachliche Formulierungen zulässt. Abbildung fördern das Verständnis des Textes. Ein Bild sagt zwar mehr als tausend Worte, ersetzt aber keinesfalls erklärende Ausführungen im Text. Es muss auch immer sichergestellt werden, dass Abbildungen im Textfluss referenziert und dann auch beschrieben werden. Jede Abbildung sollte außerdem mit einer aussagekräftigen Bildunterschrift versehen sein. Siehe auch: Über das Schreiben von Fachaufsätzen.

Die Projektdokumentation umfasst die Dokumentation des Projektablaufs, die in der Regel recht knapp ausfallen wird. Mit ihr wird sofort nach den Vorüberlegungen begonnen:

Die Produktdokumentation umfasst die technischen Unterlagen des hergestellten Geräts. In ihr sind Entwicklung und Bedienung des Geräts festgehalten. Dies umfasst unter anderem:

Da die Projekte im Praktikum sehr überschaubar sind, darf die Dokumentation ruhig etwas knapp sein. Sie sollte so gehalten sein, dass ein Kommilitone von Ihnen das Projekt nachbauen kann. In der schriftlichen Dokumentation sollte also mit einer kompakten Übersicht beginnen (was mache ich da eigentlich?). Darauf folgt eine Schaltungsbeschreibung, die insbesondere Dinge enthalten muss, die nicht auf den ersten Blick klar sind. Auch sollten Besonderheiten der Schaltung oder der verwendeten Bauteile erwähnt werden. Ist Programmierung nötig, schließt sich eine eine Softwaredoku an (die auch auf einen gut(!) kommentierten Quellcode verweisen darf). Das Ganze läßt sich meist auf wenigen Seiten Text mit einigen erklärenden Bildern abhandeln.

Im Datei-Anhang werden dann Schaltplan, Platinenlayout (ggf. mit Verbesserungen von Fehlern der ersten Version) und Software hinzugefügt.


Copyright © Hochschule München, FK 04, Prof. Jürgen Plate
Letzte Aktualisierung: