Projektdokumentation Merkmale

[Alexi29]

Hallo Leute,
Welche Merkmale/Kriterien hat eine sehr gute Projektdokumentation? Ich habe schon bei der Seite: https://fachinformatiker-anwendungsentwicklung.net/ geschaut, aber ich will auch eure Erfahrungen wissen.
Ich bin FAEI, und meine vorherige Projektdokumentation war gar nicht gut, deswegen will ich es dieses mal besser machen.
https://www.stuttgart.ihk24.de/blob/sihk24/Fuer-Unternehmen/Fachkraefte-und-Ausbildung/Ausbildung/downloads/Anlagen_Formulare/688492/86c4c978b6bb8acb463f7139cf1fc508/Kriterien_Bewertung_Doku-data.pdf
Was kann man unter dem Ablaufplan verstehen? Und was verstehet man unter der Terminplanung? Sind es die einzelnen Prozess-Schritte mit Datum gemeint? Bei dem Punkt " Kundendokumentation bzw. praxisübliche Unterlagen " Was könnte man noch außer die Kundendokumentation, darunter verstehen, einfügen/erstellen? Was gehört noch bei den praxisüblichen Unterlagen?
Sollte man in der Projektdokumentation auf die Einzelnen Schritte der Programmierung (Technisch) eingehen, oder was sollte man unter dem Punkt "Prozess-Schritte",verstehen ?
Ich habe noch keinen Projektantrag abgegeben , also ist die Hilfe erlaubt.
Wenn etwas unklar sein sollte fragt nach bitte.
Vielen Dank Leute für eure Antworten im Voraus.

Bearbeitet 12. September 2019 von Alexi29

[0x0A]

Die Bewertungskriterien unterscheiden sich zwischen den einzelnen IHKs. Damit können dir auch nur ehmalige Azubis/Püfer von deiner IHK die Frage beantworten. Oder einfach an die Berufsschullehrer wenden, die wissen das meist auch.

Wenn deine IHk die aus Stuttgart ist weißt du ja schon was nötigt ist für eine sehr gute Arbeit.

[allesweg]

Was wurde dir an deiner Projektdokumentation von wem als "gar nicht gut" angemerkt?

Und wieso willst du noch eine machen? Oder musst du die Prüfung ein zweites Mal ablegen?

[Alexi29]

Danke für eure Antworten, aber ich habe nur die IHK zur verfügung, weil ich mache die Prüfung als Externer-Prüfling.Von daher dachte ich Frage ich hier nach, weil ich habt bestimmt Erfahrungen wie man eine sehr gute Projektdokumentation schreiben kann. Auch zu dieser Frage: Welche Merkmale/Kriterien hat eine sehr gute Projektdokumentation? .
Oder anders gefragt, wie macht man eine sehr gute Projektdokumentation?
@allesweg Meine Projektdokumentation hat 43 Punkte bekommen von den Prüfern(Prüfungsauschuss), und deswegen muss ich die Mündliche Prüfung(Präsentation,Fachgespräch usw) erneut ablegen und die Projektdokumentation natürlich auch.

Bearbeitet 12. September 2019 von Alexi29

[Visar]

Die alte Dokumentation in anonymisierter Form wäre natürlich hilfreich, um konkret zu sehen wie du überhaupt vorgegangen bist und ob du ggf. bloß ein paar Sachen abstellen musst (z.B. Missachtung formaler/stilistischer Gestaltungsaspekte). Oder du beantwortest einfach die Frage von @allesweg, was an der Dokumentation schlecht bewertet wurde. Hm.

[allesweg]

Hast du Prüfungseinsicht beantragt?

Stelle doch mal deine Dokumentation anonymisiert hier online. 

Hast du einen Vorbereitungskurs bei der IHK Stuttgart besucht oder bist du ohne fremde Unterstützung da rein gegangen?

[Undercover]

Soweit ich mich erinnern kann, hatte meine IHK die gleichen Bewerungskriterien wie die in Stuttgart. Zumindest hat mir mein Ausbilder, der auch Prüfer ist, das gleiche Formular gezeigt.

Er hat mir folgendes erklärt:

Bei der Terminplanung geht es eben um das Planen der Termine, das kannst du zum Beispiel mit einem Gantt-Chart machen. 

Beim Ablauf geht es um die konkrete Reihenfolge der Schritte. Da kannst du zum Beispiel einen Netzplan machen.

Ich hab aus Platzgründen die beiden Sachen in einem Gantt-Chart vereint.

Du kannst dir meine Doku auch hier ansehen:

