Ausbildungsprojekt - Dokumentation

[Dey]

Hi.

Da ich so langsam am Ende meiner Ausbildung bin, schreibe ich zurzeit meine Doku zu meinem Projekt.

Ich habe eine Schnittstelle von Java nach .NET migriert und dabei einige Anpassungen gemacht.

Mein Problem ist, dass ich keinen Inhalt für die Doku habe. Bisher habe ich sehr spezifische Themen übers Software-Engineering in die Doku eingebracht.

Die Punkte Ist-Analyse und Sollzustand habe ich bereits und ich befinde jetzt an der Umsetzung. Meine Frage ist, ob sich hierfür eher eine Klassenbeschreibung eignet oder der Programmablauf linear erklärt werden soll.

Wie gesagt ist es nur eine Schnittstelle, die aus paar Klassen besteht und Funktionen zum Öffnen einer Verbindung und Senden und Empfangen von Nachrichten bereitstellt.

Was denkt ihr?

 

[TnTDynamite]

Naja, auf jeden Fall besteht die Umsetzung eines Projektes nicht nur aus Programm-Code oder was auch immer, sondern z.B. auch aus Besprechungen mit Kollegen, Vorgesetzten, User, etc.
"Bei der Umsetzung war auf folgende Schwierigkeiten/Besonderheiten zu achten:"..."die wesentlichen Unterschiede bei der Umsetzung in .NET gegenüber JAVA sind..."
Wenn auf diese Art nicht genug zusammen kommt, war das Projekt vielleicht wirklich nicht umfangreich genug und man man noch was "dazu erfinden".

 

[warducK]

Ich gehe ja mal davon aus dass es sich um eine Ausbildung zum Fachinformatiker handelt.

Schau dir mal folgendes Dokument an: IHK Handreichung
Das ist ein Dokument von der IHK Saarland welches als Handreichung zu den Prüfungen angeboten wird. Darin findest du auch einen Abschnitt über die Dokumentation deines Projekts und wie/was dort bewertet wird. Ich hab das damals mehr oder weniger als Leitfaden für meine Doku genommen, weil ich da zumindest gesehen hab was alles verlangt wird.

Kannst dirs ja mal anschauen. Schaden wirds mit Sicherheit nicht.

Gruß,
warducK

 

[ryan_blackdrago]

Würde sogar eher beides reinbringen; da es nachvollziehbarer wird, wie die Klassen aufgebaut sind + wie das Programm ablaufen soll. 'Ausschließlich' Diagramme usw. sollten eher bei der Projektvorführung benutzt werden.

Bei meiner FiSi-Ausbildung damals (sollte bei FiAe?! nicht anders sein?!):

1. Einleitung:
1.1 Das Unternehmen : Unternehmen kurz vorgestellt
1.2 Datenschutzvermerk : Namen, IP-Adressen usw. wurden unkenntlich gemacht blah blah
1.3 Hintergrund und Einsatz : Bei deiner Doku vlt. kurz erklären wie sich JAVA entwickelt hat und für was man es einsetzt usw.)

2. Projektbeschreibung:
2.1 Ist Analyse : wie sieht's vor dem Projekt aus
2.2 Soll-Analyse : was muß alles i.V.m. dem Projekt gemacht werden muß ; was am Schluß rauskommen soll

3. Projektplanung:
3.1 Kosten-Nutzen-Analyse : Kosten- und Zeitübersicht, etc.
3.2 Zeitplanung : Wie lange man für die einzelnen Schritte in der Projektdurchführung benötigt hat (da muß man auf irgendwie max. 33 Stunden kommen?!)

4. Projektdurchführung:
4.1 Abstimmung mit den Fachbereichen
...
4.13 Einweisung und Schulung der Mitarbeiter
4.14 Fehlerbehebung bei eventuellen Störungen
4.15 Ausarbeitung der Projektdokumentation

5. Projektreview und Fazit : Bei der Durchführung des Projekts gab es nur kleine Schwierigkeiten. Blah blah.

6. Glosar : etwaige Akronyme erklärt

7. Quellen
7.1 Internet
7.2 Literatur
7.3 Sonstige

 

[LockDoc]

Würde sogar eher beides reinbringen; da es nachvollziehbarer wird, wie die Klassen aufgebaut sind + wie das Programm ablaufen soll. 'Ausschließlich' Diagramme usw. sollten eher bei der Projektvorführung benutzt werden.

