Quelltext in Dokumentation?

[fridy]

Hallo zusammen,

ich mache gerade eine Ausbildung zum FISI.

Mein Abschlussprojekt beinhaltet die Erstellung eine Webüberwachung einer Anwendung (eine komplexe).

Muss ich in meiner Dokumentation hierzu Quelltextauszüge machen oder reicht es, wenn ich die Arbeitsweise der Scripte dokumentier und eventuell Screenshots der fertigen Überwachung anhänge?

[allesweg]

Das kommt drauf an.

Screenshots sind gut und schön, jedoch kann man diese auch mit [Malprogramm deiner Wahl] "fälschen". Dann kommt es noch auf die Vorlieben der örtlich zuständigen IHK (Wink mit dem Zaunpfahl!) an. Ganz ohne Dokumentation der Funktionsweise gibt es nichts, woran dein fachliches Können bewertet werden kann. Dafür eignen sich PAPs, Stroktogramme und ähnliche Diagramme. Sollte Wichtiges oder Herausragendes erst in den Sourcen als solches erkannt werden können, sollten diese ebenfalls dazu.

Beachte aber immer die formalen Vorgaben deiner IHK!

[fridy]

Naja, prinzipiell schon logisch, aber wie gesagt, ich bin Auszubildender Fachinformatiker für Systemintegration, nicht Anwendungsentwicklung...

Also steht in den Vorgaben der zuständigen IHK (Stuttgart) auch nichts darüber. Struktogramm hab ich keins.

Es handelt sich um die Überwachung von verschiedenen Teilen der Anwendung (Prozesse, Storage, Betriebssystem Cluster, Logfiles). Alles ist in Perl realisiert und wird über CGI als HTML Code ausgegeben

[Wurstwasser]

was ist gegen gut kommentierten quellcode im anhang einzuwenden?

[eddy8472]

das ich damit gezwungen werde ein unspektakuläres projekt abzulieferen weil ich sonst angst um codeklau haben muss?

..bin gerade auch genau an der frage, abschlussprojekt fiae, .. mein chef meint das man den quellcode komplett abliefern muss, unter umständen sogar in digitaler form aber er ist sich nich sicher

wo find ich das denn bei meiner zuständigen ihk (stgt)? ... die seite is so bescheiden, ich find da gar nix

[Grandmasta]

Kennst du diese Dinger mit dem Hörer und Zahlenfeld? Wieso rufst du nicht einfach an, anstatt ewig im Internet zu suchen? Irgendwie scheint dieses Phänomen gerade bei Informatikern besonders verbreitet zu sein...

[carmann]

Also uns wurde ewig eingepredigt, dass wir die "zu-technischen" Teile nicht direkt in die Doku mit reinnehmen sollten.

Alternativ könnte man jedoch den Quelltext in den Anhang packen. Das sollte soweit ich weiß keine Probleme darstellen.

[allesweg]

das ich damit gezwungen werde ein unspektakuläres projekt abzulieferen weil ich sonst angst um codeklau haben muss?

Wie kann man etwas gestohlen bekommen, was einem nicht gehört? Arbeitsergebnisse gehören dem Arbeitgeber.

[eddy8472]

anrufen? .. mit eigener stimme?? kenn ich nich ..

..und meiner firma kanns durchaus gestohlen werden

[TDM]

Neuen Thread wollt ich nicht erst aufmachen, deswegen frag ich hier gleich:

Ich habe die Aufgabe ein MFC-Programm zu schreiben. Ich habe meine Doku nun soweit fertig. UML-Diagramm ist auch mit drin. Sollte ich den Quelltext auch mit einfügen oder nicht ? Bei einer Win32-Anwendung würd ichs evtl. machen, aber bei MFC sind durch die Dialoge schon sehr viele Klassen entstanden. Daher wäre es meines Erachtens selbst für den Anhang zu viel, aber ich würde lieber sicher gehen.

[Akku]

Ich habe zur Zeit 8 Dokus hier vor mir. In den nächsten Tagen folgen noch 4 weitere. Wenn ich mir nun vorstelle, dass im Anhang jeder Doku 60 Seiten Code enthalten wären und diesen lesen müsste, hätte ich ein Problem.

Das Du programmieren kannst, können wir uns im PA schon denken, sonst hättest Du ja die Ausbildung ja nicht durchlaufen. Wir fragen uns jedoch ob Du in der Lage bist mehr oder weniger komplexe Projekte von der Planung, des Designs, der Implementierung, dem Test und dem Schreiben der zugehörigen Dokumente zu erstellen und diese Abläufe und Entscheidungen dokumentarissch festzuhalten.

Des Weiteren ist so eine Doku mit 80 Seiten Anhang ganz schön schwer. Falls Deine Dir zuständigen IHK keine weiteren Vorgaben diesbezüglich hat, reicht es wenn Du die ein oder andere wichtige Klasse als Code in den Anhang packst. Dort schauen wir dann schon mal hin, um beurteilen zu können, wie gut jemand seinen Code programmiert und kommentiert hat.

[Der Kleine]

Das Du programmieren kannst, können wir uns im PA schon denken, sonst hättest Du ja die Ausbildung ja nicht durchlaufen.

Man hast du aber ein Vertrauen?

Einige gescheite Ausschnitte, welche die Programmierkenntnisse zeigen, könnten ausreichen. Natürlich will ich sofort wissen, an welcher Stelle im Quelltext du was ändern musst, um die eine Farbe dort im Layout von Grün auf rot zu stellen. Aber das kommt erst im Fachgespräch.

[Akku]

Natürlich will ich sofort wissen, an welcher Stelle im Quelltext du was ändern musst, um die eine Farbe dort im Layout von Grün auf rot zu stellen. Aber das kommt erst im Fachgespräch.

Das Du aber auch alles verraten mußt. Tz Tz.