https://fachinformatiker-anwendungsentwicklung.net/projektdokumentation-von-julia-haggenmiller-mit-99-bewertet/

Wenn du es ähnlich machst, solltest du locker bestehen

Bearbeitet 12. September 2019 von Julia on Rails

[Alexi29]

Vielen dank Leute für eure Antworten.
@Julia on Rails Danke für deine Antwort, ich habe mir deine Dokumentation angeschaut, fast 100 Punkte sehr gut. Ich werde Sie mir als referenz und die Punkte die du auch hast auch in meiner Projektdokumentation ähnlich einbauen.

@allesweg Ja ich habe Prüfungseinsicht beantrag bei der IHK und auch bekommen. Mit den Kriterien und wie Sie einzeln bewertet wurden, sollte ich die Bewertung hier Hochladen, ist es in Ordnung rechtlich gesehen? Ich habe keinen Vorbereitungkurs für die Mündliche Prüfung besucht, nur für die schriftlichen Prüfungen. Ich habe mir hier im Forum viele Beiträge/Threads angeschaut die sehr hilfreich sind.
Ich habe meine Dokumentation  anonymisiert hochgeladen. Schaut mal rein.
Sollte man in der Projektdokumentation auf die einzelnen Schritte der Programmierung (Technisch) eingehen oder wie sollte man es beschreiben/schreiben wie man programmiert hat?
Ich habe auch bei der IHK nachgefragt, zu den einzelnen Kriterien-Punkte, aber die sagten dass die aufgezählten Punkte Prüfungsleistungen sind, und ich muss meine Fragen selber beantworten..
Jede Meinung ist wilkommen.
Vielen dank im Voraus für eure Hilfe.
Falls etwas unklar sein sollte fragt nach bitte.

Projektdoku_IHK Abschlussprüfung Sommer 2019_Test.pdf

[Undercover]

vor 8 Stunden schrieb Alexi29:

Sollte man in der Projektdokumentation auf die einzelnen Schritte der Programmierung (Technisch) eingehen oder wie sollte man es beschreiben/schreiben wie man programmiert hat?

Die Prüfer wollen einfach wissen, wie du vorgegangen bist und ganz wichtig: wieso. Es geht nicht darum, jedes Fitzelchen Code zu erklären. Eher darum, welche Schritte du gemacht hast, wo es Probleme gab und wie du damit umgegangen bist.

 

Was mir bei der Doku auf den 1. Blick auffällt, ist die Länge bzw eher die Kürze. Wenn man die Grafiken rausnimmt, hast du ca 7 Seiten Fließtext. Was ist denn die Vorgabe der IHK? Max 15 vermutlich, oder? Wieso nutzt du das nicht aus? Das sind etliche verschenkte Punkte. Kauf dir am besten die Doku-Vorlage von Stefan Macke, hab ich auch gemacht. Sind zwar ein paar Euro, aber lohnt sich. Und dann könntest du zur Übung mit der Vorlage eine neue Doku für das Projekt schreiben. Ich wette, dann wird es um Welten besser

[Visar]

Die Dokumentation ist, sagen wir, schwierig... @Julia on Rails hat bereits die Länge angesprochen.

Inhaltlich ist sie allerdings auch nicht gerade bombastisch.

Besonders gefallen hat mir jedoch der Widerspruch zwischen Ressourcen- und Kostenplanung.

"Die Dokumentation wird mit Office 365 Word erstellt."
– 2.2 Ressourcenplanung

"Jede verwendete Software ist über Open Source verfügbar (MySQL-Workbench, Atom)."
– 2.3 Kostenplanung

Ansonsten kommt der wirtschaftliche Aspekt drastisch zu kurz. Du sprichst in 2.3 Kostenplanung einen internen Stundensatz an, gibst dem Prüfer ansonsten aber nichts an die Hand woraus sich dieser ergeben könnte. Es gibt keinerlei Aussage dazu, ab wann sich das Projekt amortisiert oder ob es das überhaupt tut.

Weiterhin benutzt du Abkürzungen ohne Erklärung, wie etwa MQTT. Dazu kommt unnötigerweise, dass sich erst relativ spät deutlich wird, mit welcher Programmiersprache du überhaupt arbeitest - auf der anderen Seite frage ich mich immer noch, weshalb in 3.2 Implementierung der Datenbank Werte mit Python gespeichert werden und wie das geschieht. Immerhin verwendest du laut 3.3 Visualisierung der Messwerte auch Express.js... was doch auch Datenbank kann?

Zu guter Letzt ist das Codebeispiel am Ende der Dokumentation wohl eher der offensichtliche Mittelfinger in Richtung des Prüfungsausschusses, den sich der Prüfer ohnehin seit 14 Seiten dazu dachte. Die Route.js als einziges Beispiel zu nehmen, wobei die einzelnen Routen hier sogar noch Logik beinhalten, die kaum über ein forEach hinausgeht, ist einfach viel zu dünn.

Die Vorlage von Macke könnte dir tatsächlich helfen, auch um etwas mehr Struktur in die Dokumentation zu bekommen und essentielle Punkte nicht einfach wegzulassen. Bei meiner Dokumentation habe ich mich, in Ermangelung von Beispielen in der Schule, grob an der Dokumentation von Gerda Feldhaus orientiert - die auf Basis der Macke-Vorlage erstellt wurde - und bin am Ende auch mit 92 Punkten für die Dokumentation nach Hause gegangen.

[alex123321]

Ich finde dem Bericht fehlt eine gewisse Professionalität.

Du hast kein Qualitätsmanagement.

Schreibst viel zu wenig und gehst viel zu wenig auf den Prozess ein. Zumindest bei mir hieß es POB (Prozessorientierter Bericht).

Deine Planung ist kurz und oberflächlich. Du sollst zeigen, dass du Projekte steuern kannst. Beispielsweise mithilfe des magischen Dreiecks.

Deine Testcases sind unprofessionell und viel zu knapp. Schau dir mal an wie man Testcases schreibt und ausfüllt. Die Testcase haken wirken ebenfalls unprofessionell, insbesondere mit dem Quellenverzeichnis, welches nur den Haken als Link enthält...

Du zeigst nicht, dass du strukturiert vorgehst. Hierfür müsstest du die Durchführung vorher planen und das tust du nicht. Du musst ein detailliertes Sollkonzept vor der Durchführung herausarbeiten. Da IHKs auf UML Diagramme steht, solltest du dies mithilfe von UML machen (Mein Rat). Das Diagramm am Ende welches den Programmablauf darstellt sollte eigentlich relativ weit am Anfang stehen. Nähmlich nach der Analyse & Definition in der Planungsphase.

[Alexi29]

Vielen Dank Leute für eure Antworten, die sind sehr hilfreich.
Das meine Dokumentation kurz ist von der Länge das stimmt, ich hatte leider nicht so viel Zeit für die Doku eingeplant, weil ich viel mehr auf das Projekt ansicht konzentiert habe, was im Nachinein nicht so gut war. Ich werde bei meiner neuen Dokumentation versuchen viel mehr zu schreiben.

@Visar
Danke auch für dein Feedback ich werde mir die Vorlage kaufen von Stefan Macke, und mich daran halten.

@alex123321 Mein Thema ist es aber wie beschreibe ich es diese Prozesse/wie gehe ich darauf ein, weil es muss ja auch verständlich sein, ohne dass der Prüfer den gesamten Quellcode kennt oder wie beschreibt man damit es der Prüfungauschuss versteht?  Ich habe mich mit Testcase noch nie beschäftigt, also ich muss es mir erstmal beibringen,und danach dokumentieren. Reicht es nicht aus nur die Quellen zu verlinken? Du meinst mit strukutiert vorgehen wie z.b das Pflichtenheft,  die Vorgehenweise (Wasserfall, Scrum) oder?
Du sagst am Anfang Professionalität, woher sollte man bitte das Wissen haben, was eine Professionelle Dokumentation benötigt, wenn man es im Betrieb noch nicht gemacht habt? Ich finde die IHK verlangt schon einiges natürlich handelt es sich um eine Abschlussprüfung um zu sehen wer gut für diesen Beruf.
Welche Merkmale/Kriterien hat eine sehr gute Projektdokumentation?
Kurz zu meinem Betrieb mein Ausbilder hat erst dieses Jahres den Ausbilderschein gemacht, deswegen kennt er sich leider auch nicht so gut aus.
Vielen dank Leute für eure Zeit und eure Antworten im Voraus. Es ist echt toll dass es hier Leute gibt die helfen.


 

[alex123321]

Ja, ich meinte dass du zu Beginn der Planungsphase das Wasserfallmodell auswählst und kurz begründest. Anschließend nach dem Wasserfall modell dein Projekt planst und durchführst. Zumindest bei uns wurde Wert gelegt, dass wir zeigen dass wir Projekte auch steuern können, daher solltest du bei Abweichungen vom Projektplan zeigen welche Maßnahmen du ergreifst z.B. Scope Anpassung.

