Dokumentation einer Projektarbeit

[pippo]

Wir müssen an unserer Technikerschule eine Projektarbeit abliefern und diese Dukumentieren. Wie immer bekommt man keine Anhaltspunkte, wie sowas aufgebaut sein soll und im Internet konnte ich nichts finden, was zu meiner Arbeit passen würde.

In meinem Fall hab ich nen Schaltplan erstellt, das dazugehörige Layout designed, die Platine bestückt und zuletzt den Mikrokontroller programmiert.

Bisher siehts so aus:
1 Einleitung 2
1.1 Aufgabestellung 2
1.2 Zielsetzung 2
2 Planungs- und Definitionsphase 4
2.1 Auswahl der Hauptkomponenten 4
2.2 Ausführliche Beschreibung 6
2.3 Abgrenzung zu anderen Systemen 6
2.4 Voruntersuchungen des Produktes 7
2.4.1 Minimalanforderungen 8
2.4.2 Userinterface 9
2.5 Projektplan 12
3 Entwurfsphase 13


Wie soll ich nun alles weiter einteilen, bzw. soll ich irgendwas verändern?

[mobius]

Wir müssen an unserer Technikerschule eine Projektarbeit abliefern und diese Dukumentieren. Wie immer bekommt man keine Anhaltspunkte, wie sowas aufgebaut sein soll und im Internet konnte ich nichts finden, was zu meiner Arbeit passen würde.

In meinem Fall hab ich nen Schaltplan erstellt, das dazugehörige Layout designed, die Platine bestückt und zuletzt den Mikrokontroller programmiert.

Bisher siehts so aus:


Wie soll ich nun alles weiter einteilen, bzw. soll ich irgendwas verändern?

Was du tatsächlich getan hast, spielt eigentlich gar keine Rolle für die Dokumentation einer Projektarbeit, denn das magische Stichwort ist Projektmanagement.

Auszug einer IHK Handreichung, worauf bei der Bewertung geachtet wird:
1. Gestaltung des Portfolios
1.1 Äußere Form (Gestaltung von Text, Tabellen, Grafiken etc.)
1.2 Inhaltliche Form (Strukturierung, fach- und normgerechte Darstel-lung, Anhang, Quellen, Erklärungen etc.)
1.3 Zielgruppengerechte Dokumenta-tion, dem Antrag entsprechend nachvollziehbar

2. Ausgangssituation
2.1 Projektziel und Teilaufgaben (ggf. Abweichungen zum Projektantrag), Kundenwünsche
2.2 Projektumfeld, Prozessschnittstel-len (Ansprechpartner, Einstieg, Ausstieg)

3. Ressourcen- und Ablaufpla-nung
3.1 Personal-, Sachmittel-, Termin- und Kostenplanung
3.2 Projekt-Ablaufplanung bzw. methodisches Vorgehen, Testpla-nung, meth. Alternativen

4. Durchführung und Auftragsbearbeitung (unter besonderer Berücksichtigung der fachlichen Richtigkeit)
4.1 Prozessschritte/Vorgehensweise (insb. Problemanalyse)
4.2 Qualitätssicherung/-kontrolle, Tests
4.3 Abweichungen, Anpassungen, Ent-scheidungen, Lösungsalternativen

5. Projektergebnisse
5.1 Abnahme, Projektübergabe
5.2 Bewertung der Ergebnisse / des Projektverlaufs, Soll-/Ist-Vergleich

Daraus kannst du schonmal ablesen, was im Minimum drin sein muss.
Hier noch ein komplettes Beispiel für den Inhalt einer Doku:


1. Projektdefinition ................................................................................ ..........................................
1.1. Projektumfeld ................................................................................ ........................................
1.2. Ausgangslage ................................................................................ .........................................
1.3. Projektbeschreibung ................................................................................ ..............................
1.4. Projektschnittstellen ................................................................................ ..............................
Prozessschnittstellen ................................................................................ ....................................
Organisatorische Schnittstellen ................................................................................ ...................
1.5. Änderungen gegenüber dem Projektantrag .........................................................................
2. Projektplanung ................................................................................ .............................................
2.1. Vorgehensmodell ................................................................................ ...................................
2.2. Projekt- und Zeitplanung ................................................................................ .......................
2.3. Wirtschaftlichkeitsanalyse ................................................................................ .....................
Monetärer Nutzen ................................................................................ ........................................
Nicht-Monetärer Nutzen ................................................................................ ..............................
2.4. Qualitätsplanung / Testplanung ................................................................................ ............
3. Projektdurchführung ................................................................................ ....................................
3.1. Entwurfsphase ................................................................................ .......................................
3.2. Implementierungsphase ................................................................................ ......................
3.3. Testphase ................................................................................ .............................................
4. Projektabschluss ................................................................................ .........................................
4.1. Abnahme durch den Auftraggeber ................................................................................ ......
4.2. Soll-Ist-Zeitvergleich ................................................................................ ............................
4.3. Qualitätsbericht ................................................................................ ...................................
4.4. Abschließende Wirtschaftlichkeitsbetrachtung ..................................................................
4.5. Projektreflexion ................................................................................ ...................................
5. Glossar ................................................................................ .......................................................
...
6. Anlagenverzeichnis ................................................................................ .....................................
7. Abbildungsverzeichnis ................................................................................ ................................

