Dokumentation zum Abschlussprojekt

[zet]

Hallo zusammen,

ich versuche mir derzeit klarzumachen, wie eine Projektdokumentation auszusehen hat und was der Inhalt sein soll.

Auch Formale Kriterien, wie der Umfang, benötigte Verzeichnisse ect.

Auf der IHK-Seite selber gibt es keine weiteren Informationen zur Doku.

Könnt ihr mir an dieser Stelle weiterhelfen?

Was für Inhalte muss denn in die Doku (z.B. beim Projektantrag : SOLL; IST....)?

Oder sind meine in der Zeitgliederung des Projektantrags angegeben Punkte mehr oder weniger mein Inhaltsverzeichnis, sprich der Ablauf. Ist diese Zeitgliederung eigentlich bindend?

Mit der SuFu bin ich leider nicht viel weitergekommen, im Gegensatz zum Antrag gibt es hier wohl relativ wenig was die Doku betrifft?

Fragen über Fragen, ich hoffe ihr könnt mir ein wenig Input zur Dokumentation geben, vielleicht sogar Beispiele für den Aufbau oder ähnliches.

Beste Grüße,

Zet!

// Edith sagt:

Soll man hier evtl. auch einfach mal der IHK ne Mail schreiben, ob sie mir etwas zur Form/Inhalt zukommen lassen kann?

[mapr]

Hallo zet,

die Zeitgliederung, die du im Antrag abgegeben hast, ist nicht bindend.

Es kann doch durchaus vorkommen, dass du bei einem Punkt schneller bist als gedacht, beim anderen langsamer.

Das würde ich dann z. B. auch mit in der Doku erwähnen (so hab ich das damals bei meiner Doku gemacht, "Soll-/Ist-Zeit").

Wg. dem Umfang solltest du schon mal mit deiner IHK Kontakt aufnehmen.

Hoffe ich konnte dir für's erste ein bisschen weiterhelfen.

[zet]

Danke erstmal für deine Antwort mapr,

inzwischen bin ich etwas fündiger geworden, jedoch werde ich deinen Ratschlag beherzigen und definitiv die IHK kontaktieren, und nach einer Art leitfaden fragen.

Scheinbar hat doch jede IHK da ein wenig eigene Vorgaben.

Das mit der Zeit habe ich mir auch so gedacht, dann werde ich auch dabei bleiben .

Schon Wahnsinn, die Doku's die ich gefunden habe, haben abseits der "eigentlichen" Doku (~15Seiten) mit allen Verzeichnissen, Anhängen ect ungefähr 50 Seiten. Schon Wahnsinn.

Über mehr Input wäre ich trotzdem weiter dankbar!

Beste Grüße,

Zet

[jeronimonino]

Bin mir nicht sicher ob es dir wirklich hilft aber um einen Anhaltspunkt zu bekommen reicht es evtl.

1.	Projektdefinition	

1.1.	Projektbeschreibung	

1.2.	Ist-Zustand	

1.3.	Soll-Zustand	

1.4.	Projektumfeld	

1.5.	Ansprechpartner	

2.	Projektplanung	

2.1.	Allgemein	

2.2.	Produktrecherche	

2.3.	Produktauswahl	

2.4.	Kostenübersicht	

3.	Projektdurchführung	

3.1.	Installation

3.1.1.	Installation der Produktsoftware	

3.1.2.	Konfiguration	

3.1.3.	Verteilung der Client-Software	

3.1.4.	Funktionstest	

4.	Projektabschluss	

4.1.	Netzplan nach Durchführung des Projektes	

4.2.	Dokumentation und Einweisung	

4.3.	Zeitlicher Aufwand	

4.4.	Fazit	

5.	Glossar	

6.	Literatur- und Quellenverzeichnisse	

7.	Anlagen

Insgesamt ist die Doku 14 Seiten lang. und war für den FISI.

[stefan.macke]

Hallo zet,

Schon Wahnsinn, die Doku's die ich gefunden habe, haben abseits der "eigentlichen" Doku (~15Seiten) mit allen Verzeichnissen, Anhängen ect ungefähr 50 Seiten. Schon Wahnsinn.

jede IHK hat da wohl leider wirklich ihre eigenen Richtlinien. Bei der IHK Oldenburg sind z.B. 40 Seiten vorgegeben, also 15 Seiten Text und max. 25 Seiten Anhang. Die Vorgaben würde ich auch immer einhalten, da du sonst im Vergleich zu anderen Prüflingen, die sich daran gehalten haben, schlecht aussiehst. 15 Seiten Text sind also meiner Meinung nach Pflicht (und zwar nicht unterbrochen durch riesige Grafiken oder Tabellen, die gehören in den Anhang!).

