Zum Inhalt springen

Projektantrag Dokumentation?


esya34

Empfohlene Beiträge

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

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?

Link zu diesem Kommentar
Auf anderen Seiten teilen

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

@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

Link zu diesem Kommentar
Auf anderen Seiten teilen

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

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)

Link zu diesem Kommentar
Auf anderen Seiten teilen

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.):

Link zu diesem Kommentar
Auf anderen Seiten teilen

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.

Link zu diesem Kommentar
Auf anderen Seiten teilen

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 von esya34
Link zu diesem Kommentar
Auf anderen Seiten teilen

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"....

Unbenannt4.PNG

Unbenannt5.PNG

Link zu diesem Kommentar
Auf anderen Seiten teilen

Dein Kommentar

Du kannst jetzt schreiben und Dich später registrieren. Wenn Du ein Konto hast, melde Dich jetzt an, um unter Deinem Benutzernamen zu schreiben.

Gast
Auf dieses Thema antworten...

×   Du hast formatierten Text eingefügt.   Formatierung wiederherstellen

  Nur 75 Emojis sind erlaubt.

×   Dein Link wurde automatisch eingebettet.   Einbetten rückgängig machen und als Link darstellen

×   Dein vorheriger Inhalt wurde wiederhergestellt.   Editor leeren

×   Du kannst Bilder nicht direkt einfügen. Lade Bilder hoch oder lade sie von einer URL.

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...