Hallo zusammen,

ich bin gerade am Schreiben meiner Projektdoku und hänge bzw. zerbreche mir gerade den Kopf über den Implementierungsteil...

Kurz zusammengefasst: Mein Implementierungsteil besteht aus Datenbank, prozeduraler Programmierung und visuelle Gestaltung der Oberfläche (low Code). 

Meine größtes Problem ist, dass ich nicht genau weiß, was ich da wirklich reinschreiben soll. Momentan wirkt der Implementierungsteil von mir eher wie eine Entwicklerdokumentation. Ich erkläre also gerade, was der Code im Detail macht und wie er funktioniert. Dies mache ich (beidem Prozeduralen Teil) Pseudocode-Artig (Fließtext mit Unterpunkten). Im Datenbank-Teil erkläre ich die einzelnen Tabellen. Bei der Gestaltung der Oberfläche weise ich auf das erstellte Mockup hin.

Jetzt habe ich dennoch des Öfteren gelesen, dass in die Doku das WARUM und im Anhang das WIE reinkommt. Nun überlege ich, den "Pseudocode" in den Anhang zu schieben, was schreibe ich aber dann in die Doku? 

Bei Beispieldokumentationen habe ich des Öfteren gesehen, dass Code-Snippets erklärt werden. Bzw. Klassen und Methoden erläutert werden.

Da die IHK Minga Obb maximal 20 Seiten vorgibt habe ich keinen Platz für Code-Snippets oder Screenshots von der Oberfläche.

Gruß

Tobi

Also bei meiner Doku (bin FISI) habe ich auch oft erklärt WIE ich den Schritt umsetze, aber gleichzeitig auch begründet WARUM ich das so mache. Dazu hab ich gelegentlich auch noch direkt Screenshots eingefügt, um zu verdeutlichen was ich da genau gemacht habe..

Bearbeitet 20. Mai 20214 j von FISI Tony

Hallo,

prinzipiell solltest du in der Doku ja beschreiben, was du in den einzelnen Projektphasen gemacht hast und warum. Sprich: Du erläuterst kurz zu deinen 3 Bereichen der Implementierung wie du vorgegangen bist und warum. Den Code im Detail zu beschreiben halte ich für wenig zielführend.
Am Ende des Kapitels solltest du dann eine Art Fazit ziehen und auf eventuelle Abweichungen zur ursprünglichen Planung eingehen.