Dokumentation: Klassendiagramme & Screenshots

[warum]

Hallo zusammen,

zu diesen Fragen habe ich bisher noch keine Antworten hier gefunden:

Meine Dokumentation (IHK Braunschweig, FI AE) und damit auch mein Projekt handelt von der Erstellung einer konfigurierbaren sortierfunktion für ein Treeview-Fenster in C++.

Leider bin ich gerade ein wenig unsicher, in wie fern ich da ins Detail gehen soll...denn die Anwendung, in welcher sich dieser Dialog befindet ist an sich recht komplex, und schon die Klassendiagramme für den Dialog würden die mir auferlegte 10-Seiten-Grenze deutlich sprengen :mod:

Wo und in welchen Detailgrad müssen Klassendiagramme wohl

1. in die Doku selbst

2. in den Anhang (der ja wohl nicht bewertet wird?)

Und bis zu welchem Detail muss ich wohl die Hintergründe erklären (3-Tier-Modell z.B.)?

Schon mal danke für Eure Antworten

Fragend,

Christian

[arrayhunter]

hallo,

in meiner Doku habe ich das 3Tier-Modell grafisch aufbereitet (inkl. Schnittstellen).

das Klassendiagramm habe ich in den Anhang gepackt.

in der Doku selbst bin ich nur auf die wichtigste Klasse eingegangen incl. Quellcodes der relevanten Klassen.

[Gast roaxius]

Original geschrieben von warum

Leider bin ich gerade ein wenig unsicher, in wie fern ich da ins Detail gehen soll...denn die Anwendung, in welcher sich dieser Dialog befindet ist an sich recht komplex, und schon die Klassendiagramme für den Dialog würden die mir auferlegte 10-Seiten-Grenze deutlich sprengen :mod:

Sie würden wohl nicht die 10 Seiten sprengen, da sowas in den Anhang gehören würde und dieser nicht mitgezählt wird.

Nebenbei würde ich auch definitiv nicht so sehr ins Detail gehen, da das eigentliche Produkt nur Mittel zum Zweck ist, anhand dessen du aufzeigen kannst, wie du ein Projekt planst, kontrollierst und umsetzt.

Würde ich nur da machen, wo es den Sinn-Zusammenhang zwischen deinem Teilprojekt und dem ganzen Programm herstellt. Eher dann auszugsweise. Auf jeden Fall im Anhang.

Woher hast du, dass dieser nicht bewertet wird? Ich denke mal, er zählt nur nicht zu den Seiten hinzu, aber wenn du sinnvolle Sachen in den Anhang auslagerst, wird dies sicherlich auch positiv bewertet werden. Jedoch kenne ich da die Verteilung leider auch nicht so.

Wirklich grundlegende Sachen kannst du sicherlich voraussetzen (schließlich sitzen in den PAs ja Fachleute!) oder ansonsten kurz in einem Satz eine Definition im Anhang geben.

[arrayhunter]

Original geschrieben von roaxius

Wirklich grundlegende Sachen kannst du sicherlich voraussetzen (schließlich sitzen in den PAs ja Fachleute!) oder ansonsten kurz in einem Satz eine Definition im Anhang geben.

da widerspreche ich aber, schliesslich sollte doch die Dokumentation kundenorientiert sein, und da kann man wirklich nicht die 3Tier-technologie voraussetzen, oder sehe ich das falsch ?

[warum]

Danke für die Antworten

Original geschrieben von roaxius

Sie würden wohl nicht die 10 Seiten sprengen, da sowas in den Anhang gehören würde und dieser nicht mitgezählt wird.

Nebenbei würde ich auch definitiv nicht so sehr ins Detail gehen, da das eigentliche Produkt nur Mittel zum Zweck ist, anhand dessen du aufzeigen kannst, wie du ein Projekt planst, kontrollierst und umsetzt.

Hmm...auch wieder wahr. Also wird es wohl nur eine kurze Beschreibung der grundlegenden Funktionalität mit Hinleitung auf die spezielle Funktion des Dialogs an sich geben

[...]

Woher hast du, dass dieser nicht bewertet wird? Ich denke mal, er zählt nur nicht zu den Seiten hinzu, aber wenn du sinnvolle Sachen in den Anhang auslagerst, wird dies sicherlich auch positiv bewertet werden. Jedoch kenne ich da die Verteilung leider auch nicht so.

AFAIR habe ich das hier gelesen...könnte aber auch sein, daß ich das falsch verstanden und mit der Zählung der Seiten an sich verwechselt habe *g*

Also werde ich ruhig mehr in den Anhang auslagern (auf jeden Fall sämtliche Klassendiagramme des Dialogs mit Abhängigkeiten etc.).

Und wenn ich schon mal dabei bin: ein paar Screenshots werden auch nicht schaden ;o)

Wirklich grundlegende Sachen kannst du sicherlich voraussetzen (schließlich sitzen in den PAs ja Fachleute!) oder ansonsten kurz in einem Satz eine Definition im Anhang geben.

Tja..das mit den Fachleuten kann man nur hoffen

Allerdings ist das mein generelles Problem in der ausbildung:

Man weiss nie, wie viel Wissen man tatsächlich vorraussetzen darf bzw. kann, und wie allgemeinverständlich das sein muss...

Cheerio,

Christian