[pippo]

Vielen Dank schon mal, hätt aber noch ne Frage: Sollte man noch eine Einleitung schreiben? Hab mal irgendwo gelesen, dass das dabei sein sollte, weil von den Leuten ohne Fachkenntnissen meistens nur diese gelesen wird.

Bin leider noch am Projekt aufgehalten worden, drum komm ich erst jetz zur Doku

[pippo]

Hier werden doch paar Leute sein, die sowas schon gemacht haben ???

Mitlerweile frag ich mich auch, wie man die Kosten- und Ressourchenplanung sinnvoll beschreibt, wenn es ja eigentlich ein privates Schulprojekt ist. Software musste z.B. keine mehr gekauft werden, da bereits vorhanden

[mobius]

Vielen Dank schon mal, hätt aber noch ne Frage: Sollte man noch eine Einleitung schreiben? Hab mal irgendwo gelesen, dass das dabei sein sollte, weil von den Leuten ohne Fachkenntnissen meistens nur diese gelesen wird.

Bin leider noch am Projekt aufgehalten worden, drum komm ich erst jetz zur Doku

Einleitung? Davon hab ich noch nichts gehört. Ich würd mich an IHK Vorgaben halten, wenn es im Rahmen einer Ausbildung ist. Natürlich Sachen weggelassen die hier noch keine Rolle spielen, wie z. B. Projektantrag etc.

IHK Auszug (kann variieren):
1. Deckblatt (entsprechend der Vorlage auf Seite 20)
2. Erklärung des Betriebes (entsprechend der Vorlage auf Seite 21)
3. Kopie des genehmigten Projektantrages
4. Inhaltsverzeichnis/Gliederung einschließlich Gliederung der Anhänge (jeweils mit Seitenangabe)
5. Projektbericht bzw. eigentliche Projektdokumentation (10 bis 15 Seiten)
6. Bei Bedarf ein projektbezogenes Glossar, ein Quellenverzeichnis und weitere Dokumente im Anhang

Damit bleibt es beim Umfang eigentlich bei Deckblatt, Gliederung, Projektdoku, Glossar, Quellenverzeichnis und Anhänge. Prinzipiell ist die Projektdokumentation an eine bestimmte Leserschaft gerichtet, soll aber dennoch auch für "nicht ganz Laien" lesbar und verständlich sein. Von daher ist eine zusätzliche Einleitung unnötig. Die eigentliche Einleitung ist 1.1 und 1.2 aus meinem Beispiel. Das sollte für absolut jeden verständlich sein.

Hier werden doch paar Leute sein, die sowas schon gemacht haben ???

Mitlerweile frag ich mich auch, wie man die Kosten- und Ressourchenplanung sinnvoll beschreibt, wenn es ja eigentlich ein privates Schulprojekt ist. Software musste z.B. keine mehr gekauft werden, da bereits vorhanden

Personalkosten (wenn es rein schulisch ohne Ausbildungsrahmen ist, dann ist es wirklich etwas "dumm"), Räumlichkeiten, Strom etc. pp.
Wenn du etwas nicht kaufen musst, dann dokumentiere auch das.

Als Tipp: Du kannst quasi jeden Begriff aus dem PM googlen und Beispiele via Wikipedia finden oder noch besser in jedem PM Buch (da gabs demletzt einen Thread im OffTopic zu).

Sicherlich werden viele Leute hier sowas schonmal gemacht haben, aber die meisten Fragen kannst du besser und schneller selbst lösen. Wiki und ein Grundlagen Projektmanagement Buch sind ausreichend.

[pippo]

Ok, dann lass ich die Einleitung mal weg. Vielleicht schau ich heut gleich mal nach nem Buch. Hab gestern den halben Tag damit verbracht, im Internet nach solchen Begriffen oder bereits fertigen Dokumentationen zu suchen, aber da war fast nix dabei. Die fertigen Dokumentationen waren zu 90% absoluter Schrott und gefundene Erklärungen reden viel um den heissen Brei rum

[Zool]

Eine wissenschaftliche Arbeit besteht i.A. aus

Einleitung
Grundlagen/Ausgangssituation
Ergebnisse
Diskussion und Zusammenfassung
ggfs. Anhänge, Literaturverzeichnis etc.

[pippo]

Ok, jetz gehts dem Ende hinzu und an die Doku des Programms. Ich hab ca. 800 Zeilen C-Code, wie dokumentiert man sowas? Dazu konnte ich kein einziges Beispiel finden. Ich kann ja jetz kaum die 800 Zeilen erklären.

Ich hätte zuerst mal ein Struktogramm gezeigt und danach mal das allerwichtigste aus dem Code rausgegriffen und im Anhang dann erst den kompletten Code auskommentiert angefügt. Wär das ok?