Dokumentation, aber wie ?

Hi

Ich hab in einem Informatikprojekt in der Schule die Aufgabe des anfertigens einer Dokumentation des Projekts übernommen und jetzt ist das Programm schon halb fertig und ich will langsam mit selbiger anfangen.

Das Problem -> Ich hab keine Ahnung wie eine Dokumentation aufgebaut sein muss !

Da es auf das Projekt jedoch eine Semesternote geben soll, will ich es verständlicherweise so perfekt wie möglich machen

Hat einer von euch für mich mal eine zuferlässige und auch gute Seite, die im Detail erklärt, wie eine Doku aufgebaut sein muss, oder kann mir das mal wer erklären ?

THX !

Dazu gibt es u.a Din-Normen.

Du kannst dazu hier etwas finden zur Din 1422

Ich fand daneben auch diesen Link ganz gut.

Tja, zu einem Informatikprojekt gehört eigentlich ein Pflichtenheft und darin sollte auch eine Beschreibungskonvention erwähnt sein.
Bei einer Software für Prozessrechner findet man z.B. oft eine Spezifikation nach SADT.

Das ist für ein Schulprojekt natürlich etwas dicke

Aber ohne im Vorfeld mal über eine Doku gesprochen zu haben kannst Du es nur falsch oder richtig im Sinne der Lehrkraft machen.

Damit hält sich der Lehrer alles offen. Besprich das mit ihm. Frage nach seinen Bewertungskriterien. Mach Dir Stichpunkte.

Gruss
Tim