Inhalt /Gestaltung DoKu

[Ivy_125]

Hallo,

ich habe versucht, mir durch zahlreiche Dokumentationen und Muster, die ich im Internet gefunden habe, ein Bild davon zu machen, was jetzt alles in eine Dokumentation reingehört.

Nur ist da kein wirklich einheitliches Bild rausgekommen...

Es sind vor allem 2 verschiedene 'Stile' aufgetaucht:

Bei dem ersten sind die Dokumentationen ähnlich wie in Betrieben üblich gestaltet, sprich: Projektplanung (Ziele, Dauer...), Ist-Analyse, Soll-Konzept, Realisierung (Umsetzung) usw.

Bei dem zweiten haben die Auszubildenden mehr einen Projektbericht in der Form "An Tag sowiso habe ich das und das gemacht..." geschrieben. (Am Anfang noch Projektauftrag. Andere Dokumente waren da ehr Anhang.)

Kann mir irgendwer sagen, was richtig / besser ist?

Grüße

Ivy

[bimei]

Original geschrieben von Ivy_125

Kann mir irgendwer sagen, was richtig / besser ist?

Aus der Berufsverordnung:

Durch die Projektarbeit und deren Dokumentation soll der Prüfling belegen, dass er Arbeitsabläufe und Teilaufgaben zielorientiert unter Beachtung wirtschaftlicher, technischer, organisatorischer und zeitlicher Vorgaben selbständig planen und kundengerecht umsetzen sowie Dokumentationen kundengerecht anfertigen, zusammenstellen und modifizieren kann.

Das dürfte wohl weiterhelfen, oder?

bimei

[P3AC3MAK3R]

In Prinzip ist wohl eine Kombination aus beidem richtig. Laut unserer BS-Lehrer wird dem Projektbericht bzw. -tagebuch jedenfalls eine recht hohe Bedeutung beigemessen.

[HangManAtWork]

Ich habe einen genialen Ausbilder...:bimei

Ich darf zu meinem Abschlussprojekt einen Dokuhead prduzieren, einfach nur Wahnsinn...

Vision

Lastenheft

Projektplan

Entwicklungsplan

Statusberichte

Prüfspezifikation

Prüfprotokoll

und zu guter letzt noch ein Dokument aus dem hervorgeht wie ich die Arbeit erledigt habe.

Nicht zu vergessen, der Quellcode MUSS genau dokumentiert sein, heisst soviel wie 1 Zeile Quellcode = 2 Zeilen Doku

:OD

Aber dafür kann ich mir eigentlich sicher sein für das Projekt und die Doku ne 1 zu kriegen :D

HangMan

[P3AC3MAK3R]

Nicht zu vergessen, der Quellcode MUSS genau dokumentiert sein, heisst soviel wie 1 Zeile Quellcode

Also ich für meinen Teil habe mich bereits das gewöhnt das eh jedes Mal zu machen (z. B. auch, wenn ich nur was für mich programmiere)... ist alles eine Sache der Gewohnheit und man findet auch noch durch, wenn man nach einer längeren Zeit mal wieder in die Sourcen schaut.

[Uncle Reaper]

Wichtig ist, daß die Doku die vorgeschriebene Seitenanzahl (10 - 15 Seiten) nicht übersteigt (Anhang/Anhänge ausgeschlossen). Deswegen hab ich mich dazu entschlossen ein Projekttagebuch abzugeben und die anderen im Laufe des Projekts angefertigten Dokumente (Fach- und DV-Konzept, Testkonzept und -dokumentation, Abnahmebericht) in den Anhang zu packen (da der Anhang ja beliebig groß sein kann).

So long,

Uncle Reaper

[Ivy_125]

Original geschrieben von bimei

Aus der Berufsverordnung:

Durch die Projektarbeit und deren Dokumentation soll der Prüfling belegen, dass er Arbeitsabläufe und Teilaufgaben zielorientiert unter Beachtung wirtschaftlicher, technischer, organisatorischer und zeitlicher Vorgaben selbständig planen und kundengerecht umsetzen sowie Dokumentationen kundengerecht anfertigen, zusammenstellen und modifizieren kann.

Das dürfte wohl weiterhelfen, oder?

bimei

Das Problem ist, dass das auf beide Varianten zutreffen kann.

Was ich jetzt noch zum Thema gefunden habe:

Auszug aus ‚IHK-Vorschriften zur Abschlussprüfung‘:

„Inhalt einer Dokumentation:

- Prozessorientierter Projektbericht

- Ggf. Praxisübliche Dokumentation für den Betrieb (Anlagen)

Praxisübliche Dokumentation für den Kunden (Anlagen)“

Und in der Erläuterung im Projektantrag der IHK-Köln:

„Zur Dokumentation der Projektarbeit zählen:

