Dokumentation

Tach (hoffe mal das ist das richtige Unterforum, falls nicht bitte einfach verschieben. Danke!),

Ich arbeite von der Berufsschule aus seit längerem an einem größeren Projekt, welches sich von einem Schuljahr ins nächste erstreckt hat. Leider haben wir den Lehrer vom letzten Jahr nun nicht mehr, das Projekt läuft aber mit Abgabetermin trotzdem weiter, weshalb ich den Lehrer vom letzten Jahr nicht mehr so einfach erreichen kann.

Deshalb frag ich mal euch, was ihr machen würdet :wink: . Und zwar habe ich einen Zettel, auf dem alle abzugebenden Dokumente stehen. Das wären folgende:

[ul][li]ER-Modell
[/li][li]Zeitplanungsdokument
[/li][li]Testplan
[/li][li]Pflichtenheft
[/li][li]EPK
[/li][li]Produktpräsentation
[/li][li]Dokumentation
[/li][li]Benutzerhandbuch
[/li][li]Testprotokoll
[/li][li]Zeiterfassung / Stundenzettel
[/li][li]Kosten-Nutzen-Analyse[/ul]
[/li]
Gut, habe ich alles erstellt. Nur unter dem Punkt „Dokumentation“ kann ich mir nichts vorstellen. Imho sollte das doch nur die Zusammenfassung von allem sein :confused: . Wäre super wenn mich da mal jemand aufklären könnte, was man so alles in eine „Dokumentation“ sonst noch schreibt.

lg

Null

Also bis auf Doku haste alles?

Doku umfasst halt beschreibung wie ihr das Projekt angegangen seid, Beschreibung was ihr wie warum gemacht habt, Klassen beschreiben, Klassendiagramm (UML) öh joa das wars glaub

Falls es Java war:
Java-Docs sollten noch dazu…

@ EagleEye

Klassendiagramm, Tabellenentwurf hört sich schonmal gut an. Fällt dir sonst noch was ein? Hast du irgendwo n Template oder ähnliches wie man beschreibt wie man das Projekt angegangen ist oder was man warum gemacht hat? Kann mir darunter momentan ziemlich wenig vorstellen.

@ Wildcard

Habs in Java geschrieben, war aber keine Pflicht. Glaub aber net dass das dazugehört, da der Lehrer letztes Jahr noch net ma gewusst hat, dass es sowas wie ne API überhaupt gibt :wink:

thx schonmal an euch :slight_smile:

Ne hab ich nicht weil das kann man nicht in ein Template fassen weil das bei jedem Projekt anders ist.
Du beschreibst da einfach die Schritte auf wie du das Projekt gemacht hast.

Hm … okay. Werds mal versuchen. Danke!

[QUOTE=Null]
@ Wildcard

Habs in Java geschrieben, war aber keine Pflicht. Glaub aber net dass das dazugehört, da der Lehrer letztes Jahr noch net ma gewusst hat, dass es sowas wie ne API überhaupt gibt :wink:

thx schonmal an euch :)[/QUOTE]
Java-Docs gehören in Java nunmal zur Standard Doku.
Sieh’s so, du hast keine extra Arbeit da diese automatisch erstellt werden und es macht trotzdem echt was her… :wink:

Dazu müsst ich aber erstma mein Code dokumentieren. War extrem unter Zeitdruck und hatte dafür keine Zeit :smiley: :wink:

Und jetzt, wo alles funktioniert hab ich keine Lust mehr knapp 40 Klassen mit durchschnittlich 300 Zeilen Code zu dokumentieren ::banana

Wenn du es für eine gute Idee hälst undokumentierten Code abzugeben… :stuck_out_tongue:

Das is Berufsschule bei nem Lehrer der keine Peilung von nix hat. Der will den Code noch net ma. Der will die ganzen Dokumente und mitn Programm rumspielen … :smiley: :stuck_out_tongue_winking_eye: