Projektantrag Dokumentation?

[esya34]

Hallo Leute,

ich bin gerade dabei meinen Projektantrag zu erstellen und hätte dies bezüglich eine Frage. Es gibt ja 3 Dokumentationsarten (Projekt-, Entwickler -, Benutzerdokumentation). Muss man für die Abschlussprüfung in der Projektdokumentation auch die anderen 2 Dokumentationsarten erstellen? Oder reicht es, wenn man in der Projektdokumentation nur eins der 2 weiteren Dokumentationen einbaut oder muss man alle beide erstellen?

 

Das wars auch schon. Danke schon mal für eure Antworten.

[neinal]

Du musst eine Projektdokumentation erstellen.

Du hast auch gar keine Zeit noch zwei andere Dokumentationen zu erstellen Du wirst froh sein, wenn dir die Zeit einigermaßen reicht, um die Projektdoku fertig zu machen.

[esya34]

sorry hab es falsch formuliert. Mir ist schon klar das man nur eine Dokumentation macht. In die Projektdokumentation kann man ja noch die Entwickler und Benutzerdoku rein schreiben mit paar Zeilen Text. Ist dass ein muss oder eher nicht?

[neinal]

Was meinst du mit "Rein schreiben mit paar Zeilen Text"?

Meinst du sowas wie "Im Rahmen der Vorbereitung für die Benutzerschulung habe ich eine Benutzerdokumentation erstellt"?

[Gast katiCore]

vor 10 Minuten schrieb neinal:

Meinst du sowas wie "Im Rahmen der Vorbereitung für die Benutzerschulung habe ich eine Benutzerdokumentation erstellt"?

Dafür müsste er ja dann tatsächlich eine Benutzerdokumentation erstellen, und ich denke das lt der Aussage von Dir dafür keine Zeit ist?

[neinal]

Dafür hast du auch keine Zeit. Aber deshalb frage ich. Ich weiß nicht, ob ich seine Frage richtig verstehe....

 

Am Ende hat man eben nur 35 oder 70 Stunden Zeit. Und das ist sehr knapp bemessen...

[thereisnospace]

vor 32 Minuten schrieb neinal:

Du musst eine Projektdokumentation erstellen.

Du hast auch gar keine Zeit noch zwei andere Dokumentationen zu erstellen Du wirst froh sein, wenn dir die Zeit einigermaßen reicht, um die Projektdoku fertig zu machen.

Also ich hatte durchaus Zeit noch eine kleine Benutzerdokumentation zu erstellen und die Entwicklerdoku wurde über JavaDoc generiert. Bei uns ist das sogar ausdrücklich erwünscht, dass eine Benutzerdokumentation vorliegt.

[neinal]

Bei uns gab es da keine Vorgaben.

Und mit Übergabe des ganzen an den Fachbereich, etc. hatte ich keine Zeit mehr für sowas....

[esya34]

@Gottlike genau ich hab mir paar Dokus anegsehen und da standen zur Benutzedokumentation und Entwicklerdokumentation eben paar Zeilen Text z.b dass Vorgehen der Anwendung und im Anhang dazu der Code etc. Ist das ein muss? oder nicht? Weil theoretisch gesehen muss man ja nicht mal seinen Code zeigen

[neinal]

Ich würde niemals in einer Dokumentation meinen kompletten Code offen legen. Klar, hatte ich Ausschnitte aus dem Code im Anhang. Das war es aber auch schon.

 

Darf man fragen, wie die Dokus, die du gesehen hast, benotete wurden? Nützt nix sich an etwas zu halten, was schlecht bewertet wurde. Und wichtig ist auch, von welcher IHK das Ganze ist. Die IHKs haben zum Teil unterschiedliche Anforderungen.

[thereisnospace]

Das was @neinal sagt trifft es am Ehesten. Jede IHK macht ihr eigenes Ding.
Ich hatte bei mir einen Auszug der Entwicklerdoku (in Form von JavaDoc) im Anhang und die komplette Benutzerdoku (bestehend aus 5 Seiten) im Anhang.
Lies dir die Handreichung deiner IHK durch und schau dir die Bewertungskriterien an.
Am Besten orientierst du dich an Dokumentationen, die von deiner IHK bewertet wurden. (Alte Abschlussdokus von Ex-Azubis, bei der Berufsschule nachfragen)

[stefan.macke]

vor einer Stunde schrieb neinal:

Du musst eine Projektdokumentation erstellen.

Du hast auch gar keine Zeit noch zwei andere Dokumentationen zu erstellen Du wirst froh sein, wenn dir die Zeit einigermaßen reicht, um die Projektdoku fertig zu machen.

Da muss ich leider entschieden widersprechen. Es kann sein, dass einige IHKen auf Kunden- und/oder Entwicklerdoku verzichten, aber meiner Erfahrung nach, wollen die meisten IHKen das explizit haben. Das steht sogar in den Bewertungsmatrizen für die Dokumentation (s.u.). Zumindest die Benutzerdokumentation ist demnach Pflichtprogramm als Teil jeder Projektdokumentation. Eine Entwicklerdokumentation (z.B. mit JavaDoc) würde ich im Sinne einer guten Bewertung aber auch noch zusätzlich erstellen.

Vgl. (u.a.):

• http://www.ihk-niederrhein.de/downloads/ihk/Bewertungsmatrix_Doku_FIAN.pdf
• https://www.darmstadt.ihk.de/blob/daihk24/produktmarken/aus_und_weiterbildung_channel/pruefungen/downloads/downloads/2551166/bdb388bedbc086ef6af8038551c207d2/Bewertungsmatrix_FIAE-data.pdf
• http://www.dortmund.ihk24.de/blob/doihk24/bildung/downloads/305454/d4d06e5b78c03eaf279dbfdb8e000292/Handreichungen_IT_Berufe-data.pdf

[neinal]

Unsere IHK hat auf andere Dinge Wert gelegt. Und bei einer Bewertung von 98 Punkten, kann ich das ja nicht so falsch gemacht haben.

Das Problem ist halt immer, dass jede IHK ihr eigenes Süppchen kocht.

[stefan.macke]

Ok, das stimmt natürlich. Ich würde aber einfach mal behaupten (allein weil in allen Bewertungsmatrizen auf der ersten Google-Suchergebnisseite explizit eine Benutzerdokumentation gefordert wird), dass die meisten IHKen eine separate Benutzerdokumentation erwarten. Im Zweifel geht natürlich der Wunsch der eigenen IHK vor!

Und es bietet sich natürlich auch nicht für jedes Projekt eine solche Doku an! Wenn es keine Benutzer gibt, kann man auch keine Doku für sie schreiben. Dann würde ich aber schauen, ob es andere Zielgruppen gibt (z.B. Admins, Entwickler), für die eine Dokumentation sinnvoll wäre.

[UniBall]

Ich habe bei meiner nen Admin Handbuch mit reingemacht, so stand es auch im Antrag mit drin.

Laut meiner IHK sind das 10% was es an der Note ausmacht!

Bearbeitet 6. März 2017 von UniBall

[esya34]

Vielen Dank für die Antworten! Hat mir sehr weiter geholfen. 

Eine letzte Frage hätte ich noch. In welcher Erzähls-Perspektive sollte der Projektantrag und die Doku erstellt werden? Eine sachliche oder? (IHK München, falls es da kriterien dafür gibt)

Bearbeitet 6. März 2017 von esya34

[neinal]

Ich hab mal mein Inhaltsverzeichnis angehängt. War auch IHK München.

Ja. Sachlich. Und kein "zuerst habe ich mir eine Tasse Kaffee gemacht, dann bin ich an den Schreibtisch gegangen und dann habe ich mich an meinem Laptop angemeldet. Dann habe ich xyz gemacht. Dann war ich beim Mittagessen"....

[esya34]

Top vielen dank