Frage zur Doku

[Cleriker]

Guten Morgen!

Es geht um die Doku die wir abgeben müssen, da gibts anscheinend Unstimmigkeiten.

Einige machen quasi "Doku" und "Pflichtenheft" in einem, andere geben das Pflichtenheft als Anhang zur Doku samt weiterer Screenshots ab.

Ich hab bisher auch alles in einem gemacht und bin daher jetzt ehrlich gesagt etwas verwirrt. Am besten ich geb euch mal meine Gliederung und ihr sagt mir ob ich das jetzt falsch gemacht hab oder ob das okay ist.

Inhaltsverzeichnis


1. Firmenbeschreibung			Seite 3

	1.1 ZF Sachs AG			Seite 3

	1.2 Abteilung ISDH			Seite 3

	1.3 Ist-Aufnahme			Seite 4

	1.4 Ist-Analyse			Seite 4


2. Zielbestimmung				Seite 5

	2.1 Produktvision			Seite 5

	2.2 Musskriterien			Seite 5

	2.3 Wunschkriterien		Seite 5

	2.5 Projektterminierung		Seite 5


3. Produkt-Einsatz				Seite 6

	3.1 Anwendungsbereich		Seite 6

	3.2 Zielgruppe			Seite 6

	3.3 Betriebsbedingungen		Seite 6

	3.4 Benutzeroberfläche		Seite 6


4. Projekt-Umsetzung			Seite 7

	4.1 Use-Case Diagramm		Seite 7

	4.2 Geschäftsprozesse		Seite 7

	4.3 Daten			Seite 11

	4.4 Testszenarien			Seite 11

	4.5 Entwicklungsumgebung		Seite 12

	4.6 Durchführung			Seite 12


5. Fazit					Seite 13


6. Anhang

	6.1 Screenshots der Benutzeroberfläche

	6.2 Codebeispiele

Die Seiten 1 und 2 sind quasi Deckblatt und Inhaltsverzeichnis. Hoffe ich habs net komplett versaut -.-

Grüße

[jonas_]

Dein Projektbericht schaut eher wie ein Pflichtenheft aus. Das Pflichtenheft habe ich in den Anhang gepackt. Im Projektbericht habe ich eher geschrieben, warum ich was wann wie gemacht habe.

[Cleriker]

Die Frage ist, was müsste ich hier rausnehmen und gesondert als Pflichtenheft schreiben und welche Punkte fehlen mir dann noch für die Doku

[yhsif]

So habe ich es gemacht und von unseren IHK Lehrern vorgeschlagen:

IHK Köln - FIAE

Inhaltsverzeichnis

Projektantrag

Prozessorientierter Projektbericht

Anhang A: Vorgehensmodell

Anhang B: Lastenheft

Anhang C: Pflichtenheft

Anhang D: Abnahme des Pflichtenheftes

Anhang E: Zeitplanung - Arbeitspakete

Anhang F: Recherchedokument

Anhang G: Meilensteinplan

Anhang H: Projektstrukturplan

Anhang I: Ressourcen- Kapazitätenplanung

Anhang J: Qualitätsplan

Anhang K: Wirtschaftlichkeitsanalyse

Anhang L: UseCase – Diagramm

Anhang M: Klassendiagramm

Anhang N: Sequenzdiagramm

Anhang O: ERD-Modell

Anhang P: Objektrelationales Datenbankmapping Planungsdokument

Anhang Q: UI-Testing

Anhang R: Destruktionstest

Anhang S: Zeitplanung Soll / Ist Vergleich

Anhang T: Abschließende Wirtschaftlichkeitsanalyse

Kommentierter Quelltext

Literaturverzeichnis

Glossar

Persönliche Erklärung

Und so den Prozessorientierten Bericht aufgeteilt:

1.0 Einleitung

2.0 Projektbeschreibung

2.1 Projektaufgabe

2.2 Projektumfeld

2.3 Projektschnittstellen

2.3.1 Organisatorische Schnittstellen

2.3.2 Technische Schnittstellen

2.4 Änderungen gegenüber dem Projektantrag

3.0 Definitionsphase

3.1 Prinzipien und Methoden

3.2 Vorgehensmodell

3.3 Zeitplanung

3.4 Ist-Analyse

3.5 Recherche XML Struktur

3.6 Soll Konzept

3.7 Meilensteinplanung

3.8 Projektstrukturplan (Prozessablaufplan)

3.9 Kapazitätenplan

3.10 Kosten-Wirksamkeits-Analyse

3.11 Qualitätsplan/Qualitätssicherung

3.12 Testkonzept/Testplan

4.0 Planungsphase

4.1 Erstellung der UML-Diagramme für das DV-Konzept