a) als Kernstück der Prozessorientierte Projektbericht

Angaben zu kunden- und unternehmensbezogenen Dokumenten/Unterlagen, die sich später in der Anlage zum Projektbericht befinden.“

Das würde die These unterstützen, dass man als Doku an sich wirklich den Projektbericht abgibt und den Rest in den Anhang setzt, oder??? :confused:

Grüße

Ivy

[Jestertales]

Original geschrieben von Ivy_125

Das würde die These unterstützen, dass man als Doku an sich wirklich den Projektbericht abgibt und den Rest in den Anhang setzt, oder??? :confused:

In den prozessorientierten Projektbericht gehören die ganzen Prozesse rein, die Du bei der Durchführung Deines Projektes durchlaufen hast.

Beschreibe einfach, was innerhalb der einzelnen Phasen Deines Projektes gelaufen ist und welche Mittel Du eingesetzt hast und wieso.

Schreib bloß nichts in dem Tagebuchstil... "An Tag X habe ich die Taste gedrückt und dann diese." Der genaue Tag interessiert den Kunden doch wirklich nicht.

Was für einen Beruf hast Du denn?

[Ivy_125]

Original geschrieben von Jestertales

Was für einen Beruf hast Du denn?

FI/AE...

Mit folgender Dokumentation (nur grober Inhalt) sollte es doch passen, oder? Prozessorientiert ist die Doku damit auf jedenfall (denke ich)...

- kurze Beschreibung des Auftrags

- Grobkonzept (Ist- / Soll-Analyse)

- DV-Konzept (Programmentwurf)

- Umsetzung/Realisierung

- QS / Test

- Implementierung

- Probleme / Fazit

- Projektverlauf (Zeitplanung)

Anhang:

- Pflichtenheft

- Datenmodell

- Benutzerhandbuch

[timmi-bonn]

[...]

- QS / Test

- Implementierung

- Probleme / Fazit

- Projektverlauf (Zeitplanung)

[...]

Was habt ihr eigentlich alle gegen den Punkt "Abnahme / Übergabe"?!? Wird der wirklich auf der Schule nicht gelehrt?

gruß, timmi (verwirrt)

[CSharp]

Hallo,

nein, der wird in den Berufsschulen - zumindest in meiner ehemaligen - höchstens mal kurz angeschnitten, und ich war bis auf ingesamt 3 Fehltage in meinen kompletten 3 Jahren immer da. Das Ganze kommt viel zu kurz, zumindestens in der theoretischen Ausbildung. Im Betrieb ist das was anderes...

gruß

cSharp

[timmi-bonn]

[...] nein, der wird in den Berufsschulen - zumindest in meiner ehemaligen - höchstens mal kurz angeschnitten, [...] Das Ganze kommt viel zu kurz, zumindestens in der theoretischen Ausbildung. Im Betrieb ist das was anderes...

traurich, traurich, traurich..., um es mit Theo Lingen zu näseln.

Nein, im Ernst, es ist für den PA, der ja zu mindestens 2/3 aus Personen "aus den Betrieben" besteht, schon ziemlich frustrierend, so'was hören zu müssen.

Ähnlich peinlich fand ich es, während einer Prüfung von einem der anwesenden Lehrer hören zu dürfen, daß das von mir hinterfragte "Testkonzept" gar nicht im Lehrplan zu finden sei. Zumindest das ist hier umgehend (und unbürokratisch!) korrigiert worden.

Die Schulen leisten wirklich eine überwiegend gute Ausbildung. Aber leider hapert's immer wieder mal an Grundsätzlichem. Wie konnten nur die Praxis in den Betrieben und das Schulangebot in einigen Fällen so weit auseinander driften?!?

Ich bin ja mal gespannt, wie sich das in den nächsten Jahren alles so entwickeln wird, wenn das Projektmanagement, zumindest in den großen Städten mit internationalen Konzernen, immer mehr in den Mittelpunkt rücken wird.

gruß, timmi

[gajUli]

In D gibt es das duale System. Es hat Vorteile und Nachteile, ganz allgemein. Ganz speziell bedeutet "dual" nicht, dass der eine Teil die gesamten Vorteile hat, der andere aber die ganzen Pflichten und erst recht nicht, dass der sich Kritik anhoeren soll, wenn er auch noch Pflichten, die er gar nicht hat, zugschoben bekommt...

Das Pruefungsprojekt ist eine rein betriebliche Projektarbeit. Die Vorbereitung auf diesen Pruefungsteil und auch die Durchfuehrung faellt also primaer in die betriebliche Ausbildung.

Themen wie Uebergabe haben mit dem Schulstoff nur im Grundsaetzlichen tun. Kommt in WG als Teil des Projektmanagements dran und das darf es dann auch gerne gewesen sein.

