Projektdokumentation: Wie genau aufbauen?

[Heavensdoor]

Hallo,

ich wollte nun so langsam mal mit meiner Projektdokumentation anfangen und stehe da etwas im "Regen" mit, weil ich keine Ahnung habe, was da überhaupt rein soll (Fachinformatiker: Anwendungsentwicklung)

Mein Projektantrag umfasst folgendes:

Im Zuge der Neugestaltung einer Agentursoftware, auf Browserbasis, soll ein neues und innovatives Bedienkonzept integriert werden. Dieses soll sich auf Eingabemasken beziehen und normalen Desktopanwendungen gleichen.

Ist-Zustand:

- Aktuelle Agentursoftware basiert auf einer Filemakerdatenbank, ist jedoch zu instabil und in der Endbedienung zu zeitaufwändig

- Keine Übernahme bestehender Strukturen möglich, somit ein komplett neuer Aufbau nötig

Ziel ist die Erstellung einer Grundversion eines JavaScript-PHP-Frameworks:

- Speicherung/Validierung der Daten ohne „Absendebuttons“ per Ajaxrequests

- Abhängigkeiten zwischen Feldern, z.B. Preis-Anzahl-Multiplikationen

- Automatische Sperrung von Formularen für andere Benutzer bei Verwendung

- Einfache Integration von neuen Ajaxmasken für „unerfahrene“ Entwickler

Verwendung fremder/bestehender Techniken/Klassen/Frameworks:

- externe Ajaxframework „Prototype“

- interne PHP-Klassen für grundlegende Basisfunktionen, z.B. Datenbankklassen

Soll so ablaufen, dass ein Formularfeld sofort abgeschickt, validiert, gespeichert wird, wenn man den es verlässt. Damit soll jeder Speicherbutton entfallen und ein schnelleres Arbeiten möglich sein.

Mein Teil ist praktisch nur ein Teilstück einer ganzen Arbeit und dient als Startpunkt dafür.

Genutzt wurde dafür: HTML, JavaScript, PHP 5.2.0, MySQL 5.1.x

Und zwei externe Klassen: JSON (PHP) und prototype (JavaScript).

Nun hab ich mich mal an eine Gliederung gemacht und dabei ist folgendes rausgekommen:

Vorstellung

===========

- Projektvorstellung


Projektplanung

==============

- Ist-Analyse

- Soll-Konzept

	- Anforderungen	

	- Plattform

	- Abhängigkeiten zu anderer Software

- Zeitplan

- Kostenplanung


Projektdurchführung

===================	

- Protokollentwicklung						

- Klassenprogrammierung

- Testumgebung und Qualitätstest


Projektabschluss

================

- Soll-Ist Vergleich

- Persönliches Fazit

Das Ganze soll auf ungefähr 9-11 Seiten passen. Nun ist meine Frage: Habe ich mit dieser Gliederung überhaupt alles abgedeckt oder sogar zuviel drin?

[Fieldy]

Das Ganze soll auf ungefähr 9-11 Seiten passen. Nun ist meine Frage: Habe ich mit dieser Gliederung überhaupt alles abgedeckt oder sogar zuviel drin?

Schau doch mal bei den Unterlagen von Deiner IHK nach. Da gibt es meistens einen Bewertungsbogen für den Bericht bzw. für die Präsentation, wo Du genau sehen kannst, nach welchen Kriterien der Prüfungsausschuss deine Projektarbeit bewertet. Und genau anhand der Bewertungsgrundlage kannst Du deinen Bericht aufbauen.

[Heavensdoor]

Hab ich schon versucht, jedoch find ich nix auf der Seite von der IHK Wuppertal :/

Nach all dem googlen und hier suchen habe ich mir schon so recht viel angelesen, jedoch selbst das hilft mir nur bedingt.

Da das eigentlich dann eine Doku für unseren Betrieb intern ist, bin ich mir nicht sicher, wie ich die schreiben soll: Hätte dann eher dort die Funktionen der Klassen, etc. beschrieben - also was sie genau machen, wieso sie das tun etc.

Dabei aber nicht auf jeden fetzen code eingehen sondern eher ein Misch aus Codebeschreibung und "Entstehungsgeschichte". Meint ihr, dass passt so?

[Kraizee]

Hoi!

Ich geh in Remscheid zur Berufsschule und ein ganzer Haufen meiner Lehrer, rund die Hälfte, sitzt in den PAs von Wuppertal - hast du dich mal bei deinen Lehrern erkundigt?

Also, zehn Seiten darfst du nicht überschreiten, soviel kann ich dir sagen!

Was allerdings die restlichen Formalitäten angeht, musst du mal in deinen Antrag gucken: Eigentlich sollten da alle Infos bei (gewesen) sein. Vielleicht sind die aber auch mit nem separaten Brief gekommen.

So lief das jedenfalls bei meinen Klassenkameraden ab. Ich mach die Ausbildung zum FIAE in Wermelskirchen und gehöre deshalb zur IHK Köln... Das ist vielleicht ein strenger Verein! Die haben ein 45-seitiges Pamphlet verfasst, einen "Leitfaden zum Abschlussprojekt". Den kannst du dir auf der IHK-Seite runterladen - da gibt's alle möglichen Infos.

Greetz,

Kraizee.