4.2 Erstellung eines ERD-Modelles

4.3 Planung eines objektrelationalen Datenbankmappings

4.4 Identifikation von möglichen Einsatzgebieten der Applikation

4.5 Testfallkatalog

5.0 Implementierungsphase

5.1 Datenbank

5.2 Oberfläche und Programmierung der Funktionalitäten

5.3 Abnahme kommentierter Quelltext

6.0 Testphase

6.1 Testing

7.0 Projektabschluss

7.1 Soll Ist Zeitvergleich

7.2 Abschließende Wirtschaftlichkeitsbetrachtung

7.3 Fazit Qualitätssicherung

7.4 Meilenstein: „Projektabgabe“

7.5 Projektfazit

Vielleicht hilfts ja.

Insgesamt 107 Seiten

Bearbeitet 10. Juni 2008 von yhsif

[Maverick897]

107???????

Wir durften in unserer Projektdokumentation maximal 20 Seiten Doku und 20 Seiten Anhang.

[Cleriker]

Der Prüfungsausschuss empfiehlt, dass der Umfang der Projektdokumentationen mit

Anlagen, Tabellen usw. ca. 15, maximal 18 Seiten betragen soll. Schriftart Arial, Schriftgröße

11 pt, Zeilenabstand 1 ½-zeilig. Links ist ein Heftrand von 2,5 cm und rechts ein

Korrekturrand von 2,5 cm zu berücksichtigen. Der Ausdruck hat einseitig zu erfolgen.

Soviel dazu ^^

Leider hilft mir die Gliederung nicht weiter, da ich nicht im entferntesten ein derart großes Projekt habe.

[Cleriker]

Was von meiner Gliederung gehört denn nun wo rein bitte?

[Kuroi]

Also zunächst mal, die Vorgaben der IHK in Bezug auf Seitenanzahl, Schriftgröße etc. sind, zumindest bei uns (IHK Würzburg-Schweinfurt) alles allgemeine Richtlinien, keine strikten Vorgaben! Das heißt, wenn du jetzt 25 Seiten Dokumentation mit Schriftgröße 12 hast, ist das auch kein Problem. Hatte extra noch dort nachgefragt, Zitat: "Wir messen da doch nicht nach!"

Die Vorgaben existieren nur deshalb, damit alle abgegebenen Dokumentationen ansatzweise den gleichen Umfang haben und ein Prüfer nicht an einer Dokumentation 5 Stunden und an der anderen 10 Stunden sitzt.

Aber die Erfahrung, die ich bisher mit anderen ausgetauscht habe, sagt: Ein gesundes Mittelmaß in Sachen Dokumentationsgröße. 107 Seiten sind absolut überzogen. Selbst, wenn das Projekt so umfangreich ist, ist es in 70 Stunden nicht zu bewältigen.

Ich persönlich werde mich auf ca. 13 bis 14 Seiten (exklusive Anhang, da denke ich so ca. an 8 bis 9 Seiten) beschränken, da ich 10 Stunden für meine Dokumentation eingeplant habe. Bei mehr Seiten muss der Prüfer eigentlich schon Zweifel haben, ob da wirklich 70 Stunden eingehalten wurden.

Zur Diskussion Dokumentation/Pflichtenheft: Ich verlagere das Pflichtenheft in den Anhang, auch wenn ich mich damit in manchen Punkten wohl wiederhole. Einiges, was im Pflichtenheft steht, habe ich teilweise in kürzerer Form auch schon in die Projektdokumentation mit eingebaut.

Letztendlich gibt es keine genauen Vorgaben für die Strukturierung deiner Dokumentation, jede ist anders, insofern Ratschläge in Sachen Gliederung zu geben, halte ich für unsinnig.

[yhsif]

Mit 107 Seiten liege ich , was meine Schule angeht im Gesunden Mittelmaß.

Wahrscheinlich hat die IHK-Köln andere Vorstellungen.

2 unserer Lehrer die im Prüfungsausschuss sitzen haben uns diese Gliederung empfohlen und zu den Seiten gesagt, dass 150 Seiten heute kaum noch ungewöhnlich sind.

Außerdem nimmt der Quellcode ne Menge Platz ein

[Maverick897]

gut den quellcode mussten wir auf cd mitliefern. aber über 100 seiten is bei uns schon echt zuuuu viel.

[Cleriker]

Ihr habt nicht wirklich den kompletten Quellcode mit abgegeben oder?

