Foren » 30. BwInf

zurück zu den Themen

Programmdokumentation

  • Lukas Juhrich
    • 7 Beiträge
     
    1. Oktober 2011 16:15:58 CEST

    Hallo Leute,

     

    Wenn ich mir die auf der Website des BwInf gepostete Beispielaufgabe so ansehe, ist die Programmdokumentation doch sehr Spartanisch gefasst.

    Ich sitze gerade an der 1 Junioraufgabe und bin gerade heftigst am überlegen, ob ich nun wirklich jede Werteberechnung bei den Rechtecken (z.B. wo die Grenze zwischen 2 Rechtecken verlaufen soll) einzeln zu dokumentieren habe.

     

    Es würde zwar erheblich viel Zeit sparen, einfach nur den Funktionsaufruf mit einer Knappen Beschreibung hineinzubringen, aber ich will mich ja auch nicht in die Gefahr bringen (wie es doch bei meinen letzten Einsendungen kam), mangels ausführlicher Dokumentierung Punktabzug zu bekommen.

     

    In welchemRahmen, meint ihr, sollte ich das Ganze fassen?

     

    Danke für eure Hilfe!

  • Adrian
    • 11 Beiträge
     
    1. Oktober 2011 17:01:29 CEST
    So knapp wie bei der Beispieleinsendung würde ich das auf keinen Fall machen. Bei der letzten 1. Runde wurde mir auch zu kurze Doku angestrichen. Wahrscheinlich musst du nicht en detail erklären, dass du jetzt x von y abziehst, aber im Zweifelsfall immer /mehr/ Doku, wenn du Punkte willst ;)
  • Lukas Juhrich
    • 7 Beiträge
     
    2. Oktober 2011 13:09:27 CEST
    Danke für die schnelle Antwort. Es ist aber trotzdem auf Dauer ziemlich nervig, ständig alles Illustrieren zu müssen, aus Angst vor Punktabzug. ;-)
  • Thomas Leineweber
    • 230 Beiträge
     
    2. Oktober 2011 19:43:57 CEST
    Kennst Du eigentlich http://bwinf-tipps.de/ ? Dort in dem PDF ab Seite 18 findest Du einige Hinweise für die Dokumentation aus der Sicht von mehreren langjährigen Bewertern der ersten und zweiten Runde. Da gibt es auch viele Tipps, was in einer Einsendung zuviel oder zuwenig sein kann.
  • Lukas Juhrich
    • 7 Beiträge
     
    6. Oktober 2011 14:48:21 CEST
    Genau diese ausgearbeitete Lösung war in meiner Frage gemeint, es wurde auf der Website des Bundeswettbewerbs Informatik diese Beispiellösung erwähnt. Ich hatte mich, wie gesagt, verwundert über die Enorme Kürze der Bearbeitung.
  • Thomas Leineweber
    • 230 Beiträge
     
    6. Oktober 2011 19:49:35 CEST
    Hallo Lukas,

    das Beispiel von bwinf-tipps.de ist vollkommen ok. Das würde ich auf nicht als zu kurz ansehen. In den Anmerkungen am Ende steht ja auch etwas zu der Länge einer guten Lösung.