Projektdokumentation - Mittelfranken - Umfang

[xenchen]

Heho,

Da ich momentan dabei bin meine Projektarbeit in eine anschauliche Struktur zu bringen stellt sich mir doch ein erhebliches Platzproblem wenn ich mir die IHK Spezifikation anschaue:

- Länge der Dokumentation "sollte" 20 Seiten nicht überschreiten (Doku und Anhang)

Mein fertiger Quellcode incl. Inline Doku umfasst schonmal ca. 1500 Zeilen Code, das ich diesen nicht komplett unterbring ist mir auch klar, ich habe mich nun für repräsentative Ausschnitte entschieden um mich so auf 3 (max. 4) Seiten zu reduzieren.

Jedoch ändert das noch nichts am Problem das ich diese 20 Seiten (Doku und Anhang) kaum einhalten kann ohne dabei einige Einschnitte in Kauf nehmen zu müssen.

Alleine der Quellcode, Vorstellung der Firma, Testdoku, Zeit und Aufgabenübersicht und das Glossar nehmen ja schon an die 10 Seiten Platz weg.

Irgendwo würde ich aber natürlich auch gerne ein bischen IST/SOLL Analyse, Design und Struktogramme unterbringen

Hat hier jemand aus dem Gebiet mittelfranken weitere Informationen was die IHK mit "sollte nicht über 20 Seiten sein" genau meint und wieviel man das ganze ggf. überschreiten kann ohne Auswirkungen?

Danke

[crypto]

Tja, das ist in der Tat to much!

Unbedingt an die ungefähren Vorgaben halten, alles andere kann u.U. negativ ausfallen. Ggf. hätte ein nicht so umfangreiches Projekt gewählt werden können, so sagte ein Prüfer im letzten Jahr, als er 46 Seiten Doku auf den Tisch bekam zu einem Vorgänger von uns.

Etwas mehr oder weniger sollte aber kein Problem sein denke ich.

Wie sieht denn das allgemein mit Quellcode in der Doku aus?

Uns wurd gesagt:"nur wenn unabdingbar nötig und der Dokumentation zuträglich", schl. dokumentiert ihr euren Code ja schon in den Sourcen.

[xenchen]

Also entgegen dem was mir bisher von vielen Seiten gesagt wurde ist es schonmal nicht nötig den kompletten Code abzuliefern.

Ich halte mich hierbei an die Vorgaben der IHK:

"Als Anhang gelten alle ergänzenden Unterlagen, die zur Dokumentation des Projektes gehören. z.B. betriebliche Dokumentation, wie Kopien von Ausschreibungen, Formularen, Angeboten, Serverparameter, Berechtigungen (Kennungen), Auszüge aus Quellcode."

Da übrigens ein Punkt darunter "Glossar" als extra Punkt steht schließe ich daraus das das Glossar genau wie die Deckseite nicht zu den 20 Seiten Doku/Anhang gehören.

Ich für meinen Teil werde also Programmcode in meinen Anhang packen, ihn aber wirklich nur auf wenige interessante Dinge eingrenzen. (Geht bei mir sehr gut).

Wirklich relevant ist es jedoch nicht.

[darkworld]

Quellcode in den Anhang, Testprotokoll in den Anhang. Die Doku ist "prozessorientiert" braucht also nichts derartiges zu erhalten. Was, warum und wie du getestet hast musst du erklären, aber das Protokoll in den anhang, genauso die Übergabe, wies ablief in die Doku, das Protokoll in den Anhang...

[timmi-bonn]

Also entgegen dem was mir bisher von vielen Seiten gesagt wurde ist es schonmal nicht nötig [...]

Ich halte mich hierbei an die Vorgaben der IHK:

Und was lernen wir daraus: Es wäre hilfreich gewesen, den Wohnort (die zuständige IHK) im persönlichen Profil einzutragen. Das hätte vielleicht einige dazu inspiriert, regionale Besonderheiten im Fokus zu behalten. Denn es gibt sie nicht, "die IHK".

gruss, timmi (die Gebetsmühle wieder einpackend)

[xenchen]

Anhand des Topics und meines ersten Posts sollte sich dies von selbst erschließen.

Daher war der Thread wie bereits erwähnt auch nur an mittelfranken gerichtet.

[timmi-bonn]

Anhand des Topics und meines ersten Posts sollte sich dies von selbst erschließen.

Jemandem, der mitten im Thread einsteigt, dem erschliesst sich das aber nicht. Was hast Du gegen einen Eintrag im Profil, der allen anderen längeres Suchen ersparen würde?

gruss, timmi