Bei meiner FiSi-Ausbildung damals (sollte bei FiAe?! nicht anders sein?!):

1. Einleitung:
1.1 Das Unternehmen : Unternehmen kurz vorgestellt
1.2 Datenschutzvermerk : Namen, IP-Adressen usw. wurden unkenntlich gemacht blah blah
1.3 Hintergrund und Einsatz : Bei deiner Doku vlt. kurz erklären wie sich JAVA entwickelt hat und für was man es einsetzt usw.)

2. Projektbeschreibung:
2.1 Ist Analyse : wie sieht's vor dem Projekt aus
2.2 Soll-Analyse : was muß alles i.V.m. dem Projekt gemacht werden muß ; was am Schluß rauskommen soll

3. Projektplanung:
3.1 Kosten-Nutzen-Analyse : Kosten- und Zeitübersicht, etc.
3.2 Zeitplanung : Wie lange man für die einzelnen Schritte in der Projektdurchführung benötigt hat (da muß man auf irgendwie max. 33 Stunden kommen?!)

4. Projektdurchführung:
4.1 Abstimmung mit den Fachbereichen
...
4.13 Einweisung und Schulung der Mitarbeiter
4.14 Fehlerbehebung bei eventuellen Störungen
4.15 Ausarbeitung der Projektdokumentation

5. Projektreview und Fazit : Bei der Durchführung des Projekts gab es nur kleine Schwierigkeiten. Blah blah.

6. Glosar : etwaige Akronyme erklärt

7. Quellen
7.1 Internet
7.2 Literatur
7.3 Sonstige

Genau so und nicht anders
Fein erklärt

 

[Dey]

Mein größtes Problem ist, dass ich Null, wirklich Null Background-Wissen bekommen habe. Brauchte ich für die Migration auch nicht, aber in der Doku wurde mir das zum Verhängnis. Der Projektbetreuer ist jetzt im Urlaub und ich muss mir die Inhalte ausm Ärmel ziehen.

Auch die Durchführung lässt sich eig. nicht durch mehr beschreiben als "von Java nach .NET programmiert".

Ich danke euch aber schon mal für die Hilfe. Ich hoffe, damit doch noch irgendwie voranzukommen

 

[Dey]

also nach wie vor habe ich ein Problem mit der Durchführung:

Wie beschreibe ich die Durchführung einer Programmierarbeit. Ich habe jetzt geschrieben, dass ich die klassenstruktur überarbeitet habe und methoden und eigenschaft neu zusammengefasst habe, um eine höhere kohäsion zu erzielen.

Danach folgt eine tabellarische Auflistung und Beschreibung meiner Klassen in knapper Form. Sollte ich die Funktionen einzelner Klassen genauer erklären oder soll ich anhand der Instanziierung eines Objekts meiner Schnittstelle aufzeigen, wie die Schnittstelle verwendet wird (also OpenConnection(), Send() usw.)

 

[LockDoc]

hmm, all zu sehr kann ich dir jetzt dabei auch nicht helfen, aber mein ehemaliger Azubi-Kollege hat auch eine Programmierarbeit geschrieben/durchgeführt. er hat es damals so gemacht, dass er die durchführung ganz normal beschrieben (um dies zu machen habe ich tralalla usw.) und an interessanten oder wichtigen Stellen hat er den Programmiercode rausgeschrieben um das Ganze dann noch genauer dar zu stellen, um zu erklären wozu das gut ist und warum er sich für diesen Weg entschieden hat.

Letztenendes hat er also durch den Code seine Durchführung beschrieben.

Vielleicht hilft dir das irgendwie weiter!?

PS: Er hat damals bestanden^^ das ist also nicht völligst falsch


Schöne Grüße,
LockDoc

 

[Dey]

Jo, danke für die Hilfe. Hab es doch noch geschafft, einigermaßen gut voranzukommen. Jetzt muss ich aufpassen, dass es nicht zu lang wird

eine Frage in Bezug auf die Programmierung habe ich noch. ich bin gerad dabei, sämtliche Klassen, welche durch das Information Hiding-Prinzip verborgen werden sollen, in die Hauptklasse als InnerClass auszulagern.

Gibt es denn keine alternative Möglichkeit bei .NET dies zu tun?

Also meine Hauptklasse hat eine Methode "OpenConnection". In ihr wird eine SocketClient-Instanz angelegt. Ich möchte aber nicht, dass der Entwickler, welche meine Bibliothek nutzt, direkt eine SocketClient Instanz anlegt.