Bzgl. wie es in der Praxis aussieht: Als Informatiker solltest du google nahezu perfekt beherrschen. Google einfach mal die Dinge. Du solltest zu allem professionelle Guidelines und Beispiele finden.

Bei dem Quellenverzeichnis hatte ich kritisiert, dass du dieses eigentlich nicht brauchtest. Der einzige Grund warum du es gebraucht hast, waren die albernen Haken. Hättest du die Haken weggelassen, dann wäre auch das Quellenverzeichnis weg -> würde besser aussehen.

Ich würde nichts auf den Ausbilder schieben. Es ist deine Ausbildung, du sollst zeigen dass du bereit bist deine Ausbildung abzuschließen und du hast mit dem Internet alle Informationen der Welt

 

Viel Erfolg

[Visar]

vor 1 Minute schrieb alex123321:

Bei dem Quellenverzeichnis hatte ich kritisiert, dass du dieses eigentlich nicht brauchtest. Der einzige Grund warum du es gebraucht hast, waren die albernen Haken. Hättest du die Haken weggelassen, dann wäre auch das Quellenverzeichnis weg -> würde besser aussehen.

Obacht: Je nach IHK kann es Pflicht sein ein Quellenverzeichnis zu führen.

Ich kann auch nur dazu raten, da eine Arbeit ohne derartiges Verzeichnis schnell unseriös aussieht. Es ist obendrein auch gar nicht so schwer, ein paar Quellen für die eigene Arbeit zu finden und anzugeben. Du findest bestimmt ein schlaues Wort in der Enzyklopädie der Wirtschaftsinformatik; wirst einen hilfreichen Wikipedia-Artikel lesen; wirst irgendeine Software nutzen und dich auf deren Dokumentation im Internet berufen können...

[Alexi29]

Vielen dank Leute für eure Antworten, Sie helfen mir schon weiter.
@alex123321 Danke jetzt verstehe ich es besser dass mit der Vorgehenweise.
Über die Projektdokumentation, gibt es nicht so viele Beispiele allgemein im Internet, ich kenne nur hier im Forum gibt es ein paar Beispiele und auf der Seite  von Stefan Macke https://fachinformatiker-anwendungsentwicklung.net/beispiele-fuer-abschlussprojekte/ hat es noch viele Projektdokumentation die sehr gut Bewertet wurde, und man kann sich daran orientieren.
Ich schiebe nichts auf dem Ausbilder.Natürlich gibt es im Internet einige Informationen, und es gibt auch sehr gute Beiträge hier im Forum mit vielen Informationen allgemein für die Prüfungen was sehr toll ist.
Vielen dank für das Feedback zu meiner Projektdokumentation echt hilfreich, Danke Leute.
Ich werde versuchen bei meiner nächsten Projektdokumentation es besser zu machen, mit mehr Text usw...

Soweit ich es verstanden haben muss man bei den Prozessen (Implementierung) nur ein paar (Klassen ) vom Quellcode beschreiben und wie man es gemacht(programmiert) hat, und welche Probleme entstanden sind, und wie man es letzendlich gelöst hat. Habe ich das richtig verstanden?
@stefan.macke Ich möchte für dich ein großes Lob aussprechen für deine Website, weil sie ist sehr Hilfreich für alle IT-Azubis.Vielen Dank Stefan

[alex123321]

Ich meinte das nicht bezogen auf Informationen im Internet bzgl. der IHK Prüfung, sondern bezogen darauf wie man es normalerweise professionell macht.

Also wie man User Requirements definiert, Aufwände schätzt, Projekte plant, Qualitätsmanagementpläne aufstellt, Testcases schreibt und durchführt etc. etc.

Da du ein IHK Projekt machst wirst du zwar alles nur in abgespeckter Form machen, im grundsätzlich machst du nichts anderes.

[Alexi29]

Verstehe Danke für deine Antwort verstehe.
Kurze Frage noch Soweit ich es verstanden haben muss man bei den Prozessen (Implementierung) nur ein paar (Klassen ) vom Quellcode beschreiben und wie man es gemacht(programmiert) hat, und welche Probleme entstanden sind, und wie man es letzendlich gelöst hat. Habe ich das richtig verstanden?
Ich bin über jede Meinung/Antwort froh.
Ihr habt mir schon sehr geholfen.

[NowAzubi]

€: Link ging nicht per direkt Aufruf.. hat sich lösen lassen

Bearbeitet 19. Februar 2020 von NowAzubi