Trotzdem werden in der Schule Praesentationen geuebt und Inhalte nachgearbeitet, die die Betriebe verschludern. Die Lehrer, zumindest an meiner Schule, kennen auch das Pruefungsgeschaeft insgesamt besser als die meisten Betriebe. Das geht so weit, dass uns Betriebe oft nicht einmal sagen koennen, ob wir ein Thema behandeln sollen oder nicht, selbst dann nicht, wenn sie sie einladen oder schriftlich befragen.

Nicht wenige Azubis kommen dann mit ihren Problemen zu uns, weil sie in ihren Betrieben keine Hilfe erfahren. Das sollen sie auch gerne duerfen; wir helfen gerne. Aber lasst uns bitte mit schwarzen Petern in Ruhe, die ihr zu Anfang des Spiels bekommen habt und nicht losgeworden seid.

Das ist sonst naemlich wieder nur Alibigelaber und mit dem Finger auf die anderen zeigen.

[timmi-bonn]

Original geschrieben von gajUli

[...] Trotzdem werden in der Schule Praesentationen geuebt und Inhalte nachgearbeitet, die die Betriebe verschludern. Die Lehrer, zumindest an meiner Schule, kennen auch das Pruefungsgeschaeft insgesamt besser als die meisten Betriebe. Das geht so weit, dass uns Betriebe oft nicht einmal sagen koennen, ob wir ein Thema behandeln sollen oder nicht, selbst dann nicht, wenn sie sie einladen oder schriftlich befragen. [...]

Hi Uli,

ja, das deckt sich auch durchaus mit meinen Beobachtungen. Unter'm Strich kann man schon sagen, daß "die Lehrer" wesentlich interessierter und aktiver bemüht sind, die Abstimmungs-Defizite zwischen Schulen und Betrieben aufzuarbeiten.

Einen "Schwarzen Peter" wollte ich keiner von beiden Gruppen zuschieben. Das Problem will mir im "Dualismus" an sich liegen. Beide Ausbildungsstränge sind zwar definiert. Aber es wurde offensichtlich vergessen, ein Kontroll- und Koordinationsgremium einzurichten.

Duale Ausbildung ist 'was tolles, solange die Abstimmung zwischen Schulen und Betrieben funktioniert. Und da ist momentan, zumindest hier, Sand im Getriebe.

gruß, timmi

[gajUli]

Ja genau. Speziell bei den IT-Berufen laesst sich auch nicht so einfach eine sinnvolle Einteilung festlegen.

Bei uns ist irgendwann mal ein hohes Tier auf die Idee gekommen, einen "IT-Beirat" zu gruenden. Den gibt es jetzt auch, mit Satzung und Eintrag ins Vereinsregister beim Amtsgericht. Das ist dann schon eine ganz manierliche Plattform fuer Koordinationsvorhaben. Aber auch hier wieder die Krux: Vielleicht 10 Prozent der Ausbildungsbetriebe engagieren sich; den anderen scheint es egal zu sein.

Aber vielleicht waere das dennoch eine Moeglichkeit fuer Euch.

[CrabblerAttack]

Hallo!

Mir selbst haben eine Reihe unterschiedlicher Beispiellösungen für gute bzw. sehr gute Projektarbeiten bei der Erstellung meiner eigenen geholfen.

Daher möchte ich nun meine Projektarbeit zum Download über meine Homepage anbieten (verfügbar ab 31. 7. 2002).

Meine Projektarbeit wurde als beste im Einzugsbereich der IHK Lübeck mit 98% (1+) bewertet.

Auf meiner Homepage wird der Download im Bereich Developments (blauer Bereich) zu finden sein. Ich hoffe, ich kann damit dem "Fachinformatiker-Nachwuchs" ein bißchen helfen.

http://kim.burseg.net

[timmi-bonn]

Original geschrieben von CrabblerAttack

[...]Auf meiner Homepage wird der Download im Bereich Developments (blauer Bereich) zu finden sein. Ich hoffe, ich kann damit dem "Fachinformatiker-Nachwuchs" ein bißchen helfen.

http://kim.burseg.net

tjä, hübsch ... :confused: aaaaber leider hinter einer Firewall nicht aufrufbar. Vielleicht solltest Du zusätzlich zu dem Flash-Intro noch einen flash-losen Eingang anbieten?!?

gruß, timmi (in der Sackgasse)

[CrabblerAttack]

Okay, kann ja sein, dass Du genau so einen verrückten Admin hast, der meint die Weisheit mit Löffeln gefressen zu haben, aber mal im Ernst, auf meiner Homepage ist "technisch" eigentlich nichts Anspruchvolles, lediglich das Design, und wenn das die betriebliche Firewall nicht durchläßt, ist sie in meinen Augen zu "vorsichtig" eingestellt.

Und wie gesagt, die Projektarbeit steht erst HEUTE ABEND zum Download bereit.

