Doku-Länge: 20 Seiten Doku inkl. Anhang??

[E=mc²]

Hi,

in meinem Schreiben von der IHK steht: "Länge der Dokumentation sollte 20 Seiten nicht überschreiben (Doku + Anhang)"

(das "sollte" ist wirklich so unterstrichen u. fett )

Ich habe ein Pflichtenheft erstellt im Rahmen meines Projektes (ca 7h Aufwand), Thema ist aber eine Anwendung, die ich programmiert habe.

Nun frag ich mich, wie soll ich mein 16 Seiten langes Pflichtenheft da mit rein bringen? Gut einige Seiten sind halb leer, aber trotzdem?

Ist das noch mal ein Extra Anhang, unabhängig von den 20 Seiten oder hab ich ein Problem u. hab das Pflichtenheft eigentlich umsonst gemacht?

Oder kann ich jetzt her gehen u. aus meinem sauberen Pflichtenheft schon meine halbe Doku zusammenpasten?

Wäre dankbar für kompetente Kommentare!

[Karl Nickel]

In der Regel ist der Anhang exklusiv von der vorgeschriebenen Seitenzahl. Bei uns heißt es zum Beispiel, dass die Dokumentation 10-15 Seiten umfassen und der Anhang nicht zu aufgebläht werden soll. Ich kann mir nicht vorstellen, dass das bei deiner IHK anders sein sollte. Aber im Zweifelsfall würde ich an deiner Stelle bei deiner IHK anrufen in die nochmal fragen - sicher ist sicher...

[E=mc²]

Ok, schon mal beruhigend zu hören.

Weist du auch was nicht zu aufgebläht ist?

Meine 16 Seiten Pflichtenheft + erstellte Diagramme ca 20 Seiten.

Gebt ihr auch Source-Code mit ab? Mein gesamter Code wären ca 2000 Zeilen ohne den vom Form-Designer generierten code, glaub das wäre schon zu viel u. sowieso nicht sonderlich spannend da man sich erstmal einlesen müsste.

Vielleicht Code von einer ausgwählten Klasse zugeben?

[Karl Nickel]

Naja, solange der Source-Code dokumentarisch nichts bringt, musst du ihn nicht abgegeben. Die IHK interessiert nicht ein fertiges Programm, sondern das Projekt. Zuviel Source-Code würde wahrscheinlich unter "aufgeblähter Anhang" fallen. Ich zum Beispiel habe ca. 800 Zeilen Source-Code (eine einzelne Klasse) zu dokumentarischen Zwecken sowie einen 2-seitigen SQL-Export im Anhang. Bin aber am überlegen, ob ich das nicht rauswerfen soll, denn mit beiden Sachen kann der PA nicht viel anfangen. BTW mein Anhang besteht aus ca. 30 Seiten. Die Doku aus ca. 15 Seiten...

[SoL_Psycho]

Habe in meinem Anhang 3 Sourcecodebeispiele. Einmal, um zu verdeutlichen, wie das dynamische Menu aufgebaut ist (kann man sich ohne Code oder Darstellung immer schlecht vorstellen ), dann den automatischen Emailversand der Applikation (Ich will im Fachgespräch fragen zu SMTP!!! ) und noch den Login, an dem ich parametrisierte SQL Statements klar mache, weil ich die vorher erkläre (auch SQL Injections, ja), aber da Quelltext sicher nicht schadet zum genaueren Verständnis...

Also ich würde Quellcode reinnehmen, wenn er das Verständnis des Textes / eines Aspektes deiner Arbeit erhöht

P.S.: Doku 11 Seiten, Anhang 15 Seiten (10 Seiten Doku waren Maßgabe, Anhang < 20 :upps), dazu noch 1 Deckblatt, 2 Inhaltsverzeichnisse

[Hornez]

Bei uns stand in dem Brief extra drin das wir den Source code mitabgeben sollen....

Hatten aber auch die vorgabe 10 seiten und zuzüglich dem Anhang.

Solang dein source doch läuft gib sie mit ab

[E=mc²]

Auch für jeden Prüfer, also 3 fache Ausführung oder was verlangt ist, oder würdet ihr den code u. andere Anhänge nur einmal ausdrucken u. mitgeben?

[Karl Nickel]

Die gesamte Doku + Anhänge in gewünschter Ausführung drucken. Man kann von den Prüfern schlecht verlangen, dass sie sich die Anhänge teilen

[SoL_Psycho]

Wir schicken sie direkt an zwei von unsern drei Fachprüfern, also teilen ist da nit so