Welche Teile des Quellcodes erklärt man am besten in der Doku ?

[paLe]

huhu

ich habe als projekt ein seminarverwaltungsprogramm mit php gecodet.

ist-analyse,soll-defi,realisierung der mysql datenbank,abnahme&übergabe, testphase, fazit, vergleich der zeitplanung usw. hab ich schon alles in meiner doku. mein größtes problem ist es die realisierung des programmes selber kompakt zu halten.

bisjetzt hab ich kurz etwas darüber geschrieben das die datenbankverbindung über eine extra datei hergestellt wird welche man über php include einfach in dort einbinden kann wo db zugriff benötigt wird. desweiteren hab ich noch etwas über eine weitere datei geschrieben wo alle wiederkehrenden funktionen drinstehen.

problem ist es das das gesamte programm aus ca. 15 php modulen besteht zum anlegen,löschen, verwalten, auswerten usw. von den kursen.

soll man über alle kurz was schreiben oder sich lieber 2-3 module rauspicken und dort genauer beschreiben mit quellecode beispielen usw. was genau passiert :/ alles ist leider unmgölich da das locker den rahmen der doku sprengt *gg*

wie habt ihr das gelöst ?

mfg

[etreu]

Der Quellcode gehört auf jeden Fall in die Doku mit rein. Bei uns (IHK Berlin), "zumindest relevante Teile des Quelltextes" in den Anhang. Nach meinem Ausbilder alles.

Wie du es in die Doku einbaust, kann ich dir auch nicht sagen.

[Equilibrium24]

Huch, ich hab den Quelltext garnicht mit drin, habe nur die wichtigsten Funktionen in Form von PAPs erläutert.

Ich bin davon ausgegangen, dass ein PAP besser kommt wie der Quelltext.

War das eine Fehleinschätzung von mir?!

[CyberDemon]

War das eine Fehleinschätzung von mir?!

Yupp, würde ich sagen. Dein selbstgeschriebener Code muss mit rein.

[paLe]

Der Quellcode gehört auf jeden Fall in die Doku mit rein. Bei uns (IHK Berlin), "zumindest relevante Teile des Quelltextes" in den Anhang. Nach meinem Ausbilder alles.

Wie du es in die Doku einbaust, kann ich dir auch nicht sagen.

hmm also ich hab jetzt mal 3 wichtige teile des codes bzw. 3 module rausgesucht auf welche ich näher eingehe.

wenn den kompletten quellecode jeder html seite in den anhang haue sind das ca 25-30 seiten mehr anhang :/ was ich nicht toll finde

mfg

[Equilibrium24]

Hmm...

Was kann da jetzt auf mich zu kommen?

Soll ich in der Präsentation was dazu sagen?

Ich bin, wie gesagt, davon ausgegangen, dass ein für jeden verständlicher PAP besser ist wie ein "kryptischer" Quellcode.