[warum]

Original geschrieben von arrayhunter

da widerspreche ich aber, schliesslich sollte doch die Dokumentation kundenorientiert sein, und da kann man wirklich nicht die 3Tier-technologie voraussetzen, oder sehe ich das falsch ?

Hmm..IMHO ist es schliesslich eine Fachdoku, also sollte man ein gewisses Maß an Wissen schon vorraussetzen können (sonst wären die 10 Seiten ja auch nicht wirklich ausreichend *g*)...

Aber wie gesagt:

Da bin ich jedes Mal aufs Neue ein wenig verunsichert :-/

[timmi-bonn]

Original geschrieben von arrayhunter

[...] , schliesslich sollte doch die Dokumentation kundenorientiert sein,

Wo steht das?

gruß, timmi

[arrayhunter]

Durch die Projektarbeit und deren Dokumentation soll der Pruefling belegen, dass er Arbeitsablaeufe und Teilaufgaben zeilorientiert unter Beachtung wirtschaftlicher, technischer, organisatorischer und zeitlicher Vorgaben selbstaendig planen und kundengerecht umsetzen sowie Dokumentationen kundengerecht anfertigen, zusammenstellen und modifizieren kann.

[Gast roaxius]

Original geschrieben von arrayhunter

da widerspreche ich aber, schliesslich sollte doch die Dokumentation kundenorientiert sein, und da kann man wirklich nicht die 3Tier-technologie voraussetzen, oder sehe ich das falsch ?

Darf ich dann auch widersprechen??

Wo hast du das denn her?

[EDIT: Sorry, zu spät ]

[arrayhunter]

Ausbildungsordnung für FI

http://www.dayofweb.com/it-berufe/2-1.html#§§9

jetzt bin ich aber irgendwie verunsichert

[Gast roaxius]

Original geschrieben von arrayhunter

Durch die Projektarbeit und deren Dokumentation soll der Pruefling belegen, dass er Arbeitsablaeufe und Teilaufgaben zeilorientiert unter Beachtung wirtschaftlicher, technischer, organisatorischer und zeitlicher Vorgaben selbstaendig planen und kundengerecht umsetzen sowie Dokumentationen kundengerecht anfertigen, zusammenstellen und modifizieren kann.

Das sieht für mich aber eher danach aus, dass du mit deiner fachlichen Projektdokumentation belegst, dass du das alles machen kannst und Dokumentationen kundengerecht anfertigen kannst... IMHO ist hierbei der Kunde deiner Projektdoku der PA! Weiter Sachen wie Benutzer-Anleitung und so könnten in den Anhang und sollten dann auch wirklich Anwender=Kunde orientiert sein.

Aber da "streiten" sich hier immer mal wieder alle drüber... Gibt da etliche Threads und es ist wohl auch von IHK zu PA zu Prüfer etwas unterschiedlich Am besten fragst du mal bei deiner IHK und deinem PA nach, falls du ganz unsicher bist.

Für mich kann ich sagen, dass ich es vollkommen neutral, sachlich dokumentiert habe laut gängigem Aufbau. Ich habe grundlegende Sachen alle vorausgesetzt und auch bei der Präsi und dem Fachgespräch für den PA präsentiert (also zielgruppengerecht). Für den Kunden oder Anwender hatte ich lediglich im Anhang eine Benutzer-Dokumentation. Alles in allem hat mir die Doku inkl. Präsi und FG 96 Punkte gebracht, so dass ich zumindest von meinem Standpunkt her sagen kann, dass es nicht ganz falsch gewesen sein kann (Ich war IHK Hannover)

[Der Kleine]

Original geschrieben von roaxius

Sie würden wohl nicht die 10 Seiten sprengen, da sowas in den Anhang gehören würde und dieser nicht mitgezählt wird.

Was zu bezweifeln wäre.

Das handelt nunmal jeder PA in der zutreffenden IHK ein wenig anders.

Teilweise gibt es Beschränkungen für die Doku und für Doku plus Anhang.

Für mehr Details fragt doch bitte Euren zuständigen PA in Eurer IHK.

[warum]

Original geschrieben von Der Kleine

[...]

Für mehr Details fragt doch bitte Euren zuständigen PA in Eurer IHK.

Hmm...habe heute morgen schon eine Mail geschrieben ;o)

Aber: es ist also generell in Ordnung, z.B. für ein Diagramm zum 3-Tier-Modell oder Klassendiagramm auf den Anhang zu verweisen?

[Gast roaxius]

Meine persönliche Meinung wäre folgende:

Das sollte prinzipiell in Ordnung sein. Allein schon der Übersichtlichkeit halber sollte man Abbildungen wenn möglich aus dem Fließtext in den Anhang packen. Jedenfalls besonders dann, wenn sie nur der allgemeinen Information dienen und nicht in absolut direktem Bezug zum gerade gesagten im Text stehen.

[warum]

Hmm..danke für die Antworten

Ich mache es jetzt ganz einfach so:

Auszüge aus dem Quelltext in kleiner Schrift in den Text (z.B. die wichtigsten Methoden, gekürzt) und ein kleines Diagramm.

Der Rest kommt in den Anhang (mit Verweisen darauf im Text).

Mir fällt nur nix für die Fußnoten ein..aber die müssen ja nicht unbedingt sein, oder?