Foren » 34. BwInf

Länge der Dokumentation

    • 7 Beiträge
    22. März 2016 20:17:43 CET
    Gibt es irgendwelche Richtwerte für die Länge der Dokumentation? Ich habe bei der Dokumentation der ersten Aufgabe bereits 7 Seiten (5-6 reiner Text) und bin erst bei der Implementierung des Hauptalgorithmus. Das alles kommt mir ein bisschen viel vor, selbst für die 1200 Zeilen Code meiner Bearbeitung.

    Sollte ich versuchen zu kürzen oder lieber so ausführlich bleiben?
    • 8 Beiträge
    23. März 2016 00:58:43 CET
    10 Seiten reiner Text können schon drin sein, viel mehr würde ich aber nicht schreiben. Dann eher mehr Graphiken benutzen, die helfen dem Leser oft auch mehr als nur reiner Text.
    Als Orientierung kannst du dir hier frühere Einsendungen anschauen. Leider ist nicht vermerkt, welche Bewertung die einzelne Dokumentation erhalten hat; aber für einen Überblick in Sachen Seitenlänge sollte es reichen. Vielleicht findest du in den alten Dokus ja auch noch Themen, die sich lohnen würden auch bei deiner anzusprechen.

    http://www.tobias-thierer.de/bwifiles.html
    • 230 Beiträge
    23. März 2016 12:30:05 CET
    Hallo zusammen,

    es ist immer schwer zu sagen, wie lang eine Dokumentation sein sollte. Man kann es eigentlich nur anhand der konkreten Dokumentation sagen, ob sie zu kurz oder zu lang ist. Die Beispiel auf der Seite von Tobias Thierer sind schon ganz gut. Ihr solltet nur aufpassen. Die ist unter den bekannten BwInf-Info-Seiten die älteste. Seitdem haben sich mindestens zweimal die Vorgaben für die Dokumentation etwas geändert. Insbesondere die Struktur hat sich im Rahmen der Umstellung auf die elektronische Einsendung geändert. Ein etwas aktuelleres Info- und Hilfs-Dokument (inoffiziell) ist auch unter https://bwinf-tipps.de/ zu finden. Da sind auch einige Hinweise zu den Inhalten einer guten Doku drin. Auch gute Informationen liefert https://martin-thoma.com/bundeswettbewerb-informatik/

    Und in der Community hier gibt es bei den alten Wettbewerben zur zweiten Runde auch ein paar Links zu Einsendungen.
    Viele Grüße
    Thomas
    • 7 Beiträge
    2. April 2016 18:41:53 CEST
    Wieviel dürfen wir bei der Dokumentation vorrausetzen? Also zB müssten wir bei der Nutzung von Listen, Binärbäumen oder Graphen vorraussetzen dass der bewerter diese datentypen kennt auch wenn wir nicht die aus der Standartbib nutzen sondern selbst implementierte? (Haben wir in info mal implementiert und nutze ich deshalb immer)
    Müssen wir leichte änderungen beschreiben? Oder nur kurz erwähnen was hinzugefügt wurde?
    • 230 Beiträge
    2. April 2016 19:04:33 CEST
    [blockquote]Katrin K. said:
    Also zB müssten wir bei der Nutzung von Listen, Binärbäumen oder Graphen vorraussetzen dass der bewerter diese datentypen kennt auch wenn wir nicht die aus der Standartbib nutzen sondern selbst implementierte? (Haben wir in info mal implementiert und nutze ich deshalb immer)
    Müssen wir leichte änderungen beschreiben? Oder nur kurz erwähnen was hinzugefügt wurde? [/blockquote]

    Die Datentypen sind den Bewertern natürlich bekannt und müssen nicht noch einmal erklärt werden. Wenn Du eigene Implementierungen hast, ist das auch erlaubt (würde ich persönlich aber nur machen, wenn die Standardbibliothek nicht ausreicht), das sollte aber meiner privaten Meinung nach aber kurz erwähnt werden. Wenn dann noch besondere Eigenschaften der Implementierung für die Aufgabe wichtig sind, dann sollte es natürlich passend dokumentiert werden.
    • 7 Beiträge
    4. April 2016 18:09:51 CEST
    Hi ich bins nochmal:
    Für die Einsendung sollen wir ja scheinbar auch Beispielein- und ausgaben in den Ordner packen. Ist das bei der zweiten und dritten Aufgabe so nötig? Es sind ja Beispieleingaben auf der Website.
    Mein Programm zeigt die Ausgabe einfach in einer Anwendung an, davon habe ich auch einige Screenshots in der Dokumentation. Reicht das so für die Ausgabe?
    • 17 Beiträge
    4. April 2016 18:33:37 CEST
    [blockquote]Katrin K. said:
    Hi ich bins nochmal:
    Für die Einsendung sollen wir ja scheinbar auch Beispielein- und ausgaben in den Ordner packen. Ist das bei der zweiten und dritten Aufgabe so nötig? Es sind ja Beispieleingaben auf der Website.
    Mein Programm zeigt die Ausgabe einfach in einer Anwendung an, davon habe ich auch einige Screenshots in der Dokumentation. Reicht das so für die Ausgabe?[/blockquote]
    Das mit den Screenshots müsste in Ordnung sein, hab ich zumindest auch bei Einsendungen zu vorherigen Runden schon gesehen.
    Ich bin mir allerdings nicht sicher, ob die vorgegebenen Beispiele reichen. Auf der Seite bwinf-tipps.de wird empfohlen, zusätzlich noch eigene Beispiele zu erfinden, auch wenn in der Aufgabe schon welche vorgegeben sind. Ich würde dir empfehlen, noch ein paar Beispiele zu erfinden, die Grenzfälle oder besondere Eingaben behandeln. Das ist eigentlich ohnehin sinnvoll, weil man dann besser einschätzen kann, ob das Programm korrekt ist.
    Ich hoffe, das hilft dir weiter.
    • 230 Beiträge
    4. April 2016 19:17:26 CEST
    Von der Seite mit den Materialien für Aufgabe 2:
    [blockquote]
    Der Plan zur Paketverteilung muss in einer Textdatei in folgendem Format gespeichert werden
    [/blockquote]
    und in der Aufgabenstellung für Aufgabe 2 steht:
    [blockquote]
    Gib deinen Plan auch in eine Datei aus, in dem auf der Webseite spezifizierten Format.
    [/blockquote]
    Was das für die Einsendung bedeuten kann, könnt Ihr Euch selber überlegen :)
    Dieser Beitrag wurde am 4. April 2016 19:19:26 CEST von Thomas Leineweber bearbeitet