Projekte für die Schule dokumentieren

Gast #5300701
Lesenswert?

Hallo,

eigentlich bin ich ja nicht auf den Kopf gefallen, wenn man mich ins 
kalte Wasser wirft, aber hier? Die "einfache" Frage: Wie schreibt man 
eine korrekte Projektdokumentation?

Ich stehe gerade etwas ratlos da. Habe bereits angefangen etwas zu 
schreiben, aber ich bin irgendwie nicht davon überzeugt. Ich habe noch 
nie eine Projektdokumentation geschrieben und mein Lehrer (mache gerade 
die Technikerschule) gibt mir keine (richtige) Auskunft. Es gab nur eine 
reine Formatvorlage, ohne Kommentare.

Weder habe ich mal eine fertige Arbeit gesehen, noch weiß ich was rein 
kommt, noch aus welcher Perspektive man es schreiben soll. Die doch sehr 
einfachen und allgemeinen Beschreibungen im Netz bringen mich auch nicht 
so recht weiter. Bisher habe ganz allgemein beschrieben, was man machen 
muss um das Projekt selbst nachbauen zu können. In etwas so: "Machen Sie 
dies, achten Sie auf das und passen Sie da und da auf.". Ich finde, das 
macht aber nur begrenzt Sinn.

Eigentlich benötige ich nur mal einen Einblick in eine gute 
Projektdokumentation, damit ich weiß wie sowas aussehen soll. Ohne 
jegliche Info komme ich da nicht richtig weiter. Kennt jemand eine 
veröffentlichte Dokumentation, die ich mir anschauen kann? Brauche 
einfach mal ein konkretes Muster. Vielleicht reicht aber auch schon euer 
Input ;)

Danke an euch. Wünsche einen schönen Abend!

Freundliche Grüße,
Markus
______________________

Info am Rande:

Es geht konkret um ein Schrittmotor Projekt, welches meine Gruppe 
nachgebaut hat. Die Hardware ist kompletter Eigenbau, die Software eine 
fertige Datei aus dem Netz mit 1500 Zeilen C Code. Allerdings haben wir 
kleine Testprogramme selbst geschrieben und arbeiten auf die original 
Lösung hin.
Gast #5300719
Lesenswert?

Habe gerade nochmal in den Unterlagen geschaut, unser Lehrer erwartet 
eine "wissenschaftliche Abschlussarbeit". Die soll also so werden wie 
die Abschlussarbeit für einen staatlich geprüften Techniker.
Gast #5300768
Lesenswert?

War mir klar, dass so eine Antwort kommt. Man wird ja wohl noch Fragen 
dürfen, wenn man mal Hilfe braucht.

Im Netz steht nur was zur Formatierung und dem allgemeinen Inhalt. Was 
anderes habe ich nicht gefunden, da man mit allem Mist erschlagen wird.

Mir geht es nicht um den Inhalt selbst, sondern um das wie, also 
primär den Schreibstil.
Gast #5300789
Lesenswert?

Hallo Markus,

grob würde ich so eine Dokumenation folgendermaßen einteilen:

1) WAS willst du realiseren und was ist die Motivation dahinter?
Beispiel in deinem Fall wäre: Die Schrittmotorsteuerung bzw. Teile 
davon(Hardware-Entwicklung). Die Motivation dahinter kenn ich natürlich 
nicht, könntest aber schreiben wo du die Steuerung dann einsetzen willst 
oder könntest.

2) Ein klein bisschen Theorie, um denjenigen, der das mal lesen wird ein 
wenig abzuholen. Eventuell ist der Leser nicht im Thema und wirds dir 
danken.

3) Die Realisierung/Implementierung: Dazu gehören eine Systemübersicht, 
zB ein Schaltplan und die Erklärung "besonderer" Schaltungsteile. ZB 
eine H-Brücke und wie diese denn dann angesteuert wird, was 
Diagnosemaßnahmen sind um Fehler zu erkenne, etc. Bei Software eine 
Auflistung der Funktionen inkl. Erklärung.

4) Ergebnis/Fazit des Projekts: Hat alles so geklappt, wie du es geplant 
hast? Bist du auf Probleme gestoßen und musstest deswegen eventuell 
deinen Plan überdenken oder etwas ändern?

5) Anhang: Hier kommt wirklich alles an Schatplänen, Code und sonstigen 
geistigen Erzeugnissen rein, was du hervorgebracht hast.

6) Last but not least: Quellen! Es ist keine Schande, zu zitieren oder 
etwas zu übernehmen, man muss es halt nur kommunierzieren um Ärger zu 
vermeiden ;)

Beste Grüße
Hoffe dieser grobe Überblick hilft dir ein wenig weiter.
Gast #5301312
Lesenswert?

Die Frage ist nun: Wird es eine Abschlussarbeit oder eine Projektarbeit. 
Imho sind die Dokumente völlig anders aufgebaut.

Projekt:

Pflichtenheft (Was will der Kunde/Benützer haben? Ein Auto mit 4 Räder 
oder ein Auto mit 3 Räder? Stahlfelgen, Alufelgen)

Darauf resultiert der Projektbeschrieb (genaue beschreibung des Projekts 
und welche Art von Räder verwendet wird)

Dannach kommt die Planungsphase (wie wird es genau umgesetzt)

Umsetzung (der Plan wird in die Realität umgesetzt)

Inbetriebnahme (das Projekt wird in betrieb gesetzt und Test gemäss des 
Pflichtenhefts durchgeführt. Funktioniert das Projekt so wie es der 
Kunde will?)

Abschlussbericht mit der gesamten dokumentation an den benützer
#5301359
Lesenswert?

Antwort schreiben

Bitte melde dich an, um einen Beitrag zu schreiben.

oder

Mit Google-Account einloggen

Die Registrierung ist kostenlos und dauert nur eine Minute.

Jetzt registrieren