Dokumentation - Anhang wie lang?

[Venda]

Hallo!

Habe meine Dokumentation soweit fertig. Es gibt keine Beschränkungen bzgl. Anhang bei uns (IHK Bielefeld), aber ein "aufgeblähter Anhang führt zu einer Beeinträchtigung der Note"...

Die IHK hat mich gebeten, den Quelltext mitzuschicken (ist ein Handy-Spiel), und dazu hab ich ein paar Seiten Erläuterung (was machen die Klassen, was sind die Mutterklassen, Interfaces, Methoden etc.) geschrieben.

Ohne Quelltext + Erläuterung ist die Doku 30 Seiten lang. Der Quelltext ist 18 Seiten lang, die Erläuterungen ca. 10. Das macht dann schon fast 60 Seiten, und das ist ganz schön viel, oder?

Also lass ich die Erläuterungen weg? Aber die finde ich wichtig zum Verständnis des Spiels!

Wie viele Seiten Anhang hattet ihr denn so? Bin ganz verunsichert...

Viele Grüße jedenfalls! Venda

[Sariel]

Hi Venda,

die reine Dokumentation sollte in der Regel 10 Seiten sein, manchmal auch 12 - aber wie lang dein Anhang ist spielt afaik keine Rolle.

Siehe dazu -> http://www.caesborn.de/pruefungspage/projekt_dok.html

[Tinsel]

nicht unbedingt bei uns ist der anhang auf 30 Seiten begrenzt. wie immer frag deine IHK oder schau auf deren HP

[matthias_nordwig]

Quellcode nur Auszugsweise zum untermauern der Funktionalitäten. Auf keinen Fall den gesamten Quellcode! Selbiges gilt für andere Dokumente!

Die sollen dein Spiel net nachprogrammieren können, sondern nur verstehen was du gemacht hast und wie du es gemacht hast!

[ExAzubi]

Also ich bin fertig, hatte etwas über 50 Seiten, und habe "trotzdem" dafür 100 Pkt bekommen.

Also ein Anhang wenn er Sinnvoll ist gibt auch bei 70 Seiten keinen Punktabzug.

[matthias_nordwig]

Jo, kann schon sein das. Dummerweise gibt es mehr als einen Korrektor, oder sehe ich das falsch? Ich bin ja selbst noch bei 50 Seiten, weis aber net mehr was ich da noch rausnehmen soll. Nur packe ich halt nicht den gesamten Quellcode rein.

[timmi-bonn]

Also ein Anhang wenn er Sinnvoll ist gibt auch bei 70 Seiten keinen Punktabzug.

Dann freue Dich! Ich kenne Prüfer, die eine solch dicke Doku nicht einmal lesen - sondern direkt mit 6 bewerten. Das ist halt alles eine Frage der Vorgaben der örtlichen IHK.

Darum fände ich es ja auch so hilfreich, wenn hier jeder "seine" IHK im Profil vermerken würde. Das würde viele Nachfragen und auch Missverständnisse vermeiden helfen.

gruss, timmi