:-(

[etreu]

wenn den kompletten quellecode jeder html seite in den anhang haue sind das ca 25-30 seiten mehr anhang :/ was ich nicht toll finde

mfg

bei mit waren es ca. 25 - 30 Klassen (PHP) -> 90 Seiten

+ Templates und sql-Skript

[soccer1981]

Hallo,

ich habe mein 40 Seiten Quellcode in den Anhang gepackt als letzten Punkt. In der Doku selber habe ich meine Klasse beschrieben. Allerdings hat sich das bei mir in Grenzen gehalten. Ich würde mir in deinem Falle vermutlich die Hauptmodule raussuchen und beschreiben. Ind den Anhang würde ich allerdings den ganzen Quellcode hinein tun.

[Umbratus]

Ich bin, wie gesagt, davon ausgegangen, dass ein für jeden verständlicher PAP besser ist wie ein "kryptischer" Quellcode.

:-(

Seh ich ganz genauso.

Hab damals auch nur wenige Auszüge in Form von Struktogrammen in den Anhang gepackt.

[Antibiotik]

hallo,

Quellcode muss rein?! Wer schreibt dass vor, wo steht das?

Diesen Ausschnitt der Prüfungsordnung will ich sehen!

Du sollst in deiner Doku zeigen wie du in dem Projekt vorgegangen bist und nicht dein Quellcode erklären. Der Anhang ist außerdem keine "Mülleimer" für Sachen, welche ich in der Doku nicht unterbringe.

Soll sich der Prüfer wirklich außer der Doku noch 50+ Seiten anschauen und des von mehreren Prüflingen?

Vorgänger von mir hat nur eine Funktion im Anhang gehabt und über 90% bekommen!

Ich selber hab auch nur eine Funktion im Anhang. In der Präsentation zeig ich Screenshots von meinem Programm und erwähn die Entwicklungsumgebungen, mehr nicht!

Ciao

Antibiotik

[soccer1981]

hallo,

Quellcode muss rein?! Wer schreibt dass vor, wo steht das?

Diesen Ausschnitt der Prüfungsordnung will ich sehen!

Hallo

Ich kann mir vorstellen, dass das wieder von IHK zu IHK unterschiedlich ist. In dem Brief, den ich bekommen habe, steht: "Die Anlagen sollten ebenfalls 10 Seiten nicht überschreiten, davon ausgenommen sind Quellcodes der Fachinformatiker Anwendungsentwicklung, welche zwingend notwendig als Anhang einzureichen sind." (ähnliche Aussage auch hier zu finden)--> Damit, würde ich behaupten, ist es für mich Pflicht den Quellcode im Anhang rein zu packen und für alle anderen, wo das drin steht auch.

Gruß soccer1981

[DerMatze]

Ich selber hab auch nur eine Funktion im Anhang.

dito ... ich habe eine Funktion genommen, sie beschrieben und gut ist. Machte bei mir genau eine A4 Seite aus ...

Es ist hier wahrscheinlich wie sonst ueberall auch ... von IHK zu IHK verschieden.

[Antibiotik]

hallo,

Hallo

Ich kann mir vorstellen, dass das wieder von IHK zu IHK unterschiedlich ist. In dem Brief, den ich bekommen habe, steht: "Die Anlagen sollten ebenfalls 10 Seiten nicht überschreiten, davon ausgenommen sind Quellcodes der Fachinformatiker Anwendungsentwicklung, welche zwingend notwendig als Anhang einzureichen sind." (ähnliche Aussage auch hier zu finden)--> Damit, würde ich behaupten, ist es für mich Pflicht den Quellcode im Anhang rein zu packen und für alle anderen, wo das drin steht auch.

Gruß soccer1981

das bei der IHK Nürnberg dann wohl nicht der Fall.

Ciao

Antibiotik

[raeschnix]

Hi,

also ich kann nur sagen wie ichs gemacht habe. Ich habe einen Hauptprozess in Struktogrammen dargestellt (Systemdoku), diese Struktograme dann 2 Seiten weiter in Quellcode dargestellt.

Den Rest hab ich auf der CD. Natürlich ist in der Doku ein Verweis auf den vollständigen Code auf der beigelegten CD... somit sprengst nicht den Rahmen, und so bekommt die CD erstmals einen Sinn!

Gruss

raeschnix

[STDE]

Ich habe mein Modul in kleiner, aber immer noch gut lesbarer Schriftgröße angehangen, waren aber immer noch 48 Seiten.

In der Handreichung der IHK Aachen steht dass der komplette eigene Quellcode mit rein muss. Die Handreichung der IHK Aachen gibts hier: http://www.aachen.ihk.de/de/ausbildung/download/pb_004.pdf

Darin steht:

[Die Doku soll...] Quelltexte der im Projekt erstellten Programme für das Berufsbild des Fachinforma-tikers Anwendungsentwicklung beinhalten und sind in schriftlicher Form im Anhang beizulegen. Dabei sollten sich die Quelltexte auf die selbst geschriebenen Anwei-sungen und die zum Verständnis dieser Programmteile notwendigen fremderstellten Sourcen beschränken. Neben der schriftlichen Form können Quelltexte auch in einem mit gängigen Editoren lesbaren Format auf CD beigefügt werden.

Da ich einige externe Funktionen und Klassen benutzt habe, habe ich die im Anhang nochmal mit Attributen, Funktionen und Funktionsweise beschrieben.

Zusätzlich habe ich eine Methode aus meiner Klasse in die eigentliche Doku gepackt und diese genauer beschrieben, sonst hätte ich nen 1 MB Quelltext anhängen dürfen und das wäre auch auf CD nicht gerade lustig für den Prüfer geworden der das zu verstehen versucht ;-)

Und dem Exemplar dass ich meinem Projektbetreuer geschickt habe, habe ich den ganzen Kram, PDF der Doku und den Quellcode nochmal auf eine CD draufgepackt.

Gruß,

Christian

[panikpaula]

Hallöle,

also ich habe nur ein paar ausgewählte Quellcodes eingebracht. Wenn es zu wenig ist, kann ich nach der Präsentation ja noch mal darauf eingehen. Aber ich hoffe, es reicht.

[Mataina]

Hallo zusammen,

ich habe in meine Präsentation nur einen kleinen Code-Auszug, der allerdings eine der wichtigsten Funktionen meines Programms darstellt, eingefügt. Wenn Du Dir wirklich nicht sicher bist, wie viel oder wenig Code in die Präsentation soll, dann erstelle doch im Vorlauf ein paar Kopien Deines Codes. Wenn mehr Code von den PAs gefordert ist, kannst Du dann ganz lässig die Zettelchen zücken und austeilen :-)