Dokumentation zum 1. Projekt

[markus_welsch]

Hallo alle zusammen,

Da ich in Kürze meine Ausbildung zum Fachinformatiker/Anwendungsentwicklung beginne habe ich mir schonmal ein 1. Projekt überlegt. Es handelt sich hierbei um eine Administrationsoberfläche für gewisse Daten. Die Umsetzung wird mit MySQL und PHP, sowie z. T. Apache-Funktionen erfolgen.

Nun habe ich eine Frage wie dass mit der Dokumentation, etc abläuft. Sollte das Projekt überhaupt dokumentiert werden??

Was sollte ich alles in eine solche Dokumentation einbringen??

• Was würdet ihr aus der folgenden Liste vorschlagen zu dokumentieren??
  
  
• Datenbankstruktur [Tabellenübersicht und -details; Nutzung im PHP-Script]
  
• User-Level [verschiedene Rechte, etc]
  
• Beschreibung der erstellten Funktionen & Klassen
  
• eigentliche Funktionen des Scripts [u. a. auch für die verschiedenen User-Level] dann im Browser des Users??
  
  Erweiterungsvorschläge, etc??
  

[Crush1]

Kostenrechnung, logische Struktur, Inhaltsverzeichnis, Pflichten- und Lastenheft

[Crush1]

Fremdwortverzeichnis, Problemstellung, Weg darstellen wie man zur Lösung gelangt. Evtl. ein paar nette Zeichnungen zu internen Programmabläufen des Systems. Test-Phase und Ergebnisse des Tests! Zeitplan bevor das Projekt gestartet wurde und evtl. Korrekturen, falls die Realität stark vom Zeitplan abwich -> hier will man sehen, ob man sich selbst zeitlich einschätzen kann.

[Poldi]

• Vorstudie (Ist Analyse, Soll Konzept ...)
  
• Fachkonzept (kosten/nutzen ...)
  
• DV Konzept (mehr details, schnittstellen, etc)
  

wenn du willst, kann ich dir mal vorlagen für diese dokumente schicken, dann hast du ungefähr einen anhaltspunkt ...

schick mir ne pm wenn ich dir was schicken soll ...