Ansonsten einfach von daheim runterladen.

http://kim.burseg.net

PS: Welches Flashintro? Ich hab doch gar keins

[timmi-bonn]

Original geschrieben von CrabblerAttack

Okay, kann ja sein, dass Du genau so einen verrückten Admin hast, der meint die Weisheit mit Löffeln gefressen zu haben, aber mal im Ernst, auf meiner Homepage ist "technisch" eigentlich nichts Anspruchvolles, lediglich das Design, und wenn das die betriebliche Firewall nicht durchläßt, ist sie in meinen Augen zu "vorsichtig" eingestellt. [...]

Könnte es vielleicht sein, daß "mein verrückter Admin" eine andere Auffassung vom Sinn und Zweck einer Firewall hat als Du? Eine Firewall, die sensible Kundendaten schützt, kann gar nicht vorsichtig genug eingestellt sein.

...Laß mich mal raten: Firewall- oder DMZ-Konzept hieß Deine Projekt-Arbeit nicht?!? ;)

gruß, timmi

[CrabblerAttack]

Um Gottes Willen, nein!

Übrigens hat meine (bald Ex-)Firma rund 150000 Kundendatensätze zu schützen, und ich denke, dass das reicht ) Unsere Firewall ist schon nervig kleinlich eingestellt, so dass sich unsere 2 MBit-Standleitung wie ne 56K Modemverbindung "anfühlt". Aber gut, diese Daten liegen auf einer AS/400, und da soll man wohl so gut wie gar nicht raufkommen... hab von dem Teil keine Ahnung.

Meine Projektarbeit ist eine ganz simple, praktische Aufgabe aus unserem betrieblichen Alltag, nichts womit man "angeben" könnte. Problemstellungen dabei waren der Einsatz von ADO und SQL mit Delphi und die Analyse von Datendateien im übertragenen ASCII-Format von der besagten AS/400.

[timmi-bonn]

Original geschrieben von CrabblerAttack

[...]

Übrigens hat meine (bald Ex-)Firma rund 150000 Kundendatensätze zu schützen, und ich denke, dass das reicht )

Ich arbeite hinter einer DMZ der Deutschen Bank ...und ich bin wahrscheinlich so ca. 25-30 Jahre älter als Du. Ich denke, das erklärt auch unsere unterschiedlichen Auffassungen vom notwendigen Wirkungsgrad einer Firewall, gelle?

Aber trotzdem solltest Du mal über einen (zusätzlichen) direkten Zugang zu Deiner Homepage, ohne jeglichen "Schnickschnack" nachdenken. Das ist immerhin eine Art Visitenkarte bei einem IT-ler.

gruß, timmi

[CrabblerAttack]

Meine Visitenkarte... hmm... nicht wirklich... also ich würde sagen, das ist mein Playground, sowa für verspielte Webdesigner! Das Aushängeschild ist viel eher, dass ich AOL und NN nicht leiden kann, und die Homepage die Browser nicht gerade fördert. Bevor ich eine "normale" Site eröffne, sollte ich wohl erst die Unterstützung für die anderen Browser sicherstellen ;-)

Übrigens bin ich 23, bin Fachinformatiker AE und jetzt Student für Medieninformatik an der FH Flensburg. Damit können Sie Ihre Alterskalkulation genau durchführen :-p

[CrabblerAttack]

Übrigens ist der Download jetzt auf der Frontpage gelinkt, damit niemand suchen muß ) Also können auch Sie die Doku haben :-)

[Jaraz]

Original geschrieben von CrabblerAttack

Meine Visitenkarte... hmm... nicht wirklich... also ich würde sagen, das ist mein Playground, sowa für verspielte Webdesigner!

Besser hätte mans nicht ausdrücken können.

Wenn du allerdings möchtest, das die Surfer etwas länger auf deiner Seite verweilen, solltest du eine etwas konvertionellere Navigation wählen. Also ich hatte nach 30-45 Sekunden keinen Bock mehr auf "Dalli Klick" oder "such den Link".

Grafisch sieht das ganze aber gut aus. Auch wenn sich das Fenster bei ner großen Auflösung etwas verloren vorkommt.

Gruß Jaraz

[CrabblerAttack]

Also, wer sich ein bißchen in dieser "Webdesigner-Playground-Verspielte-Jugendliche-Camgirls-weißdergeierwas-Szene" auskennt, der hat schon viiieeel kompliziertere Navigationen erlebt ))

Hab doch sogar ne Hilfe ;-)

Aber ist das jetzt hier ein Forum über Abschlußprüfungen oder für Diskussionen um Webdesign, dass es jedem recht macht? Das habe ich nämlich nicht vor. Es ist zum Austoben gedacht, mehr nicht. Ordentliches Design kann ich schließlich immer noch gewerblich entwerfen :marine