ich hab nun die letzten zwei stunden damit verbracht, meine doku neu aufzupolieren. ich komme nun auf 5 seiten pflichtenheft und 11 seiten doku - macht also 17 seiten zuzüglich anhang, der wird sich vermutlich auf ca 5-6 seiten belaufen. inhalt werden ca. 2 seiten screenshots und der rest beispielcode sein. da mein projekt in vba geschrieben ist, sind die module zum glück relativ unabhängig und ich muss net alles mit reinnehmen. mir gehts hauptsächlich um die darstellung der logik die ich angewendet habe, daher wollte ich zu jedem beispielcode eine erklärung über den ablauf abgeben. meint ihr das ist okay?

hier auch nochmal meine neue gliederung:

DOKUMENTATION:



1. Firmenbeschreibung	3

1.1.	Musterfirma	3

1.2.	Abteilung XYZ	3

1.3.	Ist-Aufnahme	4

1.4.	Ist-Analyse	4

2.	Projektterminierung	5

3.	Projekt-Umsetzung	6

3.1.	Use-Case Diagramm	6

3.2	Geschäftsprozesse	6

4.	Durchführung	9

4.1.	Planungsphase	9

4.2.	Programmierungsphase	9

5.	Fazit	11

PFLICHTENHEFT:



1.	Zielbestimmung	2

1.1.	Produktvision	2

1.2.	Musskriterien	2

1.3.	Wunschkriterien	2

1.4.	Abgrenzungskriterien	2


2.	Produkt-Einsatz	3

2.1.	Anwendungsbereich	3

2.2.	Zielgruppe	3

2.3.	Betriebsbedingungen	3

2.4.	Benutzeroberfläche	3


3.	Projekt-Informationen	4

3.1.	Projekt Umgebung	4

3.2.	Daten	4

3.3.	Entwicklungsumgebung	5

3.4.	Qualitätsbestimmung	5


4.	Testszenarien	5

[Kuroi]

Mit 107 Seiten liege ich , was meine Schule angeht im Gesunden Mittelmaß.

Wahrscheinlich hat die IHK-Köln andere Vorstellungen.

2 unserer Lehrer die im Prüfungsausschuss sitzen haben uns diese Gliederung empfohlen und zu den Seiten gesagt, dass 150 Seiten heute kaum noch ungewöhnlich sind.

Außerdem nimmt der Quellcode ne Menge Platz ein

Also zunächst - 150 Seiten Dokumentation? Ich hoffe, eure Lehrer bzw. Prüfer sind sich im Klaren, dass sowas nicht ansatzweise innerhalb der vorgegebenen 70 Stunden zu erledigen ist und es die zeitliche Begrenzung nicht umsonst gibt? Entschuldige, aber wenn ich solche Aussagen höre, muss ich doch ernsthaft 'n bisschen am Verstand solcher Leute zweifeln.

Zum Code: Ich liefere mit Sicherheit nicht meinen ganzen Quellcode ab. Schließlich interessiert sich kein Prüfer für 2 Seiten (oder mehr, je nachdem ...) GUI-Code. Das "Fleisch", also die Funktionalität, ist elementar, damit dein Programm nachvollziehbar ist. Deshalb werd' ich wichtige einzelne Methoden auch in den Anhang packen.

Ich kann's echt kaum glauben, dass manchen Prüfern Quantität wichtiger als Qualität ist, bestätigt aber nur meine allgemein eher mäßige Meinung zur Praxisnähe der IHK.

[Cleriker]

Ich kenn da auch so ne Schule, wo Elite-Fachinformatiker ausgebildet werden. Die haben aber sicherlich auch über 100 Seiten Doku. Wenn ich mich recht erinnere, war die irgendwo bei Straubing :floet:

[Kuroi]

Ich kenn da auch so ne Schule, wo Elite-Fachinformatiker ausgebildet werden. Die haben aber sicherlich auch über 100 Seiten Doku. Wenn ich mich recht erinnere, war die irgendwo bei Straubing :floet:

Japp, und was aus denen wird, sieht man ja auch in diversen ... Threads.

(Oh Gott, ich musste gerade so lachen ... um mich herum nur fragende Gesichter im Moment. xD)

[Cleriker]

Hab auch so ein gewisses Grinsen im Gesicht

schönen Feierabend! Bis morgen

[Maverick897]

Wir mussten von unserer IHK aus den quellcode auf cd mitliefern. Qir durften den nciht in den Anhang machen.

[Cleriker]

Ahja.. ihr MUSSTET?

Also ich kann mich erinnern, dass unsere Lehrer meinten wir sollten in der Firma auf jeden Fall fragen, ob es "okay" ist den Quellcode der IHK vorzulegen. Soll net pingelig klingen, aber auch meine Vorgesetzten haben erst mal in ner zuständigen Abteilung nachgefragt ob es da Schwierigkeiten mit der Firma geben kann wenn ich Beispielcode vorlege.

Wir wollen mal nicht vergessen, wer die Rechte am Code hat