Projektarbeit Informatik-wie schreibt man eine Dokumentation?
Hi, ich bin in der 10. Klasse und schreibe eine Projektarbeit im Fach Informatik. Das Problem ist, dass wir eine Dokumentation schreiben sollen, aber ich weiß nicht genau, wie das geht.
Ich habe jemanden aus meiner Klasse gefragt, was darin enthalten sein sollte, und er hat mir gesagt, ich solle beschreiben, wieso das Programm funktioniert. Ich dachte jedoch, dass in einer Dokumentation eher festgehalten wird, welche Gedanken man bei dem Programm hatte und welche einzelnen Schritte bei der Erstellung notwendig waren. Könnte mir jemand helfen? Ich habe schon angefangen, aber ich denke, es ist etwas „over the top“.
Ich habe das was ich bisher geschrieben habe ist schon 13 Seiten deswegen habe ich Angst Dokumentation falsch verstanden zu haben
1 Antwort
Die Dokumentation zur Erstellung eines EDV-Programms sollte sowohl für Entwickler als auch für Anwender verständlich sein und verschiedene Aspekte umfassen. Dazu gehören Anforderungsanalyse, Entwurf, Implementierung, Test, Fehlerbehebung, Wartung und Versionierung. Eine gut strukturierte Dokumentation ermöglicht eine effiziente Zusammenarbeit, erleichtert das Verständnis des Programms und erleichtert zukünftige Änderungen. (KI)
Am besten fragst du deine Lehrkraft (Projektbetreuer) was er verlangt.
Ja unsere Betreuer haben leider selbst keine Ahnung was mich in die Verzweiflung treibt da ich dachte dass man bei einer Dokumentation den Code ausführlich erklärt da habe ich in der Dokumentation jede einzelnen Code Abschnitt erklärt wieso wir ihn geschrieben haben und was er fürs Endprodukt bringt
theoretisch könnte jemand mit meiner Dokumentation den Code nachstellen