Foren » 41. Bundeswettbewerb Informatik

[41.2 Allgemein] Dokumentation

    • 7 Beiträge
    6. April 2023 14:58:11 CEST

    Zwei Fragen zu der Dokumentation:

    1. Dürfen wir für verschiedene Teilaufgaben verschiedene Dokumentationen erstellen?

    2. Muss in der Dokumentation die vorgegebene Struktur (Lösungsidee, Umsetzung, Beispiele, Quellcode) eingehalten werden oder können auch Kapitel hinzugefügt, entfernt oder umbenannt werden (wenn es sinnvoll erscheint)?

    • 82 Beiträge
    11. April 2023 09:00:33 CEST

    1. Am einfachsten für uns ist es, wenn alle Dokumentationen zu einer Aufgabe auch in einem Dokument sind. Das macht es schwerer, dass am Ende doch etwas durch rutscht, weil wir etwas übersehen.

    2. Die Struktur ist ein Vorschlag. Die erwähnten Teile sollten aber auf jeden Fall enthalten sein. Du musst dich aber nicht genau daran halten und darfst natürlich auch Kapitel hinzufügen / anpassen etc.

    • 7 Beiträge
    16. April 2023 16:35:12 CEST

    Ich hätte noch eine weitere Frage: Muss der Quellcode in der Dokumentation kommentiert sein oder reicht es aus, wenn der Quellcode in den Dateien kommentiert ist?

    • 82 Beiträge
    17. April 2023 08:23:24 CEST

    Wenn du eh die Kommentare schreibst, dann am Besten auch so mit in die Dokumentation einbinden.