Ich habe vor einiger Zeit eine Vorlage für die Abschlussdokumentation mit vielen Beispielinhalten erstellt. Das hier ist das Inhaltsverzeichnis als Anregung:

Abbildungsverzeichnis

Tabellenverzeichnis

Abkürzungsverzeichnis


1. Einleitung

1.1. Projektumfeld

1.2. Projektziel

1.3. Projektbegründung

1.4. Projektschnittstellen

1.5. Projektabgrenzung

2. Projektplanung

2.1. Projektphasen

2.2. Abweichungen vom Projektantrag

2.3. Ressourcenplanung

2.4. Entwicklungsprozess

3. Analysephase

3.1. Ist-Analyse

3.2. Wirtschaftlichkeitsanalyse

3.2.1. "Make or Buy"-Entscheidung

3.2.2. Projektkosten

3.2.3. Amortisationsdauer

3.3. Nutzwertanalyse

3.4. Anwendungsfälle

3.5. Qualitätsanforderungen

3.6. Lastenheft/Fachkonzept

4. Entwurfsphase

4.1. Zielplattform

4.2. Architekturdesign

4.3. Entwurf der Benutzeroberfläche

4.4. Datenmodell

4.5. Geschäftslogik

4.6. Maßnahmen zur Qualitätssicherung

4.7. Pflichtenheft/Datenverarbeitungskonzept

5. Implementierungsphase

5.1. Implementierung der Datenstrukturen

5.2. Implementierung der Benutzeroberfläche

5.3. Implementierung der Geschäftslogik

6. Abnahmephase

7. Einführungsphase

8. Dokumentation

9. Fazit

9.1. Soll-/Ist-Vergleich

9.2. Lessons Learned

9.3. Ausblick


Literaturverzeichnis

Eidesstattliche Erklärung


A. Anhang

A.1. Detaillierte Zeitplanung

A.2. Lastenheft (Auszug)

A.3. Use Case-Diagramm

A.4. Pflichtenheft (Auszug)

A.5. Datenbankmodell

A.6. Oberflächenentwürfe

A.7. Screenshots der Anwendung

A.8. Entwicklerdokumentation

A.9. Testfall und sein Aufruf auf der Konsole

A.10.Klasse: ComparedNaturalModuleInformation

A.11.Klassendiagramm

A.12.Benutzerdokumentation

Viele Grüße!

Stefan

[IT-Kaetzchen]

Die IHK Schwaben sagt, es dürfen nur 9 Seiten (ohne Anhang und Glossar usw.) sein

[stefan.macke]

Die IHK Schwaben sagt, es dürfen nur 9 Seiten (ohne Anhang und Glossar usw.) sein

Das ist ja super Deutlich weniger zu tun!

Als ich damals (2006) meine Prüfung hatte, war der Umfang überhaupt nicht reguliert. Da durfte ich komplette Anforderungsdokumente usw. mit abgeben und bin damit über 100 Seiten gekommen. Für die Prüfer sicher nicht optimal. Von daher ist die Einschränkung schon völlig in Ordnung.

Es ist ja auch ein wichtiger Lernerfolg, wenn ein Prüfling sich bei einem langen Projekt auf die wichtigsten (!) Inhalte konzentrieren und sie vernünftig rüberbringen kann. Daher mein Tipp: nicht uninteressanten Kram (wie z.B. seitenweise Code mit Gettern/Settern) in die Doku packen, sondern nur aussagekräftige Inhalte (z.B. den Kernalgorithmus).

Viele Grüße!

Stefan

[hesham]

Am 24.3.2015 um 11:33 schrieb stefan.macke:

 

Das ist ja super Deutlich weniger zu tun!

 

Als ich damals (2006) meine Prüfung hatte, war der Umfang überhaupt nicht reguliert. Da durfte ich komplette Anforderungsdokumente usw. mit abgeben und bin damit über 100 Seiten gekommen. Für die Prüfer sicher nicht optimal. Von daher ist die Einschränkung schon völlig in Ordnung.

 

Es ist ja auch ein wichtiger Lernerfolg, wenn ein Prüfling sich bei einem langen Projekt auf die wichtigsten (!) Inhalte konzentrieren und sie vernünftig rüberbringen kann. Daher mein Tipp: nicht uninteressanten Kram (wie z.B. seitenweise Code mit Gettern/Settern) in die Doku packen, sondern nur aussagekräftige Inhalte (z.B. den Kernalgorithmus).

 

Viele Grüße!

Stefan

respekt